Skip to main content

TelemetrySpan

@quik/core

@quik/core / TelemetrySpan

Interface: TelemetrySpan

Defined in: types/IQTelemetry.ts:20

Minimal contract for a telemetry span.

Methods​

end()​

end(): void

Defined in: types/IQTelemetry.ts:22

Marks the span as finished.

Returns​

void

recordException()?​

optional recordException(error): void | TelemetrySpan

Defined in: types/IQTelemetry.ts:28

Record an exception on the span.

Parameters​

error​

Error

Returns​

void | TelemetrySpan

setAttribute()?​

optional setAttribute(key, value): void | TelemetrySpan

Defined in: types/IQTelemetry.ts:24

Attach a single attribute to the span.

Parameters​

key​

string

value​

TelemetrySpanAttributeValue

Returns​

void | TelemetrySpan

setAttributes()?​

optional setAttributes(attributes): void | TelemetrySpan

Defined in: types/IQTelemetry.ts:26

Attach multiple attributes to the span.

Parameters​

attributes​

TelemetrySpanAttributes

Returns​

void | TelemetrySpan

setStatus()?​

optional setStatus(status): void | TelemetrySpan

Defined in: types/IQTelemetry.ts:30

Set the span status.

Parameters​

status​

TelemetrySpanStatus

Returns​

void | TelemetrySpan