Interface ISpan

A span represents a single operation within a trace.

Since

0.2.0

interface ISpan {
    end(): void;
    recordException(error: Error): void;
    setAttribute(key: string, value: SpanAttributeValue): this;
    setAttributes(
        attributes: Readonly<Record<string, SpanAttributeValue>>,
    ): this;
    setStatus(status: SpanStatus): void;
    spanContext(): SpanContext;
}

Index

Methods

end recordException setAttribute setAttributes setStatus spanContext

Methods

end

end(): void
Ends the span. Must be called exactly once.

Returns void
- Defined in packages/common/src/services/telemetry.ts:141

recordException

recordException(error: Error): void
Records an exception on this span.
Parameters
- error: Error
  The error to record
Returns void
- Defined in packages/common/src/services/telemetry.ts:136

setAttribute

setAttribute(key: string, value: SpanAttributeValue): this
Sets a single attribute on the span.
Parameters
- key: string
  Attribute name
- value: SpanAttributeValue
  Attribute value
Returns this
This span, for chaining
- Defined in packages/common/src/services/telemetry.ts:114

setAttributes

setAttributes(attributes: Readonly<Record<string, SpanAttributeValue>>): this
Sets multiple attributes on the span.
Parameters
- attributes: Readonly<Record<string, SpanAttributeValue>>
  Key-value map of attributes
Returns this
This span, for chaining
- Defined in packages/common/src/services/telemetry.ts:122

setStatus

setStatus(status: SpanStatus): void
Sets the status of the span.
Parameters
- status: SpanStatus
  The span status
Returns void
- Defined in packages/common/src/services/telemetry.ts:129

spanContext

spanContext(): SpanContext
Returns the span's context (traceId, spanId, traceFlags).

Used by the middleware to inject the span's own traceparent into the response header so downstream hops see this server span as the parent.

Returns SpanContext

Since
0.2.0
- Defined in packages/common/src/services/telemetry.ts:151