Share via

OutputScope class

Package:
@microsoft/agents-a365-observability

Provides OpenTelemetry tracing scope for output message tracing with parent span linking.

Extends
OpenTelemetryScope

Methods

recordOutputMessages(ResponseMessagesParam)

Records the output messages for telemetry tracking. Overwrites any previously recorded output messages on the span. Accepts a single string, an array of strings (auto-wrapped as OTEL OutputMessage), a versioned OutputMessages wrapper, or a raw dict (treated as a tool call result per OTEL spec, serialized directly).
start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)

Creates and starts a new scope for output message tracing.

Inherited Methods

dispose()

Legacy dispose method for compatibility
getSpanContext()

Gets the span context for this scope. This can be used to create a ParentSpanRef for explicit parent-child linking across async boundaries.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Records multiple attribute key/value pairs for telemetry tracking.
recordCancellation(string)

Records a cancellation event on the span. Sets the span status to ERROR with the cancellation reason and marks the error type as 'TaskCanceledException'.
recordError(Error)

Records an error that occurred during the operation
setEndTime(TimeInput)

Sets a custom end time for the scope. When set, dispose will pass this value to span.end() instead of using the current wall-clock time. This is useful when the actual end time of the operation is known before the scope is disposed.
withActiveSpanAsync<T>(() => Promise<T>)

Makes this span active for the duration of the async callback execution

Method Details

recordOutputMessages(ResponseMessagesParam)

Records the output messages for telemetry tracking. Overwrites any previously recorded output messages on the span. Accepts a single string, an array of strings (auto-wrapped as OTEL OutputMessage), a versioned OutputMessages wrapper, or a raw dict (treated as a tool call result per OTEL spec, serialized directly).

function recordOutputMessages(messages: ResponseMessagesParam)

Parameters

messages
ResponseMessagesParam

A string, array of strings, an OutputMessages wrapper, or a dict.

start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)

Creates and starts a new scope for output message tracing.

static function start(request: Request, response: OutputResponse, agentDetails: AgentDetails, userDetails?: UserDetails, spanDetails?: SpanDetails): OutputScope

Parameters

request
Request

Request payload (channel, conversationId, content, sessionId).

response
OutputResponse

The response containing initial output messages.

agentDetails
AgentDetails

The agent producing the output. Tenant ID is derived from agentDetails.tenantId.

userDetails
UserDetails

Optional human caller identity details.

spanDetails
SpanDetails

Optional span configuration (parentContext, startTime, endTime, spanLinks).

Returns

OutputScope

A new OutputScope instance.

Inherited Method Details

dispose()

Legacy dispose method for compatibility

function dispose()

Inherited From OpenTelemetryScope.dispose

getSpanContext()

Gets the span context for this scope. This can be used to create a ParentSpanRef for explicit parent-child linking across async boundaries.

function getSpanContext(): SpanContext

Returns

SpanContext

The SpanContext containing traceId and spanId

Inherited From OpenTelemetryScope.getSpanContext

recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Records multiple attribute key/value pairs for telemetry tracking.

function recordAttributes(attributes: undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Parameters

attributes

undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>

Collection of attribute key/value pairs (array or iterable of [key, value] or object map).

Inherited From OpenTelemetryScope.recordAttributes

recordCancellation(string)

Records a cancellation event on the span. Sets the span status to ERROR with the cancellation reason and marks the error type as 'TaskCanceledException'.

function recordCancellation(reason?: string)

Parameters

reason

string

Optional cancellation reason. Defaults to 'Task was cancelled'.

Inherited From OpenTelemetryScope.recordCancellation

recordError(Error)

Records an error that occurred during the operation

function recordError(error: Error)

Parameters

error

Error

The error that occurred

Inherited From OpenTelemetryScope.recordError

setEndTime(TimeInput)

Sets a custom end time for the scope. When set, dispose will pass this value to span.end() instead of using the current wall-clock time. This is useful when the actual end time of the operation is known before the scope is disposed.

function setEndTime(endTime: TimeInput)

Parameters

endTime

TimeInput

The end time as milliseconds since epoch, a Date, or an HrTime tuple.

Inherited From OpenTelemetryScope.setEndTime

withActiveSpanAsync<T>(() => Promise<T>)

Makes this span active for the duration of the async callback execution

function withActiveSpanAsync<T>(callback: () => Promise<T>): Promise<T>

Parameters

callback

() => Promise<T>

Returns

Promise<T>

Inherited From OpenTelemetryScope.withActiveSpanAsync