class BinaryAnnotation extends TBase[BinaryAnnotation, _Fields] with Serializable with Cloneable with Comparable[BinaryAnnotation]
Binary annotations are tags applied to a Span to give it context. For example, a binary annotation of "http.uri" could 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.uri" 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.
- Annotations
- @SuppressWarnings() @Generated()
- Alphabetic
- By Inheritance
- BinaryAnnotation
- Cloneable
- TBase
- Serializable
- TSerializable
- Comparable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new BinaryAnnotation(other: BinaryAnnotation)
Performs a deep copy on other.
- new BinaryAnnotation(key: String, value: ByteBuffer, annotation_type: AnnotationType)
- new BinaryAnnotation()
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def bufferForValue(): ByteBuffer
- def clear(): Unit
- Definition Classes
- BinaryAnnotation → TBase
- Annotations
- @Override()
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def compareTo(other: BinaryAnnotation): Int
- Definition Classes
- BinaryAnnotation → Comparable
- Annotations
- @Override()
- def deepCopy(): BinaryAnnotation
- Definition Classes
- BinaryAnnotation → TBase
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(that: BinaryAnnotation): Boolean
- def equals(that: AnyRef): Boolean
- Definition Classes
- BinaryAnnotation → AnyRef → Any
- Annotations
- @Override()
- def fieldForId(fieldId: Int): _Fields
- Definition Classes
- BinaryAnnotation → TBase
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def getAnnotation_type(): AnnotationType
- See also
AnnotationType
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getFieldValue(field: _Fields): AnyRef
- Definition Classes
- BinaryAnnotation → TBase
- def getHost(): Endpoint
The host that recorded tag, which allows you to differentiate between multiple tags with the same key.
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.
- def getKey(): String
- def getValue(): Array[Byte]
- def hashCode(): Int
- Definition Classes
- BinaryAnnotation → AnyRef → Any
- Annotations
- @Override()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isSet(field: _Fields): Boolean
Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
Returns true if field corresponding to fieldID is set (has been assigned a value) and false otherwise
- Definition Classes
- BinaryAnnotation → TBase
- def isSetAnnotation_type(): Boolean
Returns true if field annotation_type is set (has been assigned a value) and false otherwise
- def isSetHost(): Boolean
Returns true if field host is set (has been assigned a value) and false otherwise
- def isSetKey(): Boolean
Returns true if field key is set (has been assigned a value) and false otherwise
- def isSetValue(): Boolean
Returns true if field value is set (has been assigned a value) and false otherwise
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def read(iprot: TProtocol): Unit
- Definition Classes
- BinaryAnnotation → TSerializable
- def setAnnotation_type(annotation_type: AnnotationType): BinaryAnnotation
- See also
AnnotationType
- def setAnnotation_typeIsSet(value: Boolean): Unit
- def setFieldValue(field: _Fields, value: AnyRef): Unit
- Definition Classes
- BinaryAnnotation → TBase
- def setHost(host: Endpoint): BinaryAnnotation
The host that recorded tag, which allows you to differentiate between multiple tags with the same key.
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.
- def setHostIsSet(value: Boolean): Unit
- def setKey(key: String): BinaryAnnotation
- def setKeyIsSet(value: Boolean): Unit
- def setValue(value: ByteBuffer): BinaryAnnotation
- def setValue(value: Array[Byte]): BinaryAnnotation
- def setValueIsSet(value: Boolean): Unit
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- BinaryAnnotation → AnyRef → Any
- Annotations
- @Override()
- def unsetAnnotation_type(): Unit
- def unsetHost(): Unit
- def unsetKey(): Unit
- def unsetValue(): Unit
- def validate(): Unit
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def write(oprot: TProtocol): Unit
- Definition Classes
- BinaryAnnotation → TSerializable