Interface AISpan

A telemetry span representing a unit of work

interface AISpan {
    id: string;
    name: string;
    type: SpanType;
    startTime: Date;
    endTime?: Date;
    durationMs?: number;
    status: SpanStatus;
    error?: Error;
    attributes: Record<string, string | number | boolean>;
    setAttribute(key: string, value: string | number | boolean): void;
    setAttributes(attributes: Record<string, string | number | boolean>): void;
    recordException(error: Error): void;
    setStatus(status: SpanStatus, message?: string): void;
    end(): void;
}

Methods

setAttribute setAttributes recordException setStatus end

Properties

id name type startTime endTime? durationMs? status error? attributes

Methods

setAttribute

  • setAttribute(key: string, value: string | number | boolean): void

    Set an attribute on the span

    Parameters

    • key: string
    • value: string | number | boolean

    Returns void

setAttributes

  • setAttributes(attributes: Record<string, string | number | boolean>): void

    Set multiple attributes

    Parameters

    • attributes: Record<string, string | number | boolean>

    Returns void

recordException

setStatus

end

Properties

Readonlyid

id: string

Unique identifier for this span

Readonlyname

name: string

Span name

Readonlytype

type: SpanType

Span type

ReadonlystartTime

startTime: Date

Start time

Optional ReadonlyendTime

endTime?: Date

End time (set when span is completed)

Optional ReadonlydurationMs

durationMs?: number

Span duration in milliseconds

Readonlystatus

status: SpanStatus

Span status

Optional Readonlyerror

error?: Error

Error if span failed

Readonlyattributes

attributes: Record<string, string | number | boolean>

Span attributes (metadata)

Settings

Member Visibility

On This Page

Methods
Properties