OutputScope class

Paquete:
@microsoft/agents-a365-observability

Proporciona el ámbito de seguimiento de OpenTelemetry para el seguimiento de mensajes de salida con la vinculación del intervalo primario.

Extends
OpenTelemetryScope

Métodos

recordOutputMessages(ResponseMessagesParam)

Registra los mensajes de salida para el seguimiento de telemetría. Sobrescribe los mensajes de salida grabados previamente en el intervalo. Acepta una sola cadena, una matriz de cadenas (ajustada automáticamente como OutputMessage de OTEL), un contenedor OutputMessages con versiones o un dict sin formato (tratado como resultado de llamada de herramienta por especificación de OTEL, serializado directamente).
start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)

Crea e inicia un nuevo ámbito para el seguimiento de mensajes de salida.

Métodos heredados

dispose()

Método Dispose heredado para la compatibilidad
getSpanContext()

Obtiene el contexto de intervalo para este ámbito. Esto se puede usar para crear un elemento ParentSpanRef para la vinculación explícita de elementos primarios y secundarios a través de límites asincrónicos.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Registra varios pares clave-valor de atributo para el seguimiento de telemetría.
recordCancellation(string)

Registra un evento de cancelación en el intervalo. Establece el estado del intervalo en ERROR con el motivo de cancelación y marca el tipo de error como "TaskCanceledException".
recordError(Error)

Registra un error que se produjo durante la operación
setEndTime(TimeInput)

Establece una hora de finalización personalizada para el ámbito. Cuando se establece, dispose pasará este valor a span.end() en lugar de usar la hora actual del reloj. Esto resulta útil cuando se conoce la hora de finalización real de la operación antes de eliminar el ámbito.
withActiveSpanAsync<T>(() => Promise<T>)

Hace que este intervalo se active durante la ejecución de la devolución de llamada asincrónica.

Detalles del método

recordOutputMessages(ResponseMessagesParam)

Registra los mensajes de salida para el seguimiento de telemetría. Sobrescribe los mensajes de salida grabados previamente en el intervalo. Acepta una sola cadena, una matriz de cadenas (ajustada automáticamente como OutputMessage de OTEL), un contenedor OutputMessages con versiones o un dict sin formato (tratado como resultado de llamada de herramienta por especificación de OTEL, serializado directamente).

function recordOutputMessages(messages: ResponseMessagesParam)

Parámetros

messages
ResponseMessagesParam

Una cadena, una matriz de cadenas, un contenedor OutputMessages o un dict.

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

Crea e inicia un nuevo ámbito para el seguimiento de mensajes de salida.

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

Parámetros

request
Request

Carga de solicitud (canal, conversationId, contenido, sessionId).

response
OutputResponse

Respuesta que contiene mensajes de salida iniciales.

agentDetails
AgentDetails

Agente que genera la salida. El identificador de inquilino se deriva de agentDetails.tenantId.

userDetails
UserDetails

Detalles opcionales de la identidad del autor de la llamada humana.

spanDetails
SpanDetails

Configuración de intervalo opcional (parentContext, startTime, endTime, spanLinks).

Devoluciones

OutputScope

Nueva instancia de OutputScope.

Detalles de los métodos heredados

dispose()

Método Dispose heredado para la compatibilidad

function dispose()

Heredado deOpenTelemetryScope.dispose

getSpanContext()

Obtiene el contexto de intervalo para este ámbito. Esto se puede usar para crear un elemento ParentSpanRef para la vinculación explícita de elementos primarios y secundarios a través de límites asincrónicos.

function getSpanContext(): SpanContext

Devoluciones

SpanContext

SpanContext que contiene traceId y spanId

Heredado deOpenTelemetryScope.getSpanContext

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

Registra varios pares clave-valor de atributo para el seguimiento de telemetría.

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

Parámetros

attributes

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

Colección de pares clave-valor de atributo (matriz o iterable de [clave, valor] o mapa de objetos).

Heredado deOpenTelemetryScope.recordAttributes

recordCancellation(string)

Registra un evento de cancelación en el intervalo. Establece el estado del intervalo en ERROR con el motivo de cancelación y marca el tipo de error como "TaskCanceledException".

function recordCancellation(reason?: string)

Parámetros

reason

string

Motivo de cancelación opcional. El valor predeterminado es "Se canceló la tarea".

Heredado deOpenTelemetryScope.recordCancellation

recordError(Error)

Registra un error que se produjo durante la operación

function recordError(error: Error)

Parámetros

error

Error

El error que ocurrió

Heredado deOpenTelemetryScope.recordError

setEndTime(TimeInput)

Establece una hora de finalización personalizada para el ámbito. Cuando se establece, dispose pasará este valor a span.end() en lugar de usar la hora actual del reloj. Esto resulta útil cuando se conoce la hora de finalización real de la operación antes de eliminar el ámbito.

function setEndTime(endTime: TimeInput)

Parámetros

endTime

TimeInput

Hora de finalización como milisegundos desde la época, una fecha o una tupla HrTime.

Heredado deOpenTelemetryScope.setEndTime

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

Hace que este intervalo se active durante la ejecución de la devolución de llamada asincrónica.

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

Parámetros

callback

() => Promise<T>

Devoluciones

Promise<T>

Heredado deOpenTelemetryScope.withActiveSpanAsync