Instrumenter interface

الحزمة:

@azure/core-tracing

يمثل جهازا غير محدد للتنفيذ.

الأساليب

createRequestHeaders(TracingContext)	يوفر أسلوبا خاصا بالتنفيذ لتسلسل TracingSpan إلى مجموعة من العناوين.
parseTraceparentHeader(string)	يوفر أسلوبا خاصا بالتنفيذ لتحليل https://www.w3.org/TR/trace-context/#traceparent-header في <xref:TracingSpanContext> التي يمكن استخدامها لربط الامتدادات غير الأصلية معا.
startSpan(string, InstrumenterSpanOptions)	إنشاء TracingSpan جديد بالاسم المحدد والخيارات وتعيينه في سياق جديد.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)	يلتف رد الاتصال مع سياق نشط ويستدعي رد الاتصال. اعتمادا على التنفيذ، قد يؤدي هذا إلى تعيين السياق النشط المتاح عالميا.

تفاصيل الأسلوب

createRequestHeaders(TracingContext)

يوفر أسلوبا خاصا بالتنفيذ لتسلسل TracingSpan إلى مجموعة من العناوين.

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

المعلمات

tracingContext

TracingContext

السياق الذي يحتوي على النطاق المراد تسلسله.

المرتجعات

Record<string, string>

parseTraceparentHeader(string)

يوفر أسلوبا خاصا بالتنفيذ لتحليل https://www.w3.org/TR/trace-context/#traceparent-header في <xref:TracingSpanContext> التي يمكن استخدامها لربط الامتدادات غير الأصلية معا.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

المعلمات

traceparentHeader

string

المرتجعات

undefined | TracingContext

startSpan(string, InstrumenterSpanOptions)

إنشاء TracingSpan جديد بالاسم المحدد والخيارات وتعيينه في سياق جديد.

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

المعلمات

name

string

اسم النطاق. حسب الاصطلاح، يجب أن يكون هذا ${className}.${methodName}.

spanOptions

InstrumenterSpanOptions

الخيارات التي يجب استخدامها عند إنشاء النطاق.

المرتجعات

{ span: TracingSpan, tracingContext: TracingContext }

TracingSpan التي يمكن استخدامها لإنهاء النطاق، والسياق الذي تم تعيين هذا النطاق عليه.

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

يلتف رد الاتصال مع سياق نشط ويستدعي رد الاتصال. اعتمادا على التنفيذ، قد يؤدي هذا إلى تعيين السياق النشط المتاح عالميا.

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

المعلمات

context

TracingContext

TracingContext لاستخدامها كسياق نشط في نطاق رد الاتصال.

callback

Callback

رد الاتصال الذي سيتم استدعاؤه مع تعيين السياق المحدد كسياق نشط عالميا.

callbackArgs

CallbackArgs

وسيطات رد الاتصال.

المرتجعات

ReturnType<Callback>