TracingClient interface

Pakket:

@azure/core-tracing

Vertegenwoordigt een client die kan worden geïntegreerd met de momenteel geconfigureerde Instrumenter.

Maak een exemplaar met behulp van createTracingClient.

Methoden

createRequestHeaders(TracingContext)	Hiermee maakt u een set aanvraagheaders om traceringsgegevens door te geven aan een back-end.
parseTraceparentHeader(string)	Parseert een traceringstekstwaarde in een <xref:TracingSpanContext>.
startSpan<Options>(string, Options, TracingSpanOptions)	Hiermee wordt een bepaalde periode gestart, maar wordt deze niet ingesteld als de actieve periode. U moet de periode beëindigen met behulp van einde van. Meestal wilt u in plaats daarvan gebruiken metSpan.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)	Verpakt een callback met een actieve context en roept de callback aan. Afhankelijk van de implementatie kan hiermee de wereldwijd beschikbare actieve context worden ingesteld. Handig als u de grenzen van de SDK wilt verlaten (een aanvraag of callback naar gebruikerscode indienen) en de metSpan-API niet kunt gebruiken.
withSpan<Options, Callback>(string, Options, Callback, TracingSpanOptions)	Verpakt een callback in een traceringsspanne, roept de callback aan en sluit de periode. Dit is de primaire interface voor het gebruik van tracering en verwerkt foutopname en het instellen van de status op de spanwijdte. Zowel synchrone als asynchrone functies worden in afwachting van het resultaat van de callback in de periode. Voorbeeld: 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"; }, );

Methodedetails

createRequestHeaders(TracingContext)

Hiermee maakt u een set aanvraagheaders om traceringsgegevens door te geven aan een back-end.

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

Parameters

tracingContext

TracingContext

De context die het bereik bevat dat moet worden doorgegeven.

Retouren

Record<string, string>

De set headers die u aan een aanvraag wilt toevoegen.

parseTraceparentHeader(string)

Parseert een traceringstekstwaarde in een <xref:TracingSpanContext>.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

Parameters

traceparentHeader

string

De traceparent-header die moet worden geparseerd.

Retouren

undefined | TracingContext

Een implementatiespecifieke id voor de periode.

startSpan<Options>(string, Options, TracingSpanOptions)

Hiermee wordt een bepaalde periode gestart, maar wordt deze niet ingesteld als de actieve periode.

U moet de periode beëindigen met behulp van einde van.

Meestal wilt u in plaats daarvan gebruiken metSpan.

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

Parameters

name

string

De naam van de span. Volgens de conventie moet dit ${className}.${methodName}.

operationOptions

Options

De oorspronkelijke bewerkingsopties.

spanOptions

TracingSpanOptions

De opties die moeten worden gebruikt bij het maken van de spanwijdte.

Retouren

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

Een TracingSpan en de bijgewerkte bewerkingsopties.

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

Verpakt een callback met een actieve context en roept de callback aan. Afhankelijk van de implementatie kan hiermee de wereldwijd beschikbare actieve context worden ingesteld.

Handig als u de grenzen van de SDK wilt verlaten (een aanvraag of callback naar gebruikerscode indienen) en de metSpan-API niet kunt gebruiken.

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

Parameters

context

TracingContext

De TracingContext te gebruiken als de actieve context in het bereik van de callback.

callback

Callback

De callback die moet worden aangeroepen met de opgegeven context die is ingesteld als de globaal actieve context.

callbackArgs

CallbackArgs

De callback-argumenten.

Retouren

ReturnType<Callback>

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

Verpakt een callback in een traceringsspanne, roept de callback aan en sluit de periode.

Dit is de primaire interface voor het gebruik van tracering en verwerkt foutopname en het instellen van de status op de spanwijdte.

Zowel synchrone als asynchrone functies worden in afwachting van het resultaat van de callback in de periode.

Voorbeeld:

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

Parameters

name

string

De naam van de span. Volgens de conventie moet dit ${className}.${methodName}.

operationOptions

Options

De oorspronkelijke opties die aan de methode zijn doorgegeven. De callback ontvangt deze opties met de zojuist gemaakte TracingContext.

callback

Callback

De callback die moet worden aangeroepen met de bijgewerkte opties en zojuist gemaakte TracingSpan.

spanOptions

TracingSpanOptions

Retouren

Promise<Resolved<ReturnType<Callback>>>