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.
- Alphabetic
- By Inheritance
- Delayed
- Span
- Operation
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Delayed()
Abstract Value Members
-
abstract
def
doNotTrackDelayedSpanMetrics(): Delayed
Disables tracking of the span.elapsed-time and span.wait-time metrics for this Span.
-
abstract
def
doNotTrackMetrics(): Span
Disables tracking of metrics for this Span.
Disables tracking of metrics for this Span.
- Definition Classes
- Span
-
abstract
def
fail(errorMessage: String, cause: Throwable): Span
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
-
abstract
def
fail(cause: Throwable): Span
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
-
abstract
def
fail(errorMessage: String): Span
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
-
abstract
def
finish(at: Instant): Unit
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
-
abstract
def
finish(): Unit
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
-
abstract
def
finishAfter(duration: Duration): Unit
Finishes this Span using the provided duration.
Finishes this Span using the provided duration. 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
-
abstract
def
id: Identifier
Uniquely identifies this Span within the Trace.
Uniquely identifies this Span within the Trace.
- Definition Classes
- Span
-
abstract
def
isEmpty: Boolean
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
-
abstract
def
isRemote: Boolean
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
-
abstract
def
kind: Kind
Returns the kind of operation represented by this Span.
Returns the kind of operation represented by this Span.
- Definition Classes
- Span
-
abstract
def
link(span: Span, kind: Link.Kind): Span
Creates a link between this Span and the provided one.
Creates a link between this Span and the provided one.
- Definition Classes
- Span
-
abstract
def
mark(key: String, at: Instant): Span
Adds a new mark with the provided key and instant.
Adds a new mark with the provided key and instant.
- Definition Classes
- Span
-
abstract
def
mark(key: String): Span
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
-
abstract
def
name(name: String): Span
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
-
abstract
def
operationName(): String
Returns the current operation name for this Span.
-
abstract
def
parentId: Identifier
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
-
abstract
def
position: Position
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
-
abstract
def
start(at: Instant): Delayed
Signals that the operation represented by this Span started processing at the provided instant.
-
abstract
def
start(): Delayed
Signals that the operation represented by this Span started processing.
-
abstract
def
tag(tags: TagSet): Span
Adds all key/value pairs in the provided tags to the Span tags.
Adds all key/value pairs in the provided tags to the Span tags. If a tag with the provided key was already present then its value will be overwritten.
- Definition Classes
- Span
-
abstract
def
tag(key: String, value: Boolean): Span
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
-
abstract
def
tag(key: String, value: Long): Span
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
-
abstract
def
tag(key: String, value: String): Span
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
-
abstract
def
tagMetrics(tags: TagSet): Span
Adds all key/value pairs in the provided tags to the Span metric tags.
Adds all key/value pairs in the provided tags to the Span metric tags. If a tag with the provided key was already present then its value will be overwritten.
- Definition Classes
- Span
-
abstract
def
tagMetrics(key: String, value: Boolean): Span
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
-
abstract
def
tagMetrics(key: String, value: Long): Span
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
-
abstract
def
tagMetrics(key: String, value: String): Span
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
-
abstract
def
takeSamplingDecision(): Span
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
-
abstract
def
trace: Trace
Trace to which this Span belongs.
Trace to which this Span belongs.
- Definition Classes
- Span
-
abstract
def
trackDelayedSpanMetrics(): Delayed
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.
-
abstract
def
trackMetrics(): Span
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
-
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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
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()
-
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( ... ) @native()