Interface BotSpan

One span, as the core drives it.

interface BotSpan {
    setAttribute(key: string, value: TraceAttributeValue | undefined): this;
    setAttributes(attrs: TraceAttributes): this;
    addEvent(name: string, attrs?: TraceAttributes): this;
    recordException(error: SpanException): this;
    setStatus(status: SpanStatus): this;
    end(endTimeMs?: number): void;
    isRecording(): boolean;
    spanContext(): SpanContextRef | undefined;
}

Index

Methods

setAttribute setAttributes addEvent recordException setStatus end isRecording spanContext

Methods

setAttribute

setAttribute(key: string, value: TraceAttributeValue | undefined): this
Parameters
- key: string
- value: TraceAttributeValue | undefined
Returns this
- Defined in telemetry/types.ts:54

setAttributes

setAttributes(attrs: TraceAttributes): this
Parameters
- attrs: TraceAttributes
Returns this
- Defined in telemetry/types.ts:55

addEvent

addEvent(name: string, attrs?: TraceAttributes): this
Parameters
- name: string
- Optionalattrs: TraceAttributes
Returns this
- Defined in telemetry/types.ts:56

recordException

recordException(error: SpanException): this
The core passes a sanitized error (see SpanException).
Parameters
- error: SpanException
Returns this
- Defined in telemetry/types.ts:58

setStatus

setStatus(status: SpanStatus): this
Parameters
- status: SpanStatus
Returns this
- Defined in telemetry/types.ts:59

end

end(endTimeMs?: number): void
Parameters
- OptionalendTimeMs: number
Returns void
- Defined in telemetry/types.ts:60

isRecording

isRecording(): boolean
false when sampled out: the core then skips computing optional attributes (id hashing).

Returns boolean
- Defined in telemetry/types.ts:62

spanContext

spanContext(): SpanContextRef | undefined
Returns SpanContextRef | undefined
- Defined in telemetry/types.ts:63