Dela via

TracingClient interface

Paket:
@azure/core-tracing

Representerar en klient som kan integreras med den för närvarande konfigurerade Instrumenter-.

Skapa en instans med createTracingClient.

Metoder

createRequestHeaders(TracingContext)

Skapar en uppsättning begärandehuvuden för att sprida spårningsinformation till en serverdel.
parseTraceparentHeader(string)

Parsar ett traceparent-huvudvärde till en <xref:TracingSpanContext>.
startSpan<Options>(string, Options, TracingSpanOptions)

Startar ett angivet spann men anger det inte som aktivt spann.

Du måste avsluta intervallet med slut.

För det mesta vill du använda medSpan i stället.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)

Omsluter ett återanrop med en aktiv kontext och anropar återanropet. Beroende på implementeringen kan detta ange den globalt tillgängliga aktiva kontexten.

Användbart när du vill lämna gränserna för SDK (skicka en begäran eller återanrop till användarkod) och inte kan använda withSpan API.
withSpan<Options, Callback>(string, Options, Callback, TracingSpanOptions)

Omsluter ett återanrop i ett spårningsintervall, anropar återanropet och stänger intervallet.

Det här är det primära gränssnittet för att använda spårning och hanterar felinspelning samt anger status för intervallet.

Både synkrona och asynkrona funktioner väntar för att återspegla resultatet av återanropet i intervallet.

Exempel:

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";
  },
);

Metodinformation

createRequestHeaders(TracingContext)

Skapar en uppsättning begärandehuvuden för att sprida spårningsinformation till en serverdel.

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

Parametrar

tracingContext
TracingContext

Kontexten som innehåller det intervall som ska spridas.

Returer

Record<string, string>

Uppsättningen rubriker som ska läggas till i en begäran.

parseTraceparentHeader(string)

Parsar ett traceparent-huvudvärde till en <xref:TracingSpanContext>.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

Parametrar

traceparentHeader

string

Den traceparent-rubrik som ska parsas.

Returer

undefined | TracingContext

En implementeringsspecifik identifierare för intervallet.

startSpan<Options>(string, Options, TracingSpanOptions)

Startar ett angivet spann men anger det inte som aktivt spann.

Du måste avsluta intervallet med slut.

För det mesta vill du använda medSpan i stället.

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

Parametrar

name

string

Namnet på spannet. Enligt konvention bör detta vara ${className}.${methodName}.

operationOptions

Options

De ursprungliga åtgärdsalternativen.

spanOptions
TracingSpanOptions

De alternativ som ska användas när du skapar intervallet.

Returer

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

En TracingSpan- och de uppdaterade åtgärdsalternativen.

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

Omsluter ett återanrop med en aktiv kontext och anropar återanropet. Beroende på implementeringen kan detta ange den globalt tillgängliga aktiva kontexten.

Användbart när du vill lämna gränserna för SDK (skicka en begäran eller återanrop till användarkod) och inte kan använda withSpan API.

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

Parametrar

context
TracingContext

TracingContext att använda som aktiv kontext i återanropets omfång.

callback

Callback

Återanropet som ska anropas med den angivna kontexten inställd som den globalt aktiva kontexten.

callbackArgs

CallbackArgs

Motringningsargumenten.

Returer

ReturnType<Callback>

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

Omsluter ett återanrop i ett spårningsintervall, anropar återanropet och stänger intervallet.

Det här är det primära gränssnittet för att använda spårning och hanterar felinspelning samt anger status för intervallet.

Både synkrona och asynkrona funktioner väntar för att återspegla resultatet av återanropet i intervallet.

Exempel:

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>>>

Parametrar

name

string

Namnet på spannet. Enligt konvention bör detta vara ${className}.${methodName}.

operationOptions

Options

De ursprungliga alternativen skickades till metoden. Återanropet får dessa alternativ med den nyligen skapade TracingContext.

callback

Callback

Återanropet som ska anropas med uppdaterade alternativ och nyligen skapade TracingSpan.

spanOptions
TracingSpanOptions

Returer

Promise<Resolved<ReturnType<Callback>>>