Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Span

An interface that represents a span. A span represents a single operation within a trace. Examples of span might include remote procedure calls or a in-process function calls to sub-components. A Trace has a single, top-level "root" Span that in turn may have zero or more child Spans, which in turn may have children.

Hierarchy

  • Span

Implemented by

Index

Methods

addEvent

context

end

  • Marks the end of Span execution.

    Call to End of a Span MUST not have any effects on child spans. Those may still be running and can be ended later.

    Do not return this. The Span generally should not be used after it is ended so chaining is not desired in this context.

    Parameters

    Returns void

isRecording

  • isRecording(): boolean
  • Returns the flag whether this span will be recorded.

    Returns boolean

    true if this Span is active and recording information like events with the AddEvent operation and attributes using setAttributes.

setAttribute

  • setAttribute(key: string, value: unknown): this
  • Sets an attribute to the span.

    Parameters

    • key: string

      the key for this attribute.

    • value: unknown

      the value for this attribute.

    Returns this

setAttributes

setStatus

  • setStatus(status: Status): this

updateName

  • updateName(name: string): this
  • Updates the Span name.

    Parameters

    • name: string

      the Span name.

    Returns this