com.github.levkhomich.akka.tracing

TracingExtensionImpl

class TracingExtensionImpl extends Extension

Akka extension providing tracing functionality.

Linear Supertypes
Extension, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. TracingExtensionImpl
  2. Extension
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new TracingExtensionImpl(system: ActorSystem)

    system

    parent actor system

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def createChild(ts: BaseTracingSupport, parent: BaseTracingSupport): Option[SpanMetadata]

    Creates parent-child relationship between specified messages.

    Creates parent-child relationship between specified messages. Child message is sampled only if parent message was already sampled.

    ts

    child message

    parent

    parent message

    returns

    Some(metadata) if child span was sampled or None otherwise

  9. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  11. def exportMetadata(ts: BaseTracingSupport): Option[SpanMetadata]

    Exports tracing metadata related to specified message.

    Exports tracing metadata related to specified message.

    ts

    traced message

    returns

    Some(metadata) if span was found None if it was not sampled or was already flushed

  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def flush(ts: BaseTracingSupport): Unit

    Flushes all tracing data related to request.

    Flushes all tracing data related to request.

    ts

    traced message

  14. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  15. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  16. def importMetadata(ts: BaseTracingSupport, extMetadata: SpanMetadata, service: String): Unit

    Imports metadata to the system, allowing to continue tracing.

    Imports metadata to the system, allowing to continue tracing. This call ignores sampling policy.

    ts

    child message

    extMetadata

    metadata to be imported

    service

    service name

  17. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  21. def record(ts: BaseTracingSupport, annotation: TracingAnnotation): Unit

    Attaches annotation to message's span.

    Attaches annotation to message's span.

    ts

    traced message

    annotation

    recorded annotation

  22. def record(ts: BaseTracingSupport, e: Throwable): Unit

    Attaches stack trace annotation to message's span.

    Attaches stack trace annotation to message's span.

    ts

    traced message

    e

    exception to be added

  23. def record(ts: BaseTracingSupport, text: String): Unit

    Attaches text annotation to message's span.

    Attaches text annotation to message's span.

    ts

    traced message

    text

    annotation text

  24. def recordKeyValue(ts: BaseTracingSupport, key: String, value: ByteBuffer): Unit

    Attaches key-value annotation to message's span.

    Attaches key-value annotation to message's span.

    ts

    traced message

    key

    key

    value

    value

  25. def recordKeyValue(ts: BaseTracingSupport, key: String, value: Array[Byte]): Unit

    Attaches key-value annotation to message's span.

    Attaches key-value annotation to message's span.

    ts

    traced message

    key

    key

    value

    value

  26. def recordKeyValue(ts: BaseTracingSupport, key: String, value: Short): Unit

    Attaches key-value annotation to message's span.

    Attaches key-value annotation to message's span.

    ts

    traced message

    key

    key

    value

    value

  27. def recordKeyValue(ts: BaseTracingSupport, key: String, value: Double): Unit

    Attaches key-value annotation to message's span.

    Attaches key-value annotation to message's span.

    ts

    traced message

    key

    key

    value

    value

  28. def recordKeyValue(ts: BaseTracingSupport, key: String, value: Boolean): Unit

    Attaches key-value annotation to message's span.

    Attaches key-value annotation to message's span.

    ts

    traced message

    key

    key

    value

    value

  29. def recordKeyValue(ts: BaseTracingSupport, key: String, value: Long): Unit

    Attaches key-value annotation to message's span.

    Attaches key-value annotation to message's span.

    ts

    traced message

    key

    key

    value

    value

  30. def recordKeyValue(ts: BaseTracingSupport, key: String, value: Int): Unit

    Attaches key-value annotation to message's span.

    Attaches key-value annotation to message's span.

    ts

    traced message

    key

    key

    value

    value

  31. def recordKeyValue(ts: BaseTracingSupport, key: String, value: String): Unit

    Attaches key-value annotation to message's span.

    Attaches key-value annotation to message's span.

    ts

    traced message

    key

    key

    value

    value

  32. def sample(ts: BaseTracingSupport, service: String, force: Boolean = false): Option[SpanMetadata]

    Applies sampling to specified message on server side.

    Applies sampling to specified message on server side. If message was sampled, starts a trace and adds ServerReceived annotation.

    Sampling rate is defined by akka.tracing.sample-rate setting.

    ts

    traced message

    service

    service name

    force

    true if request should be traced ignoring akka.tracing.sample-rate setting

    returns

    Some(metadata) if span was created or None otherwise

  33. def sampleClient(ts: BaseTracingSupport, service: String, force: Boolean = false): Option[SpanMetadata]

    Applies sampling to specified message on client side.

    Applies sampling to specified message on client side. If message was sampled, starts a trace and adds ClientSend annotation.

    Sampling rate is defined by akka.tracing.sample-rate setting.

    ts

    traced message

    service

    service name

    force

    true if request should be traced ignoring akka.tracing.sample-rate setting

    returns

    Some(metadata) if span was sampled or None otherwise

  34. def start(ts: BaseTracingSupport, service: String): Unit

    Marks request processing start.

    Marks request processing start. Sampling must be performed before this call.

    ts

    traced message

    service

    service name

  35. def submitSpans(spans: TraversableOnce[Span]): Unit

    Submits specified spans skipping any content checks.

    Submits specified spans skipping any content checks.

    spans

    spans to be sent

  36. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  37. def toString(): String

    Definition Classes
    AnyRef → Any
  38. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finish(ts: BaseTracingSupport): Unit

    Marks request processing finish by adding ServerSend annotation, flushes associated trace.

    Marks request processing finish by adding ServerSend annotation, flushes associated trace.

    ts

    traced message

    Annotations
    @deprecated
    Deprecated

    (Since version 0.5) Use record(ts, TracingAnnotations.ServerSend) instead

  2. def forcedSample(ts: BaseTracingSupport, service: String): Option[SpanMetadata]

    Starts a trace and adds ClientSend annotation to it.

    Starts a trace and adds ClientSend annotation to it.

    This call ignores akka.tracing.sample-rate setting.

    ts

    traced message

    service

    service name

    returns

    Some(metadata) if span was sampled or None otherwise

    Annotations
    @deprecated
    Deprecated

    (Since version 0.5) Use sample(ts, service, force = true)

Inherited from Extension

Inherited from AnyRef

Inherited from Any

Ungrouped