TracingClient interface

Paket:

@azure/core-tracing

şu anda yapılandırılmış olan Instrumenterile tümleştirilebilen bir istemciyi temsil eder.

createTracingClientkullanarak bir örnek oluşturun.

Yöntemler

createRequestHeaders(TracingContext)	İzleme bilgilerini arka uçtan yaymak için bir dizi istek üst bilgisi oluşturur.
parseTraceparentHeader(string)	traceparent üst bilgi değerini bir <xref:TracingSpanContext>ayrıştırıyor.
startSpan<Options>(string, Options, TracingSpanOptions)	Belirli bir yayılma alanını başlatır ancak etkin yayılma alanı olarak ayarlamaz. uçkullanarak yayılmayı sonlandırmanız gerekir. Çoğu zaman bunun yerine ileSpan kullanmak istersiniz.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)	Bir geri aramayı etkin bir bağlamla sarmalar ve geri aramayı çağırır. Uygulamaya bağlı olarak, bu genel olarak kullanılabilir etkin bağlamı ayarlayabilir. SDK sınırlarını bırakmak istediğinizde (kullanıcı koduna istekte bulunmak veya geri çağırmak) ve withSpan API'sini kullanamadığınızda kullanışlıdır.
withSpan<Options, Callback>(string, Options, Callback, TracingSpanOptions)	Bir geri aramayı bir izleme aralığına sarmalar, geri aramayı çağırır ve yayılmayı kapatır. Bu, İzleme'yi kullanmaya yönelik birincil arabirimdir ve hata kaydının yanı sıra span'da durumu ayarlar. Hem zaman uyumlu hem de zaman uyumsuz işlevler, yayılma alanında geri çağırmanın sonucunu yansıtmak için beklenir. Örnek: 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"; }, );

Yöntem Ayrıntıları

createRequestHeaders(TracingContext)

İzleme bilgilerini arka uçtan yaymak için bir dizi istek üst bilgisi oluşturur.

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

Parametreler

tracingContext

TracingContext

Yayılacak yayılma aralığını içeren bağlam.

Döndürülenler

Record<string, string>

bir isteğe eklenecek üst bilgi kümesi.

parseTraceparentHeader(string)

traceparent üst bilgi değerini bir <xref:TracingSpanContext>ayrıştırıyor.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

Parametreler

traceparentHeader

string

Ayrıştırmak için traceparent üst bilgisi.

Döndürülenler

undefined | TracingContext

Yayılma alanı için uygulamaya özgü bir tanımlayıcı.

startSpan<Options>(string, Options, TracingSpanOptions)

Belirli bir yayılma alanını başlatır ancak etkin yayılma alanı olarak ayarlamaz.

uçkullanarak yayılmayı sonlandırmanız gerekir.

Çoğu zaman bunun yerine ileSpan kullanmak istersiniz.

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

Parametreler

name

string

Yayılma alanının adı. Kural gereği bu ${className}.${methodName}olmalıdır.

operationOptions

Options

Özgün işlem seçenekleri.

spanOptions

TracingSpanOptions

Yayılma alanı oluşturulurken kullanılacak seçenekler.

Döndürülenler

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

TracingSpan ve güncelleştirilmiş işlem seçenekleri.

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

Bir geri aramayı etkin bir bağlamla sarmalar ve geri aramayı çağırır. Uygulamaya bağlı olarak, bu genel olarak kullanılabilir etkin bağlamı ayarlayabilir.

SDK sınırlarını bırakmak istediğinizde (kullanıcı koduna istekte bulunmak veya geri çağırmak) ve withSpan API'sini kullanamadığınızda kullanışlıdır.

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

Parametreler

context

TracingContext

TracingContext, geri çağırma kapsamında etkin bağlam olarak kullanılacak.

callback

Callback

Verilen bağlam genel olarak etkin bağlam olarak ayarlanmış olarak çağrılacak geri çağırma.

callbackArgs

CallbackArgs

Geri çağırma bağımsız değişkenleri.

Döndürülenler

ReturnType<Callback>

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

Bir geri aramayı bir izleme aralığına sarmalar, geri aramayı çağırır ve yayılmayı kapatır.

Bu, İzleme'yi kullanmaya yönelik birincil arabirimdir ve hata kaydının yanı sıra span'da durumu ayarlar.

Hem zaman uyumlu hem de zaman uyumsuz işlevler, yayılma alanında geri çağırmanın sonucunu yansıtmak için beklenir.

Örnek:

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

Parametreler

name

string

Yayılma alanının adı. Kural gereği bu ${className}.${methodName}olmalıdır.

operationOptions

Options

Yöntemine geçirilen özgün seçenekler. Geri arama, yeni oluşturulan TracingContextile bu seçenekleri alır.

callback

Callback

Güncelleştirilmiş seçeneklerle çağrılacak geri arama ve yeni oluşturulan TracingSpan.

spanOptions

TracingSpanOptions

Döndürülenler

Promise<Resolved<ReturnType<Callback>>>