Class

kamon.trace.Span

Delayed

Related Doc: package Span

Permalink

abstract class Delayed extends Span

A Span representing an operation that will not start processing immediately after the Span is created but rather when the start method is called. Additionally to a regular Span, a Delayed Span will automatically track the wait time metric and add a "span.started" mark on the Span when the Start method is called. The three relevant instants when working with Delayed Spans are:

Created |=====================| <- Wait Time |====================================================| <- Elapsed Time |==============================| <- Processing Time Started Finished

Unless metrics tracking is disabled, a Delayed Span will track the "span.wait-time" metric with the time between creating and starting the Span, and the "span.elapsed-time" tracking the time between creating and finishing the Span. The "span.processing-time" remains the same, tracking the time between starting and finishing the Span.

Linear Supertypes
Span, Operation, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Delayed
  2. Span
  3. Operation
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Delayed()

    Permalink

Abstract Value Members

  1. abstract def doNotTrackDelayedSpanMetrics(): Delayed

    Permalink

    Disables tracking of the span.elapsed-time and span.wait-time metrics for this Span.

  2. abstract def doNotTrackMetrics(): Span

    Permalink

    Disables tracking of metrics for this Span.

    Disables tracking of metrics for this Span.

    Definition Classes
    Span
  3. abstract def fail(errorMessage: String, cause: Throwable): Span

    Permalink

    Marks the operation represented by this Span as failed and adds the provided message as a Span tag using the "error.message" key and optionally adds the "error.stacktrace" Span tag with the stack trace from the provided throwable.

    Marks the operation represented by this Span as failed and adds the provided message as a Span tag using the "error.message" key and optionally adds the "error.stacktrace" Span tag with the stack trace from the provided throwable. See the "kamon.trace.include-error-stacktrace" setting for more information.

    Definition Classes
    Span
  4. abstract def fail(cause: Throwable): Span

    Permalink

    Marks the operation represented by this Span as failed and optionally adds the "error.stacktrace" Span tag with the stack trace from the provided throwable.

    Marks the operation represented by this Span as failed and optionally adds the "error.stacktrace" Span tag with the stack trace from the provided throwable. See the "kamon.trace.include-error-stacktrace" setting for more information.

    Definition Classes
    Span
  5. abstract def fail(errorMessage: String): Span

    Permalink

    Marks the operation represented by this Span as failed and adds the provided message as a Span tag using the "error.message" key.

    Marks the operation represented by this Span as failed and adds the provided message as a Span tag using the "error.message" key.

    Definition Classes
    Span
  6. abstract def finish(at: Instant): Unit

    Permalink

    Finishes this Span using the provided finish instant.

    Finishes this Span using the provided finish instant. Even though it is possible to call any of the methods that modify/write information on the Span, once it is finished no further changes are taken into account.

    Definition Classes
    Span
  7. abstract def finish(): Unit

    Permalink

    Finishes this Span.

    Finishes this Span. Even though it is possible to call any of the methods that modify/write information on the Span, once it is finished no further changes are taken into account.

    Definition Classes
    Span
  8. abstract def id: Identifier

    Permalink

    Uniquely identifies this Span within the Trace.

    Uniquely identifies this Span within the Trace.

    Definition Classes
    Span
  9. abstract def isEmpty: Boolean

    Permalink

    Returns true if this Span is a placeholder because no Span information is available.

    Returns true if this Span is a placeholder because no Span information is available.

    Definition Classes
    Span
  10. abstract def isRemote: Boolean

    Permalink

    Returns true if this Span was initially created in another process and then transferred to this process.

    Returns true if this Span was initially created in another process and then transferred to this process.

    Definition Classes
    Span
  11. abstract def kind: Kind

    Permalink

    Returns the kind of operation represented by this Span.

    Returns the kind of operation represented by this Span.

    Definition Classes
    Span
  12. abstract def link(span: Span, kind: Link.Kind): Span

    Permalink

    Creates a link between this Span and the provided one.

    Creates a link between this Span and the provided one.

    Definition Classes
    Span
  13. abstract def mark(key: String, at: Instant): Span

    Permalink

    Adds a new mark with the provided key and instant.

    Adds a new mark with the provided key and instant.

    Definition Classes
    Span
  14. abstract def mark(key: String): Span

    Permalink

    Adds a new mark with the provided key using the current instant from Kamon's clock.

    Adds a new mark with the provided key using the current instant from Kamon's clock.

    Definition Classes
    Span
  15. abstract def name(name: String): Span

    Permalink

    Changes the operation name on this Span.

    Changes the operation name on this Span. Even though it is possible (and sometimes necessary) to change the operation name in a Span, take into account that the operation name might be captured by child Spans when parent operation scoping is enabled and any updates done after the child spans read the operation name will not be reflected on the "parentOperation" tag.

    Definition Classes
    Span
  16. abstract def operationName(): String

    Permalink

    Returns the current operation name for this Span.

    Returns the current operation name for this Span.

    Definition Classes
    SpanOperation
  17. abstract def parentId: Identifier

    Permalink

    Identifier for the parent of this this Span, if any.

    Identifier for the parent of this this Span, if any. If a Span has no parent (e.g. it is the first Span in the trace) then an empty identifier is returned.

    Definition Classes
    Span
  18. abstract def position: Position

    Permalink

    Returns the position of this Span in the trace to which it belongs.

    Returns the position of this Span in the trace to which it belongs.

    Definition Classes
    Span
  19. abstract def start(at: Instant): Delayed

    Permalink

    Signals that the operation represented by this Span started processing at the provided instant.

  20. abstract def start(): Delayed

    Permalink

    Signals that the operation represented by this Span started processing.

  21. abstract def tag(key: String, value: Boolean): Span

    Permalink

    Adds the provided key/value pair to the Span tags.

    Adds the provided key/value pair to the Span tags. If a tag with the provided key was already present then its value will be overwritten.

    Definition Classes
    Span
  22. abstract def tag(key: String, value: Long): Span

    Permalink

    Adds the provided key/value pair to the Span tags.

    Adds the provided key/value pair to the Span tags. If a tag with the provided key was already present then its value will be overwritten.

    Definition Classes
    Span
  23. abstract def tag(key: String, value: String): Span

    Permalink

    Adds the provided key/value pair to the Span tags.

    Adds the provided key/value pair to the Span tags. If a tag with the provided key was already present then its value will be overwritten.

    Definition Classes
    Span
  24. abstract def tagMetric(key: String, value: Boolean): Span

    Permalink

    Adds the provided key/value pair to the Span metric tags.

    Adds the provided key/value pair to the Span metric tags. If a tag with the provided key was already present then its value will be overwritten.

    Definition Classes
    Span
  25. abstract def tagMetric(key: String, value: Long): Span

    Permalink

    Adds the provided key/value pair to the Span metric tags.

    Adds the provided key/value pair to the Span metric tags. If a tag with the provided key was already present then its value will be overwritten.

    Definition Classes
    Span
  26. abstract def tagMetric(key: String, value: String): Span

    Permalink

    Adds the provided key/value pair to the Span metric tags.

    Adds the provided key/value pair to the Span metric tags. If a tag with the provided key was already present then its value will be overwritten.

    Definition Classes
    Span
  27. abstract def takeSamplingDecision(): Span

    Permalink

    Makes the Span decide for a Sample or DoNotSample decision for the Trace it belongs to, in case the current that the current Sampling Decision is Unknown.

    Makes the Span decide for a Sample or DoNotSample decision for the Trace it belongs to, in case the current that the current Sampling Decision is Unknown. If the Sampling Decision is already taken, calling this method will have no effect on the Span.

    Definition Classes
    Span
  28. abstract def trace: Trace

    Permalink

    Trace to which this Span belongs.

    Trace to which this Span belongs.

    Definition Classes
    Span
  29. abstract def trackDelayedSpanMetrics(): Delayed

    Permalink

    Enables tracking of the span.elapsed-time and span.wait-time metrics for this Span.

    Enables tracking of the span.elapsed-time and span.wait-time metrics for this Span. Note that these metrics will not be recorded if metrics tracking has been disabled on the Span.

  30. abstract def trackMetrics(): Span

    Permalink

    Enables tracking of metrics for this Span.

    Enables tracking of metrics for this Span. For a plain Span, this means that the span.processing-time metric will be tracked and for a Delayed Span, the span.elapsed-time and span.wait-time metrics will be tracked as well.

    Definition Classes
    Span

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

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

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Span

Inherited from Operation

Inherited from AnyRef

Inherited from Any

Ungrouped