Sdílet prostřednictvím

TracingClient interface

Balíček:
@azure/core-tracing

Představuje klienta, který se může integrovat s aktuálně nakonfigurovanou Instrumenter.

Vytvořte instanci pomocí createTracingClient.

Metody

createRequestHeaders(TracingContext)

Vytvoří sadu hlaviček požadavků pro šíření informací o trasování do back-endu.
parseTraceparentHeader(string)

Parsuje hodnotu hlavičky traceparent do <xref:TracingSpanContext>.
startSpan<Options>(string, Options, TracingSpanOptions)

Spustí dané rozpětí, ale nenastaví ho jako aktivní rozsah.

Rozsah je nutné ukončit pomocí koncového.

Ve většině případů budete chtít místo toho použít s.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)

Zabalí zpětné volání pomocí aktivního kontextu a zavolá zpětné volání. V závislosti na implementaci to může nastavit globálně dostupný aktivní kontext.

Užitečné, když chcete opustit hranice sady SDK (vytvořit požadavek nebo zpětné volání uživatelského kódu) a nemůžete použít s rozhraním API pan.
withSpan<Options, Callback>(string, Options, Callback, TracingSpanOptions)

Zabalí zpětné volání do rozsahu trasování, zavolá zpětné volání a zavře rozsah.

Toto je primární rozhraní pro použití trasování a bude zpracovávat záznam chyb a také nastavit stav v rozsahu.

Synchronní i asynchronní funkce budou očekávána, aby odrážely výsledek zpětného volání v rozsahu.

Příklad:

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

Podrobnosti metody

createRequestHeaders(TracingContext)

Vytvoří sadu hlaviček požadavků pro šíření informací o trasování do back-endu.

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

Parametry

tracingContext
TracingContext

Kontext obsahující rozsah, který se má rozšířit.

Návraty

Record<string, string>

Sada hlaviček, které se mají přidat k požadavku.

parseTraceparentHeader(string)

Parsuje hodnotu hlavičky traceparent do <xref:TracingSpanContext>.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

Parametry

traceparentHeader

string

Hlavička traceparent, která se má analyzovat.

Návraty

undefined | TracingContext

Identifikátor specifický pro implementaci rozsahu.

startSpan<Options>(string, Options, TracingSpanOptions)

Spustí dané rozpětí, ale nenastaví ho jako aktivní rozsah.

Rozsah je nutné ukončit pomocí koncového.

Ve většině případů budete chtít místo toho použít s.

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

Parametry

name

string

Název rozsahu. Podle konvence by to mělo být ${className}.${methodName}.

operationOptions

Options

Možnosti původní operace.

spanOptions
TracingSpanOptions

Možnosti, které se mají použít při vytváření rozsahu.

Návraty

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

TracingSpan a aktualizované možnosti operace.

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

Zabalí zpětné volání pomocí aktivního kontextu a zavolá zpětné volání. V závislosti na implementaci to může nastavit globálně dostupný aktivní kontext.

Užitečné, když chcete opustit hranice sady SDK (vytvořit požadavek nebo zpětné volání uživatelského kódu) a nemůžete použít s rozhraním API pan.

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

Parametry

context
TracingContext

TracingContext použít jako aktivní kontext v oboru zpětného volání.

callback

Callback

Zpětné volání, které se má vyvolat s danou kontextovou sadou jako globálně aktivní kontext.

callbackArgs

CallbackArgs

Argumenty zpětného volání.

Návraty

ReturnType<Callback>

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

Zabalí zpětné volání do rozsahu trasování, zavolá zpětné volání a zavře rozsah.

Toto je primární rozhraní pro použití trasování a bude zpracovávat záznam chyb a také nastavit stav v rozsahu.

Synchronní i asynchronní funkce budou očekávána, aby odrážely výsledek zpětného volání v rozsahu.

Příklad:

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

Parametry

name

string

Název rozsahu. Podle konvence by to mělo být ${className}.${methodName}.

operationOptions

Options

Původní možnosti předané metodě. Zpětné volání obdrží tyto možnosti s nově vytvořeným TracingContext.

callback

Callback

Zpětné volání, které se má vyvolat s aktualizovanými možnostmi a nově vytvořeným TracingSpan.

spanOptions
TracingSpanOptions

Návraty

Promise<Resolved<ReturnType<Callback>>>