Graphorin API reference v0.1.0
Graphorin API reference / @graphorin/core / / AISpan
Interface: AISpan<T>
Defined in: packages/core/src/contracts/tracer.ts:83
Typed span. Generic over SpanType so consumers can specialize a function on a particular span kind without losing the discriminator.
Stable
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends SpanType | SpanType |
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
id | readonly | string | packages/core/src/contracts/tracer.ts:85 |
parentId? | readonly | string | packages/core/src/contracts/tracer.ts:87 |
traceId | readonly | string | packages/core/src/contracts/tracer.ts:86 |
type | readonly | T | packages/core/src/contracts/tracer.ts:84 |
Methods
addEvent()
addEvent(name, attrs?): void;Defined in: packages/core/src/contracts/tracer.ts:91
Append a span event (attribute-bearing time-stamped marker).
Parameters
| Parameter | Type |
|---|---|
name | string |
attrs? | Readonly<Record<string, SpanAttributeValue>> |
Returns
void
end()
end(): void;Defined in: packages/core/src/contracts/tracer.ts:97
End the span. Idempotent.
Returns
void
recordException()
recordException(err): void;Defined in: packages/core/src/contracts/tracer.ts:93
Record an exception. Multiple calls are kept in the span event log.
Parameters
| Parameter | Type |
|---|---|
err | unknown |
Returns
void
setAttributes()
setAttributes(attrs): void;Defined in: packages/core/src/contracts/tracer.ts:89
Add or replace attributes. Repeated calls are merged (last write wins).
Parameters
| Parameter | Type |
|---|---|
attrs | SpanAttributes |
Returns
void
setStatus()
setStatus(status, message?): void;Defined in: packages/core/src/contracts/tracer.ts:95
Set the terminal status.
Parameters
| Parameter | Type |
|---|---|
status | SpanStatus |
message? | string |
Returns
void