Skip to main content

Interface: ISpan

Defined in: packages/agentos/src/core/observability/ITracer.ts:77

Represents a single trace span.

Properties​

attributes​

attributes: SpanAttributes

Defined in: packages/agentos/src/core/observability/ITracer.ts:93

Span attributes

context​

context: TraceContext

Defined in: packages/agentos/src/core/observability/ITracer.ts:81

Trace context

endTime?​

optional endTime: number

Defined in: packages/agentos/src/core/observability/ITracer.ts:87

End timestamp in milliseconds

events​

events: SpanEvent[]

Defined in: packages/agentos/src/core/observability/ITracer.ts:95

Span events

kind​

kind: SpanKind

Defined in: packages/agentos/src/core/observability/ITracer.ts:83

Span kind

links: SpanLink[]

Defined in: packages/agentos/src/core/observability/ITracer.ts:97

Links to other spans

name​

name: string

Defined in: packages/agentos/src/core/observability/ITracer.ts:79

Span name

startTime​

startTime: number

Defined in: packages/agentos/src/core/observability/ITracer.ts:85

Start timestamp in milliseconds

status​

status: SpanStatus

Defined in: packages/agentos/src/core/observability/ITracer.ts:89

Span status

statusMessage?​

optional statusMessage: string

Defined in: packages/agentos/src/core/observability/ITracer.ts:91

Status message

Methods​

addEvent()​

addEvent(name, attributes?): void

Defined in: packages/agentos/src/core/observability/ITracer.ts:117

Records an event.

Parameters​

name​

string

Event name

attributes?​

SpanAttributes

Event attributes

Returns​

void

end()​

end(): void

Defined in: packages/agentos/src/core/observability/ITracer.ts:135

Ends the span.

Returns​

void

isRecording()​

isRecording(): boolean

Defined in: packages/agentos/src/core/observability/ITracer.ts:140

Checks if the span is recording.

Returns​

boolean

recordException()​

recordException(error): void

Defined in: packages/agentos/src/core/observability/ITracer.ts:130

Records an exception.

Parameters​

error​

Error

The error object

Returns​

void

setAttribute()​

setAttribute(key, value): void

Defined in: packages/agentos/src/core/observability/ITracer.ts:104

Sets an attribute on the span.

Parameters​

key​

string

Attribute key

value​

AttributeValue

Attribute value

Returns​

void

setAttributes()​

setAttributes(attributes): void

Defined in: packages/agentos/src/core/observability/ITracer.ts:110

Sets multiple attributes.

Parameters​

attributes​

SpanAttributes

Attributes to set

Returns​

void

setStatus()​

setStatus(status, message?): void

Defined in: packages/agentos/src/core/observability/ITracer.ts:124

Sets the span status.

Parameters​

status​

SpanStatus

Status code

message?​

string

Optional message

Returns​

void