Interface BotTracing

Tracing facade of a bot (bot.tracing), also used by plugins (@botmesh/ai). Without BotConfig.telemetry it is a no-op (enabled === false).

interface BotTracing {
    enabled: boolean;
    startSpan(name: string, options?: SpanOptions): BotSpan;
    activeSpan(): BotSpan | undefined;
    withSpan<T>(span: BotSpan, fn: () => T): T;
    trace<T>(name: string, options: SpanOptions, fn: (span: BotSpan) => T): T;
    recordError(span: BotSpan, error: unknown): void;
    idAttribute(id: string): string | undefined;
}

Index

Properties

Methods

startSpan activeSpan withSpan trace recordError idAttribute

Properties

`Readonly`enabled

enabled: boolean

Methods

startSpan

startSpan(name: string, options?: SpanOptions): BotSpan
Parameters
- name: string
- Optionaloptions: SpanOptions
Returns BotSpan
- Defined in telemetry/types.ts:120

activeSpan

activeSpan(): BotSpan | undefined
The span the current async chain runs under (core context), if any.

Returns BotSpan | undefined
- Defined in telemetry/types.ts:122

withSpan

withSpan<T>(span: BotSpan, fn: () => T): T
Run fn with span active (core context and the backend's). Returns fn's value unchanged.
Type Parameters
- T
Parameters
- span: BotSpan
- fn: () => T
Returns T
- Defined in telemetry/types.ts:124

trace

trace<T>(name: string, options: SpanOptions, fn: (span: BotSpan) => T): T
Start a span, run fn inside it and end it when fn returns or its promise settles (a throw/rejection sets status error and records the sanitized exception). Returns fn's own value or promise — never a derived one.
Type Parameters
- T
Parameters
- name: string
- options: SpanOptions
- fn: (span: BotSpan) => T
Returns T
- Defined in telemetry/types.ts:130

recordError

recordError(span: BotSpan, error: unknown): void
Record a sanitized error on span (status error, error.type, exception event).
Parameters
- span: BotSpan
- error: unknown
Returns void
- Defined in telemetry/types.ts:132

idAttribute

idAttribute(id: string): string | undefined
Apply the ids policy to an id (undefined under 'omit'). For plugins that tag their own spans.
Parameters
- id: string
Returns string | undefined
- Defined in telemetry/types.ts:134