Interface ISpan

Represents a single trace span.

interface ISpan {
    name: string;
    context: TraceContext;
    kind: SpanKind;
    startTime: number;
    endTime?: number;
    status: SpanStatus;
    statusMessage?: string;
    attributes: SpanAttributes;
    events: SpanEvent[];
    links: SpanLink[];
    setAttribute(key, value): void;
    setAttributes(attributes): void;
    addEvent(name, attributes?): void;
    setStatus(status, message?): void;
    recordException(error): void;
    end(): void;
    isRecording(): boolean;
}

Index

Methods

setAttribute setAttributes addEvent setStatus recordException end isRecording

Properties

name context kind startTime endTime? status statusMessage? attributes events links

Methods

setAttribute

setAttribute(key, value): void
Sets an attribute on the span.
Parameters
- key: string
  Attribute key
- value: AttributeValue
  Attribute value
Returns void
- Defined in core/observability/ITracer.ts:104

setAttributes

setAttributes(attributes): void
Sets multiple attributes.
Parameters
- attributes: SpanAttributes
  Attributes to set
Returns void
- Defined in core/observability/ITracer.ts:110

addEvent

addEvent(name, attributes?): void
Records an event.
Parameters
- name: string
  Event name
- Optional attributes: SpanAttributes
  Event attributes
Returns void
- Defined in core/observability/ITracer.ts:117

setStatus

setStatus(status, message?): void
Sets the span status.
Parameters
- status: SpanStatus
  Status code
- Optional message: string
  Optional message
Returns void
- Defined in core/observability/ITracer.ts:124

recordException

recordException(error): void
Records an exception.
Parameters
- error: Error
  The error object
Returns void
- Defined in core/observability/ITracer.ts:130

end

end(): void
Ends the span.

Returns void
- Defined in core/observability/ITracer.ts:135

isRecording

isRecording(): boolean
Checks if the span is recording.

Returns boolean
- Defined in core/observability/ITracer.ts:140

Properties

name

name: string

Span name

context

context: TraceContext

Trace context

kind

Span kind

startTime

startTime: number

Start timestamp in milliseconds

`Optional` endTime

endTime?: number

End timestamp in milliseconds

status

status: SpanStatus

Span status

`Optional` statusMessage

statusMessage?: string

Status message

attributes

attributes: SpanAttributes

Span attributes

events

events: SpanEvent[]

Span events

links

links: SpanLink[]

Links to other spans