Interface Span

Span holding trace_id, span_id

Hierarchy

SpanContext
- Span
  - Transaction
  - Transaction

Properties

data

data: {
[key: string]: any;
}

Data of the Span.

Type declaration

[key: string]: any

`Optional` description

description?: string

Description of the Span.

`Optional` endTimestamp

endTimestamp?: number

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

instrumenter

instrumenter: Instrumenter

The instrumenter that created this span.

`Optional` op

op?: string

Operation of the Span.

`Optional` parentSpanId

parentSpanId?: string

Parent Span ID

`Optional` sampled

sampled?: boolean

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

spanId

spanId: string

Span ID

startTimestamp

startTimestamp: number

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

`Optional` status

status?: string

Completion status of the Span. See: {@sentry/tracing SpanStatus} for possible values

traceId

traceId: string

Trace ID

`Optional` transaction

transaction?: Transaction

The transaction containing this span

Methods

finish

finish(endTimestamp?): void
Sets the finish timestamp on the current span.
Parameters
- Optional endTimestamp: number
  
  Takes an endTimestamp if the end should not be the time when you call this function.
Returns void
- Defined in packages/types/build/types/span.d.ts:98

getTraceContext

getTraceContext(): {
    data?: {
        [key: string]: any;
    };
    description?: string;
    op?: string;
    parent_span_id?: string;
    span_id: string;
    status?: string;
    tags?: {
        [key: string]: Primitive;
    };
    trace_id: string;
}
Convert the object to JSON for w. spans array info only

Returns {
    data?: {
        [key: string]: any;
    };
    description?: string;
    op?: string;
    parent_span_id?: string;
    span_id: string;
    status?: string;
    tags?: {
        [key: string]: Primitive;
    };
    trace_id: string;
}
- Optional data?: {
  [key: string]: any;
  }
  - [key: string]: any
- Optional description?: string
- Optional op?: string
- Optional parent_span_id?: string
- span_id: string
- Optional status?: string
- Optional tags?: {
  [key: string]: Primitive;
  }
  - [key: string]: Primitive
- trace_id: string
- Defined in packages/types/build/types/span.d.ts:141

isSuccess

isSuccess(): boolean
Determines whether span was successful (HTTP200)

Returns boolean
- Defined in packages/types/build/types/span.d.ts:133

setData

setData(key, value): Span
Sets the data attribute on the current span
Parameters
- key: string
  
  Data key
- value: any
  
  Data value
Returns Span
- Defined in packages/types/build/types/span.d.ts:113

setHttpStatus

setHttpStatus(httpStatus): Span
Sets the status attribute on the current span based on the http code
Parameters
- httpStatus: number
  
  http code used to set the status
Returns Span
- Defined in packages/types/build/types/span.d.ts:124

setStatus

setStatus(status): Span
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 Span
- Defined in packages/types/build/types/span.d.ts:119

setTag

setTag(key, value): Span
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 Span
- Defined in packages/types/build/types/span.d.ts:107

startChild

startChild(spanContext?): Span
Creates a new Span while setting the current Span.id as parentSpanId. Also the sampled decision will be inherited.
Parameters
- Optional spanContext: Pick<SpanContext, "data" | "tags" | "instrumenter" | "description" | "op" | "status" | "spanId" | "startTimestamp" | "endTimestamp">
Returns Span
- Defined in packages/types/build/types/span.d.ts:129

toContext

toContext(): SpanContext
Returns the current span properties as a SpanContext

Returns SpanContext
- Defined in packages/types/build/types/span.d.ts:137

toJSON

toJSON(): {
    data?: {
        [key: string]: any;
    };
    description?: string;
    op?: string;
    parent_span_id?: string;
    span_id: string;
    start_timestamp: number;
    status?: string;
    tags?: {
        [key: string]: Primitive;
    };
    timestamp?: number;
    trace_id: string;
}
Convert the object to JSON

Returns {
    data?: {
        [key: string]: any;
    };
    description?: string;
    op?: string;
    parent_span_id?: string;
    span_id: string;
    start_timestamp: number;
    status?: string;
    tags?: {
        [key: string]: Primitive;
    };
    timestamp?: number;
    trace_id: string;
}
- Optional data?: {
  [key: string]: any;
  }
  - [key: string]: any
