ExecuteToolScope class
Provides OpenTelemetry tracing scope for AI tool execution operations.
- Extends
Methods
| record |
Records response information for telemetry tracking. |
| start(Request, Tool |
Creates and starts a new scope for tool execution tracing. |
Inherited Methods
| dispose() | Legacy dispose method for compatibility |
| get |
Gets the span context for this scope. This can be used to create a ParentSpanRef for explicit parent-child linking across async boundaries. |
| record |
Records multiple attribute key/value pairs for telemetry tracking. |
| record |
Records a cancellation event on the span. Sets the span status to ERROR with the cancellation reason and marks the error type as 'TaskCanceledException'. |
| record |
Records an error that occurred during the operation |
| set |
Sets a custom end time for the scope.
When set, dispose will pass this value to |
| with |
Makes this span active for the duration of the async callback execution |
Method Details
recordResponse(string | Record<string, unknown>)
Records response information for telemetry tracking.
function recordResponse(response: string | Record<string, unknown>)Parameters
- response
-
string | Record<string, unknown>
The tool execution response. Objects are serialized to JSON automatically.
start(Request, ToolCallDetails, AgentDetails, UserDetails, SpanDetails)
Creates and starts a new scope for tool execution tracing.
static function start(request: Request, details: ToolCallDetails, agentDetails: AgentDetails, userDetails?: UserDetails, spanDetails?: SpanDetails): ExecuteToolScopeParameters
- request
- Request
Request payload (channel, conversationId, content, sessionId).
- details
- ToolCallDetails
The tool call details (name, type, args, call id, etc.).
- agentDetails
- AgentDetails
The agent executing the tool. Tenant ID is derived from agentDetails.tenantId.
- userDetails
- UserDetails
Optional human caller identity.
- spanDetails
- SpanDetails
Optional span configuration (parentContext, startTime, endTime, spanLinks, spanKind). Defaults to SpanKind.INTERNAL.
Returns
A new ExecuteToolScope 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(): SpanContextReturns
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