Interface Span

Span holding trace_id, span_id

interface Span {
    attributes: SpanAttributes;
    data: { [key: string]: any };
    description?: string;
    endTimestamp?: number;
    exclusiveTime?: number;
    instrumenter: Instrumenter;
    measurements?: Measurements;
    name: string;
    op?: string;
    origin?: SpanOrigin;
    parentSpanId?: string;
    sampled?: boolean;
    spanId: string;
    startTimestamp: number;
    status?: string;
    tags: { [key: string]: Primitive };
    traceId: string;
    transaction?: Transaction;
    end(endTimestamp?: SpanTimeInput): void;
    finish(endTimestamp?: number): void;
    getTraceContext(): TraceContext;
    isRecording(): boolean;
    isSuccess(): boolean;
    setAttribute(key: string, value: undefined | SpanAttributeValue): void;
    setAttributes(attributes: SpanAttributes): void;
    setData(key: string, value: any): this;
    setHttpStatus(httpStatus: number): this;
    setName(name: string): void;
    setStatus(status: string): this;
    setTag(key: string, value: Primitive): this;
    spanContext(): SpanContextData;
    startChild(
        spanContext?: Pick<
            SpanContext,
            | "instrumenter"
            | "name"
            | "status"
            | "op"
            | "origin"
            | "description"
            | "spanId"
            | "tags"
            | "data"
            | "attributes"
            | "startTimestamp"
            | "endTimestamp"
            | "exclusiveTime"
            | "measurements",
        >,
    ): Span;
    toContext(): SpanContext;
    toJSON(): SpanJSON;
    toTraceparent(): string;
    updateName(name: string): this;
    updateWithContext(spanContext: SpanContext): this;
}

Hierarchy

  • Omit<SpanContext, "op" | "status" | "origin">
    • Span

Properties

attributes data description? endTimestamp? exclusiveTime? instrumenter measurements? name op? origin? parentSpanId? sampled? spanId startTimestamp status? tags traceId transaction?

Methods

end finish getTraceContext isRecording isSuccess setAttribute setAttributes setData setHttpStatus setName setStatus setTag spanContext startChild toContext toJSON toTraceparent updateName updateWithContext

Properties

attributes

attributes: SpanAttributes

Attributes for the span.

Deprecated

Use spanToJSON(span).atttributes instead.

data

data: { [key: string]: any }

Data for the span.

Deprecated

Use spanToJSON(span).atttributes instead.

Optionaldescription

description?: string

Description of the Span.

Deprecated

Use name instead.

OptionalendTimestamp

endTimestamp?: number

Timestamp in seconds (epoch time) indicating when the span ended.

Deprecated

Use spanToJSON() instead.

OptionalexclusiveTime

exclusiveTime?: number

Exclusive time in milliseconds.

instrumenter

instrumenter: Instrumenter

The instrumenter that created this span.

Deprecated

this field will be removed.

Optionalmeasurements

measurements?: Measurements

Measurements of the Span.

name

name: string

Human-readable identifier for the span. Identical to span.description.

Deprecated

Use spanToJSON(span).description instead.

Optionalop

op?: string

Operation of the Span.

Deprecated

