Compartir a través de

Instrumenter interface

  • Referencia
Paquete:
@azure/core-tracing

Representa un instrumentador independiente de la implementación.

Métodos

createRequestHeaders(TracingContext)

Proporciona un método específico de la implementación para serializar en TracingSpan un conjunto de encabezados.
parseTraceparentHeader(string)

Proporciona un método específico de la implementación para analizar en https://www.w3.org/TR/trace-context/#traceparent-header un <xref:TracingSpanContext> que se puede usar para vincular intervalos no primarios juntos.
startSpan(string, InstrumenterSpanOptions)

Crea un nuevo TracingSpan con el nombre y las opciones especificados y lo establece en un nuevo contexto.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)

Ajusta una devolución de llamada con un contexto activo y llama a la devolución de llamada. En función de la implementación, esto puede establecer el contexto activo disponible globalmente.

Detalles del método

createRequestHeaders(TracingContext)

Proporciona un método específico de la implementación para serializar en TracingSpan un conjunto de encabezados.

function createRequestHeaders(tracingContext?: TracingContext): Record<string, string>

Parámetros

tracingContext
TracingContext

Contexto que contiene el intervalo que se va a serializar.

Devoluciones

Record<string, string>

parseTraceparentHeader(string)

Proporciona un método específico de la implementación para analizar en https://www.w3.org/TR/trace-context/#traceparent-header un <xref:TracingSpanContext> que se puede usar para vincular intervalos no primarios juntos.

function parseTraceparentHeader(traceparentHeader: string): TracingContext | undefined

Parámetros

traceparentHeader

string

Devoluciones

TracingContext | undefined

startSpan(string, InstrumenterSpanOptions)

Crea un nuevo TracingSpan con el nombre y las opciones especificados y lo establece en un nuevo contexto.

function startSpan(name: string, spanOptions: InstrumenterSpanOptions): { span: TracingSpan, tracingContext: TracingContext }

Parámetros

name

string

Nombre del intervalo. Por convención, debe ser ${className}.${methodName}.

spanOptions
InstrumenterSpanOptions

Las opciones que se usarán al crear el intervalo.

Devoluciones

{ span: TracingSpan, tracingContext: TracingContext }

TracingSpan que se puede usar para finalizar el intervalo y el contexto en el que se ha establecido este intervalo.

withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)

Ajusta una devolución de llamada con un contexto activo y llama a la devolución de llamada. En función de la implementación, esto puede establecer el contexto activo disponible globalmente.

function withContext<CallbackArgs, Callback>(context: TracingContext, callback: Callback, callbackArgs: CallbackArgs): ReturnType<Callback>

Parámetros

context
TracingContext

que TracingContext se va a usar como contexto activo en el ámbito de la devolución de llamada.

callback

Callback

Devolución de llamada que se va a invocar con el contexto especificado establecido como contexto activo globalmente.

callbackArgs

CallbackArgs

Argumentos de devolución de llamada.

Devoluciones

ReturnType<Callback>