Skip to main content

Properties (17)

Property Type Default Required Description
addEvent⚓︎ ( name: string, attributesOrStartTime?: Attributes | TimeInput, startTime?: TimeInput ) => this x x
context⚓︎ Context x x x
enabled⚓︎ boolean x

If false, this is a placeholder object, and all its methods are no-ops, with the possible exception of getPropagationInfo() and injectPropagationInfo()

endTime⚓︎ Date x x x
getPropagationInfo⚓︎ () => PropagationInfo | null x

Gets the propagation info for the current span (see https://www.w3.org/TR/trace-context/#tracestate-field)

id⚓︎ string x x x
injectPropagationInfo⚓︎ (carrier: PropagationInfoCarrier & object) => void x

Sets a hidden property in the object that can be used to restore propagation information after serialization and deserialization (see withSpan 'propagationInfo' argument and Traces.extractPropagationInfo() method).

isRecording⚓︎ Span["isRecording"] x x
level⚓︎ keyof typeof SpanVerbosity x x
recordException⚓︎ Span["recordException"] x x
source⚓︎ string x x
span⚓︎ Span x x x
spanContext⚓︎ Span["spanContext"] | (() => undefined) x x
startTime⚓︎ Date x x x
status⚓︎ SpanStatus x x x
traceId⚓︎ string x x x
updateName⚓︎ (name: string) => this x x

3 Methods

addData()⚓︎

(level: SpanVerbosity | keyof typeof SpanVerbosity, data: object | (() => object)) => void

Parameters (2)

Name Type Required Description
level⚓︎ SpanVerbosity | keyof typeof SpanVerbosity x
data⚓︎ object | (() => object) x

end()⚓︎

() => void

Ends the current span. Same as endSpan().

endSpan()⚓︎

(endTime?: Date, allowDoubleEnd?: boolean) => Promise<void>

Parameters (2)

Name Type Required Description
endTime⚓︎ Date x x
allowDoubleEnd⚓︎ boolean x x