TracingExtensionImpl

Instance Constructors

new TracingExtensionImpl(system: ActorSystem)

system
parent actor system

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 clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
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
def finalize(): Unit

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

Flushes all tracing data related to request.
Flushes all tracing data related to request.
ts
traced message
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
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
final def isInstanceOf[T0]: Boolean

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

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
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)

Related Doc: package tracing

class TracingExtensionImpl extends Extension

Instance Constructors

new TracingExtensionImpl(system: ActorSystem)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def createChild(ts: BaseTracingSupport, parent: BaseTracingSupport): Option[SpanMetadata]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def exportMetadata(ts: BaseTracingSupport): Option[SpanMetadata]

def finalize(): Unit

def flush(ts: BaseTracingSupport): Unit

final def getClass(): Class[_]

def hashCode(): Int

def importMetadata(ts: BaseTracingSupport, extMetadata: SpanMetadata, service: String): Unit

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def record(ts: BaseTracingSupport, annotation: TracingAnnotation): Unit

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Deprecated Value Members

def finish(ts: BaseTracingSupport): Unit

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

Inherited from Extension

Inherited from AnyRef

Inherited from Any

Ungrouped