com.twitter.zipkin.gen

Class BinaryAnnotation

java.lang.Object

com.twitter.zipkin.gen.BinaryAnnotation

All Implemented Interfaces:

Serializable

public class BinaryAnnotation
extends Object
implements Serializable

Binary annotations are tags applied to a Span to give it context. For example, a binary annotation of "http.url" could be the path to a resource in a RPC call. Binary annotations of type STRING are always queryable, though more a historical implementation detail than a structural concern. Binary annotations can repeat, and vary on the host. Similar to Annotation, the host indicates who logged the event. This allows you to tell the difference between the client and server side of the same key. For example, the key "http.url" might be different on the client and server side due to rewriting, like "/api/v1/myresource" vs "/myresource. Via the host field, you can see the different points of view, which often help in debugging.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
Endpoint	host The host that recorded tag, which allows you to differentiate between multiple tags with the same key.
String	key
AnnotationType	type
byte[]	value

Method Summary

Modifier and Type	Method and Description
static BinaryAnnotation	address(String key, Endpoint endpoint) Special-cased form supporting Constants.CLIENT_ADDR and Constants.SERVER_ADDR.
static BinaryAnnotation	create(String key, byte[] value, AnnotationType type, Endpoint endpoint)
static BinaryAnnotation	create(String key, String value, Endpoint endpoint) String values are the only queryable type of binary annotation.
boolean	equals(Object o)
String	getKey()
byte[]	getValue()
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

key

public final String key

value

public final byte[] value

type

public final AnnotationType type

See Also:

AnnotationType

host

public final Endpoint host

The host that recorded tag, which allows you to differentiate between multiple tags with the same key. There are two exceptions to this. When the key is CLIENT_ADDR or SERVER_ADDR, host indicates the source or destination of an RPC. This exception allows zipkin to display network context of uninstrumented services, or clients such as web browsers.

Method Detail

address

public static BinaryAnnotation address(String key,
                                       Endpoint endpoint)

Special-cased form supporting Constants.CLIENT_ADDR and Constants.SERVER_ADDR.

Parameters:

key - Constants.CLIENT_ADDR or Constants.SERVER_ADDR

endpoint - associated endpoint.

create

public static BinaryAnnotation create(String key,
                                      String value,
                                      @Nullable
                                      Endpoint endpoint)

String values are the only queryable type of binary annotation.

create

public static BinaryAnnotation create(String key,
                                      byte[] value,
                                      AnnotationType type,
                                      @Nullable
                                      Endpoint endpoint)

getKey

public String getKey()

getValue

public byte[] getValue()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object