- Optional description?: string
- Optional op?: string
- Optional parent_span_id?: string
- span_id: string
- start_timestamp: number
- Optional status?: string
- Optional tags?: {
  [key: string]: Primitive;
  }
  - [key: string]: Primitive
- Optional timestamp?: number
- trace_id: string
- Defined in packages/types/build/types/span.d.ts:156

toTraceparent

toTraceparent(): string
Return a traceparent compatible header string

Returns string
- Defined in packages/types/build/types/span.d.ts:135

updateWithContext

updateWithContext(spanContext): Span
Updates the current span with a new SpanContext
Parameters
- spanContext: SpanContext
Returns Span
- Defined in packages/types/build/types/span.d.ts:139

Interface Span

Hierarchy

Index

Properties

Methods

Properties

data

Type declaration

[key: string]: any

Optional description

Optional endTimestamp

instrumenter

Optional op

Optional parentSpanId

Optional sampled

spanId

startTimestamp

Optional status

tags

Type declaration

[key: string]: Primitive

traceId

Optional transaction

Methods

finish

Parameters

Optional endTimestamp: number

Returns void

getTraceContext

Returns { data?: { [key: string]: any; }; description?: string; op?: string; parent_span_id?: string; span_id: string; status?: string; tags?: { [key: string]: Primitive; }; trace_id: string; }

Optional data?: { [key: string]: any; }

[key: string]: any

Optional description?: string

Optional op?: string

Optional parent_span_id?: string

span_id: string

Optional status?: string

Optional tags?: { [key: string]: Primitive; }

[key: string]: Primitive

trace_id: string

isSuccess

Returns boolean

setData

Parameters

key: string

value: any

Returns Span

setHttpStatus

Parameters

httpStatus: number

Returns Span

setStatus

Parameters

status: string

Returns Span

setTag

Parameters

key: string

value: Primitive

Returns Span

startChild

Parameters

Optional spanContext: Pick<SpanContext, "data" | "tags" | "instrumenter" | "description" | "op" | "status" | "spanId" | "startTimestamp" | "endTimestamp">

Returns Span

toContext

Returns SpanContext

toJSON

Returns { data?: { [key: string]: any; }; description?: string; op?: string; parent_span_id?: string; span_id: string; start_timestamp: number; status?: string; tags?: { [key: string]: Primitive; }; timestamp?: number; trace_id: string; }

Optional data?: { [key: string]: any; }

[key: string]: any

Optional description?: string

Optional op?: string

Optional parent_span_id?: string

span_id: string

start_timestamp: number

Optional status?: string

Optional tags?: { [key: string]: Primitive; }

[key: string]: Primitive

Optional timestamp?: number

trace_id: string

`Optional` description

`Optional` endTimestamp

`Optional` op

`Optional` parentSpanId

`Optional` sampled

`Optional` status

`Optional` transaction

`Optional` endTimestamp: number

Returns {
data?: {
[key: string]: any;
};
description?: string;
op?: string;
parent_span_id?: string;
span_id: string;
status?: string;
tags?: {
[key: string]: Primitive;
};
trace_id: string;
}

`Optional` data?: {
[key: string]: any;
}

`Optional` description?: string

`Optional` op?: string

`Optional` parent_span_id?: string

`Optional` status?: string

`Optional` tags?: {
[key: string]: Primitive;
}

`Optional` spanContext: Pick<SpanContext, "data" | "tags" | "instrumenter" | "description" | "op" | "status" | "spanId" | "startTimestamp" | "endTimestamp">

Returns {
data?: {
[key: string]: any;
};
description?: string;
op?: string;
parent_span_id?: string;
span_id: string;
start_timestamp: number;
status?: string;
tags?: {
[key: string]: Primitive;
};
timestamp?: number;
trace_id: string;
}

`Optional` data?: {
[key: string]: any;
}

`Optional` description?: string

`Optional` op?: string

`Optional` parent_span_id?: string

`Optional` status?: string

`Optional` tags?: {
[key: string]: Primitive;
}

`Optional` timestamp?: number