TracingClient interface

Paquete:

@azure/core-tracing

Representa un cliente que se puede integrar con el instrumentador de configurado actualmente.

Cree una instancia mediante createTracingClient.

Métodos

createRequestHeaders(TracingContext)	Crea un conjunto de encabezados de solicitud para propagar la información de seguimiento a un back-end.
parseTraceparentHeader(string)	Analiza un valor de encabezado traceparent en un <xref:TracingSpanContext>.
startSpan<Options>(string, Options, TracingSpanOptions)	Inicia un intervalo determinado, pero no lo establece como el intervalo activo. Debe finalizar el intervalo mediante final. La mayoría de las veces querrá usar conSpan en su lugar.
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. Resulta útil cuando desea dejar los límites del SDK (realizar una solicitud o una devolución de llamada al código de usuario) y no puede usar el withSpan API.
withSpan<Options, Callback>(string, Options, Callback, TracingSpanOptions)	Ajusta una devolución de llamada en un intervalo de seguimiento, llama a la devolución de llamada y cierra el intervalo. Esta es la interfaz principal para usar el seguimiento y controlará la grabación de errores, así como el establecimiento del estado en el intervalo. Se esperarán las funciones sincrónicas y asincrónicas para reflejar el resultado de la devolución de llamada en el intervalo. Ejemplo: import { createTracingClient } from "@azure/core-tracing"; const tracingClient = createTracingClient({ namespace: "test.namespace", packageName: "test-package", packageVersion: "1.0.0", }); const options = {}; const myOperationResult = await tracingClient.withSpan( "myClassName.myOperationName", options, (updatedOptions) => { // Do something with the updated options. return "myOperationResult"; }, );

Detalles del método

createRequestHeaders(TracingContext)

Crea un conjunto de encabezados de solicitud para propagar la información de seguimiento a un back-end.

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

Parámetros

tracingContext

TracingContext

Contexto que contiene el intervalo que se va a propagar.

Devoluciones

Record<string, string>

Conjunto de encabezados que se van a agregar a una solicitud.

parseTraceparentHeader(string)

Analiza un valor de encabezado traceparent en un <xref:TracingSpanContext>.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

Parámetros

traceparentHeader

string

Encabezado traceparent que se va a analizar.

Devoluciones

undefined | TracingContext

Identificador específico de la implementación del intervalo.

startSpan<Options>(string, Options, TracingSpanOptions)

Inicia un intervalo determinado, pero no lo establece como el intervalo activo.

Debe finalizar el intervalo mediante final.

La mayoría de las veces querrá usar conSpan en su lugar.

function startSpan<Options>(name: string, operationOptions?: Options, spanOptions?: TracingSpanOptions): { span: TracingSpan, updatedOptions: OptionsWithTracingContext<Options> }

Parámetros

name

string

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

operationOptions

Options

Las opciones de operación originales.

spanOptions

TracingSpanOptions

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

Devoluciones

{ span: TracingSpan, updatedOptions: OptionsWithTracingContext<Options> }

Una TracingSpan y las opciones de operación actualizadas.

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.

Resulta útil cuando desea dejar los límites del SDK (realizar una solicitud o una devolución de llamada al código de usuario) y no puede usar el withSpan API.

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

Parámetros

context

TracingContext

El TracingContext 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 global.

callbackArgs

CallbackArgs

Argumentos de devolución de llamada.

Devoluciones

ReturnType<Callback>

withSpan<Options, Callback>(string, Options, Callback, TracingSpanOptions)

Ajusta una devolución de llamada en un intervalo de seguimiento, llama a la devolución de llamada y cierra el intervalo.

Esta es la interfaz principal para usar el seguimiento y controlará la grabación de errores, así como el establecimiento del estado en el intervalo.

Se esperarán las funciones sincrónicas y asincrónicas para reflejar el resultado de la devolución de llamada en el intervalo.

Ejemplo:

import { createTracingClient } from "@azure/core-tracing";

const tracingClient = createTracingClient({
  namespace: "test.namespace",
  packageName: "test-package",
  packageVersion: "1.0.0",
});

const options = {};

const myOperationResult = await tracingClient.withSpan(
  "myClassName.myOperationName",
  options,
  (updatedOptions) => {
    // Do something with the updated options.
    return "myOperationResult";
  },
);

function withSpan<Options, Callback>(name: string, operationOptions: Options, callback: Callback, spanOptions?: TracingSpanOptions): Promise<Resolved<ReturnType<Callback>>>

Parámetros

name

string

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

operationOptions

Options

Las opciones originales que se pasan al método . La devolución de llamada recibirá estas opciones con el TracingContext recién creado.

callback

Callback

Devolución de llamada que se va a invocar con las opciones actualizadas y TracingSpan.

spanOptions

TracingSpanOptions

Devoluciones

Promise<Resolved<ReturnType<Callback>>>