Use startSpan() functions to set, span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'op') to update and spanToJSON().op` to read the op instead

Optionalorigin

origin?: SpanOrigin

The origin of the span, giving context about what created the span.

Deprecated

Use startSpan function to set and spanToJSON(span).origin to read the origin instead.

OptionalparentSpanId

parentSpanId?: string

Parent Span ID

Deprecated

Use spanToJSON(span).parent_span_id instead.

Optionalsampled

sampled?: boolean

Was this span chosen to be sent as part of the sample?

Deprecated

Use isRecording() instead.

spanId

spanId: string

The ID of the span.

Deprecated

Use spanContext().spanId instead.

startTimestamp

startTimestamp: number

Timestamp in seconds (epoch time) indicating when the span started.

Deprecated

Use spanToJSON() instead.

Optionalstatus

status?: string

Completion status of the Span.

See: {@sentry/tracing SpanStatus} for possible values

Deprecated

Use .setStatus to set or update and spanToJSON() to read the status.

tags

tags: { [key: string]: Primitive }

Tags for the span.

Deprecated

Use spanToJSON(span).atttributes instead.

traceId

traceId: string

The ID of the trace.

Deprecated

Use spanContext().traceId instead.

Optionaltransaction

transaction?: Transaction

The transaction containing this span

Deprecated

Use top level Sentry.getRootSpan() instead

Methods

end

  • end(endTimestamp?: SpanTimeInput): void

  • End the current span.

    Parameters

    • OptionalendTimestamp: SpanTimeInput

    Returns void

finish

  • finish(endTimestamp?: number): void

  • Sets the finish timestamp on the current span.

    Parameters

    • OptionalendTimestamp: number

      Takes an endTimestamp if the end should not be the time when you call this function.

    Returns void

    Deprecated

    Use .end() instead.

getTraceContext

  • getTraceContext(): TraceContext

  • Convert the object to JSON for w. spans array info only.

    Returns TraceContext

    Deprecated

    Use spanToTraceContext() util function instead.

isRecording

  • isRecording(): boolean

  • If this is span is actually recording data. This will return false if tracing is disabled, this span was not sampled or if the span is already finished.

    Returns boolean

isSuccess

  • isSuccess(): boolean

  • Determines whether span was successful (HTTP200)

    Returns boolean

    Deprecated

    Use spanToJSON(span).status === 'ok' instead.

setAttribute

  • setAttribute(key: string, value: undefined | SpanAttributeValue): void

  • Set a single attribute on the span. Set it to undefined to remove the attribute.

    Parameters

    • key: string
    • value: undefined | SpanAttributeValue

    Returns void

setAttributes

  • setAttributes(attributes: SpanAttributes): void

  • Set multiple attributes on the span. Any attribute set to undefined will be removed.

    Parameters

    • attributes: SpanAttributes

    Returns void

setData

  • setData(key: string, value: any): this

  • Sets the data attribute on the current span

    Parameters

    • key: string

      Data key

    • value: any

      Data value

    Returns this

    Deprecated

    Use setAttribute() instead.

setHttpStatus

  • setHttpStatus(httpStatus: number): this

  • Sets the status attribute on the current span based on the http code

    Parameters

    • httpStatus: number

      http code used to set the status

    Returns this

    Deprecated

    Use top-level setHttpStatus() instead.

setName

  • setName(name: string): void

  • Set the name of the span.

    Parameters

    • name: string

    Returns void

    Deprecated

    Use updateName() instead.

setStatus

  • setStatus(status: string): this

  • Sets the status attribute on the current span See: {@sentry/tracing SpanStatus} for possible values

    Parameters

    • status: string

      http code used to set the status

    Returns this

setTag

  • setTag(key: string, value: Primitive): this

  • Sets the tag attribute on the current span.

    Can also be used to unset a tag, by passing undefined.

    Parameters

    • key: string

      Tag key

    • value: Primitive

      Tag value

    Returns this

    Deprecated

    Use setAttribute() instead.

spanContext

  • spanContext(): SpanContextData

  • Get context data for this span. This includes the spanId & the traceId.

    Returns SpanContextData

startChild

  • startChild(
        spanContext?: Pick<
            SpanContext,
            | "instrumenter"
            | "name"
            | "status"
            | "op"
            | "origin"
            | "description"
            | "spanId"
            | "tags"
            | "data"
            | "attributes"
            | "startTimestamp"
            | "endTimestamp"
            | "exclusiveTime"
            | "measurements",
        >,
    ): Span

  • Creates a new Span while setting the current Span.id as parentSpanId. Also the sampled decision will be inherited.

    Parameters

    • OptionalspanContext: Pick<
          SpanContext,
          | "instrumenter"
          | "name"
          | "status"
          | "op"
          | "origin"
          | "description"
          | "spanId"
          | "tags"
          | "data"
          | "attributes"
          | "startTimestamp"
          | "endTimestamp"
          | "exclusiveTime"
          | "measurements",
      >

    Returns Span

    Deprecated

    Use startSpan(), startSpanManual() or startInactiveSpan() instead.

toContext

  • toContext(): SpanContext

  • Returns the current span properties as a SpanContext.

    Returns SpanContext

    Deprecated

    Use toJSON() or access the fields directly instead.

toJSON

  • toJSON(): SpanJSON

  • Convert the object to JSON.

    Returns SpanJSON

    Deprecated

    Use spanToJSON(span) instead.

toTraceparent

  • toTraceparent(): string

  • Return a traceparent compatible header string.

    Returns string

    Deprecated

    Use spanToTraceHeader() instead.

updateName

  • updateName(name: string): this

  • Update the name of the span.

    Parameters

    • name: string

    Returns this

updateWithContext

  • updateWithContext(spanContext: SpanContext): this

  • Updates the current span with a new SpanContext.

    Parameters

    • spanContext: SpanContext

    Returns this

    Deprecated

    Update the fields directly instead.

Settings

Member Visibility

On This Page

Properties
Methods