Packages

c

com.twitter.finagle.thrift.thrift

BinaryAnnotation

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()
Linear Supertypes
Cloneable, TBase[BinaryAnnotation, _Fields], Serializable, TSerializable, Comparable[BinaryAnnotation], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BinaryAnnotation
  2. Cloneable
  3. TBase
  4. Serializable
  5. TSerializable
  6. Comparable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new BinaryAnnotation(other: BinaryAnnotation)

    Performs a deep copy on other.

  2. new BinaryAnnotation(key: String, value: ByteBuffer, annotation_type: AnnotationType)
  3. new BinaryAnnotation()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def bufferForValue(): ByteBuffer
  6. def clear(): Unit
    Definition Classes
    BinaryAnnotation → TBase
    Annotations
    @Override()
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  8. def compareTo(other: BinaryAnnotation): Int
    Definition Classes
    BinaryAnnotation → Comparable
    Annotations
    @Override()
  9. def deepCopy(): BinaryAnnotation
    Definition Classes
    BinaryAnnotation → TBase
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(that: BinaryAnnotation): Boolean
  12. def equals(that: Any): Boolean
    Definition Classes
    BinaryAnnotation → AnyRef → Any
    Annotations
    @Override()
  13. def fieldForId(fieldId: Int): _Fields
    Definition Classes
    BinaryAnnotation → TBase
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def getAnnotation_type(): AnnotationType

    See also

    AnnotationType

  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getFieldValue(field: _Fields): AnyRef
    Definition Classes
    BinaryAnnotation → TBase
  18. 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.

  19. def getKey(): String
  20. def getValue(): Array[Byte]
  21. def hashCode(): Int
    Definition Classes
    BinaryAnnotation → AnyRef → Any
    Annotations
    @Override()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. 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
  24. def isSetAnnotation_type(): Boolean

    Returns true if field annotation_type is set (has been assigned a value) and false otherwise

  25. def isSetHost(): Boolean

    Returns true if field host is set (has been assigned a value) and false otherwise

  26. def isSetKey(): Boolean

    Returns true if field key is set (has been assigned a value) and false otherwise

  27. def isSetValue(): Boolean

    Returns true if field value is set (has been assigned a value) and false otherwise

  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  31. def read(iprot: TProtocol): Unit
    Definition Classes
    BinaryAnnotation → TSerializable
  32. def setAnnotation_type(annotation_type: AnnotationType): BinaryAnnotation

    See also

    AnnotationType

  33. def setAnnotation_typeIsSet(value: Boolean): Unit
  34. def setFieldValue(field: _Fields, value: Any): Unit
    Definition Classes
    BinaryAnnotation → TBase
  35. 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.

  36. def setHostIsSet(value: Boolean): Unit
  37. def setKey(key: String): BinaryAnnotation
  38. def setKeyIsSet(value: Boolean): Unit
  39. def setValue(value: ByteBuffer): BinaryAnnotation
  40. def setValue(value: Array[Byte]): BinaryAnnotation
  41. def setValueIsSet(value: Boolean): Unit
  42. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  43. def toString(): String
    Definition Classes
    BinaryAnnotation → AnyRef → Any
    Annotations
    @Override()
  44. def unsetAnnotation_type(): Unit
  45. def unsetHost(): Unit
  46. def unsetKey(): Unit
  47. def unsetValue(): Unit
  48. def validate(): Unit
  49. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  50. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  51. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  52. def write(oprot: TProtocol): Unit
    Definition Classes
    BinaryAnnotation → TSerializable

Inherited from Cloneable

Inherited from TBase[BinaryAnnotation, _Fields]

Inherited from Serializable

Inherited from TSerializable

Inherited from Comparable[BinaryAnnotation]

Inherited from AnyRef

Inherited from Any

Ungrouped