Interface Span<Context>

Span interface

interface Span<Context> {
    addEvent(name, attributes?): void;
    end(): void;
    recordException(exception, time?): void;
    setAttribute(key, value): void;
    setAttributes(attributes): void;
    setSpanOnContext(ctx): Context;
}

Type Parameters

Context = any

Index

Methods

addEvent end recordException setAttribute setAttributes setSpanOnContext

Methods

addEvent

addEvent(name, attributes?): void
addEvent adds an event to the span.
Parameters
- name: string
- Optional attributes: Attributes
Returns void
- Defined in interfaces/telemetry.ts:124

end

end(): void
end ends the span.

Note: spans must be ended so that they can be exported.

Returns void
- Defined in interfaces/telemetry.ts:139

recordException

recordException(exception, time?): void
recordException records an exception on the span.
Parameters
- exception: Exception
- Optional time: Time
Returns void
- Defined in interfaces/telemetry.ts:132

setAttribute

setAttribute(key, value): void
setAttribute sets an attribute on the span.
Parameters
- key: string
- value: AttributeValue
Returns void
- Defined in interfaces/telemetry.ts:109

setAttributes

setAttributes(attributes): void
setAttributes sets multiple attributes on the span.
Parameters
- attributes: Attributes
Returns void
- Defined in interfaces/telemetry.ts:116

setSpanOnContext

setSpanOnContext(ctx): Context
setSpanOnContext sets the span on the context. This is useful when you want to propagate the span across the application.
Parameters
- ctx: Context
Returns Context
- Defined in interfaces/telemetry.ts:102

Generated using TypeDoc