Class OutputScope

Provides OpenTelemetry tracing scope for output message tracing.

Hierarchy (View Summary)

OpenTelemetryScope
- OutputScope

Index

Properties

Methods

[dispose] dispose getSpanContext recordAttributes recordCancellation recordError recordInputMessages recordOutputMessages setEndTime setTagMaybe withActiveSpanAsync start

Properties

`Protected` `Readonly`span

span: Span

Methods

[dispose]

"[dispose]"(): void
Disposes the scope and finalizes telemetry data collection.

Returns void
Inherited from OpenTelemetryScope.[dispose]
- Defined in a365/scopes/OpenTelemetryScope.ts:263

dispose

dispose(): void
Legacy dispose method for compatibility.

Returns void
Inherited from OpenTelemetryScope.dispose
- Defined in a365/scopes/OpenTelemetryScope.ts:275

getSpanContext

getSpanContext(): SpanContext
Gets the span context for this scope.

Returns SpanContext
Inherited from OpenTelemetryScope.getSpanContext
- Defined in a365/scopes/OpenTelemetryScope.ts:148

recordAttributes

recordAttributes(
    attributes:
        | Iterable<[string, AttributeValue], any, any>
        | Record<string, AttributeValue>
        | null
        | undefined,
): void
Records multiple attribute key/value pairs.
Parameters
- attributes:
      | Iterable<[string, AttributeValue], any, any>
      | Record<string, AttributeValue>
      | null
      | undefined
Returns void
Inherited from OpenTelemetryScope.recordAttributes
- Defined in a365/scopes/OpenTelemetryScope.ts:168

recordCancellation

recordCancellation(reason?: string): void
Records a cancellation event on the span.
Parameters
- Optionalreason: string
Returns void
Inherited from OpenTelemetryScope.recordCancellation
- Defined in a365/scopes/OpenTelemetryScope.ts:225

recordError

recordError(error: Error): void
Records an error that occurred during the operation.
Parameters
- error: Error
Returns void
Inherited from OpenTelemetryScope.recordError
- Defined in a365/scopes/OpenTelemetryScope.ts:153

`Protected`recordInputMessages

recordInputMessages(messages: InputMessagesParam): void
Records the input messages for telemetry tracking.
Parameters
- messages: InputMessagesParam
Returns void
Inherited from OpenTelemetryScope.recordInputMessages
- Defined in a365/scopes/OpenTelemetryScope.ts:193

recordOutputMessages

recordOutputMessages(messages: ResponseMessagesParam): void
Records the output messages for telemetry tracking. Overwrites any previously recorded output messages.
Parameters
- messages: ResponseMessagesParam
Returns void
Overrides OpenTelemetryScope.recordOutputMessages
- Defined in a365/scopes/OutputScope.ts:78

setEndTime

setEndTime(endTime: TimeInput): void
Sets a custom end time for the scope. When set, dispose() will pass this value to span.end() instead of using wall-clock time.
Parameters
- endTime: TimeInput
Returns void
Inherited from OpenTelemetryScope.setEndTime
- Defined in a365/scopes/OpenTelemetryScope.ts:220

`Protected`setTagMaybe

setTagMaybe<T extends string | number | boolean | string[] | number[]>(
name: string,
value: T | null | undefined,
): void
Sets a tag on the span if the value is not null or undefined.
Type Parameters
- T extends string | number | boolean | string[] | number[]
Parameters
- name: string
- value: T | null | undefined
Returns void
Inherited from OpenTelemetryScope.setTagMaybe
- Defined in a365/scopes/OpenTelemetryScope.ts:205

withActiveSpanAsync

withActiveSpanAsync<T>(callback: () => Promise<T>): Promise<T>
Makes this span active for the duration of the async callback execution.
Type Parameters
- T
Parameters
- callback: () => Promise<T>
Returns Promise<T>
Inherited from OpenTelemetryScope.withActiveSpanAsync
- Defined in a365/scopes/OpenTelemetryScope.ts:142

`Static`start

start(
    request: A365Request,
    response: OutputResponse,
    agentDetails: AgentDetails,
    userDetails?: UserDetails,
    spanDetails?: A365SpanDetails,
): OutputScope
Creates and starts a new scope for output message tracing.
Parameters
- request: A365Request
  Request payload (channel, conversationId, content, sessionId).
- response: OutputResponse
  The response containing initial output messages.
- agentDetails: AgentDetails
  The agent producing the output. tenantId is required.
- OptionaluserDetails: UserDetails
  Optional human caller identity details.
- OptionalspanDetails: A365SpanDetails
  Optional span configuration.
Returns OutputScope
- Defined in a365/scopes/OutputScope.ts:31

Class OutputScope

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Protected Readonlyspan

Methods

[dispose]

Returns void

dispose

Returns void

getSpanContext

Returns SpanContext

recordAttributes

Parameters

Returns void

recordCancellation

Parameters

Returns void

recordError

Parameters

Returns void

ProtectedrecordInputMessages

Parameters

Returns void

recordOutputMessages

Parameters

Returns void

setEndTime

Parameters

Returns void

ProtectedsetTagMaybe

Type Parameters

Parameters

Returns void

withActiveSpanAsync

Type Parameters

Parameters

Returns Promise<T>

Staticstart

Parameters

Returns OutputScope

Settings

On This Page

`Protected` `Readonly`span

`Protected`recordInputMessages

`Protected`setTagMaybe

`Static`start