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.

Spans are created by the Tracer.startSpan method.

interface Span {
    addEvent(name, attributesOrStartTime?, startTime?): this;
    addLink(context, attributes?): void;
    end(endTime?): void;
    isRecording(): boolean;
    recordException(exception, time?): void;
    setAttribute(key, value): this;
    setAttributes(attributes): this;
    setStatus(status): this;
    spanContext(): export=.opentelemetry.SpanContext;
    updateName(name): this;
}

Hierarchy

  • Span
    • Span

Methods

addEvent addLink end isRecording recordException setAttribute setAttributes setStatus spanContext updateName

Methods

addEvent

  • addEvent(name, attributesOrStartTime?, startTime?): this

  • Adds an event to the Span.

    Parameters

    • name: string

      the name of the event.

    • Optional attributesOrStartTime: TimeInput | Attributes

      the attributes that will be added; these are associated with this event. Can be also a start time if type is TimeInput and 3rd param is undefined

    • Optional startTime: TimeInput

      start time of the event.

    Returns this

addLink

  • addLink(context, attributes?): void

  • Causally links another span to the current span

    Parameters

    • context: SpanContext

      The context of the span to link to.

    • Optional attributes: Attributes

      An optional key value pair of arbitrary values.

    Returns void

end

  • end(endTime?): void

  • 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

    • Optional endTime: TimeInput

      the time to set as Span's end time. If not provided, use the current time as the span's end time.

    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.

recordException

  • recordException(exception, time?): void

  • Sets exception as a span event

    Parameters

    • exception: Exception

      the exception the only accepted values are string or Error

    • Optional time: TimeInput

      the time to set as Span's event time. If not provided, use the current time.

    Returns void

setAttribute

  • setAttribute(key, value): this

  • Sets an attribute to the span.

    Sets a single Attribute with the key and value passed as arguments.

    Parameters

    • key: string

      the key for this attribute.

    • value: AttributeValue

      the value for this attribute. Setting a value null or undefined is invalid and will result in undefined behavior.

    Returns this

setAttributes

  • setAttributes(attributes): this

  • Sets attributes to the span.

    Parameters

    • attributes: Attributes

      the attributes that will be added. null or undefined attribute values are invalid and will result in undefined behavior.

    Returns this

setStatus

  • setStatus(status): this

  • Sets a status to the span. If used, this will override the default Span status. Default is otel.SpanStatusCode.UNSET. SetStatus overrides the value of previous calls to SetStatus on the Span.

    Parameters

    • status: SpanStatus

      the SpanStatus to set.

    Returns this

spanContext

updateName

  • updateName(name): this

  • Updates the Span name.

    This will override the name provided via Tracer.startSpan.

    Upon this update, any sampling behavior based on Span name will depend on the implementation.

    Parameters

    • name: string

      the Span name.

    Returns this

Settings

Member Visibility

Theme

On This Page

addEventaddLinkendisRecordingrecordExceptionsetAttributesetAttributessetStatusspanContextupdateName