dd-trace
    Preparing search index...

    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: string,
            attributesOrStartTime?: TimeInput | Attributes,
            startTime?: TimeInput,
        ): this;
        addLink(context: SpanContext, attributes?: Attributes): void;
        addLink(link: Link): this;
        addLinks(links: Link[]): this;
        end(endTime?: TimeInput): void;
        isRecording(): boolean;
        recordException(exception: Exception, time?: TimeInput): void;
        setAttribute(key: string, value: AttributeValue): this;
        setAttributes(attributes: Attributes): this;
        setStatus(status: SpanStatus): this;
        spanContext(): opentelemetry.SpanContext;
        updateName(name: string): this;
    }

    Hierarchy

    • Span
      • Span
    Index

    Methods

    addEvent addLink addLinks end isRecording recordException setAttribute setAttributes setStatus spanContext updateName

    Methods

    • Adds an event to the Span.

      Parameters

      • name: string

        the name of the event.

      • OptionalattributesOrStartTime: 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

      • OptionalstartTime: TimeInput

        start time of the event.

      Returns this

    • Causally links another span to the current span

      Parameters

      • context: SpanContext

        The context of the span to link to.

      • Optionalattributes: Attributes

        An optional key value pair of arbitrary values.

      Returns void

      In favor of addLink(link: otel.Link). This will be removed in the next major version.

    • Adds a single link to the span.

      Links added after the creation will not affect the sampling decision. It is preferred span links be added at span creation.

      Parameters

      • link: Link

        the link to add.

      Returns this

    • Adds multiple links to the span.

      Links added after the creation will not affect the sampling decision. It is preferred span links be added at span creation.

      Parameters

      • links: Link[]

        the links to add.

      Returns this

    • 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

      • OptionalendTime: 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

    • 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.

    • Sets exception as a span event

      Parameters

      • exception: Exception

        the exception the only accepted values are string or Error

      • Optionaltime: TimeInput

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

      Returns void

    • 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

    • 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

    • 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

    • Returns the SpanContext object associated with this Span.

      Get an immutable, serializable identifier for this span that can be used to create new child spans. Returned SpanContext is usable even after the span ends.

      Returns opentelemetry.SpanContext

      the SpanContext object associated with this Span.

    • 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

    On This Page

    Methods