Instrumenter interface

Paket:

@azure/core-tracing

Uygulamadan bağımsız bir araçlayıcıyı temsil eder.

Yöntemler

createRequestHeaders(TracingContext)	bir TracingSpan üst bilgi kümesine seri hale getirmek için uygulamaya özgü bir yöntem sağlar.
parseTraceparentHeader(string)	Bir https://www.w3.org/TR/trace-context/#traceparent-header bir <xref:TracingSpanContext> ayrıştırmak için uygulamaya özgü bir yöntem sağlar. Bu yöntem, üst öğe olmayan aralıkları birbirine bağlamak için kullanılabilir.
startSpan(string, InstrumenterSpanOptions)	Verilen ad ve seçeneklerle yeni bir TracingSpan oluşturur ve bunu yeni bir bağlama ayarlar.
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.

Yöntem Ayrıntıları

createRequestHeaders(TracingContext)

bir TracingSpan üst bilgi kümesine seri hale getirmek için uygulamaya özgü bir yöntem sağlar.

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

Parametreler

tracingContext

TracingContext

Serileştirmek için yayılma alanı içeren bağlam.

Döndürülenler

Record<string, string>

parseTraceparentHeader(string)

Bir https://www.w3.org/TR/trace-context/#traceparent-header bir <xref:TracingSpanContext> ayrıştırmak için uygulamaya özgü bir yöntem sağlar. Bu yöntem, üst öğe olmayan aralıkları birbirine bağlamak için kullanılabilir.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

Parametreler

traceparentHeader

string

Döndürülenler

undefined | TracingContext

startSpan(string, InstrumenterSpanOptions)

Verilen ad ve seçeneklerle yeni bir TracingSpan oluşturur ve bunu yeni bir bağlama ayarlar.

function startSpan(name: string, spanOptions: InstrumenterSpanOptions): { span: TracingSpan, tracingContext: TracingContext }

Parametreler

name

string

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

spanOptions

InstrumenterSpanOptions

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

Döndürülenler

{ span: TracingSpan, tracingContext: TracingContext }

TracingSpan, yayılma süresini ve bu yayılma alanının ayarlandığı bağlamı sonlandırmak için kullanılabilir.

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.

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>