TracingClient interface

الحزمة:

@azure/core-tracing

يمثل عميلا يمكنه التكامل مع Instrumenter الذي تم تكوينه حاليا.

إنشاء مثيل باستخدام createTracingClient.

الأساليب

createRequestHeaders(TracingContext)	إنشاء مجموعة من رؤوس الطلبات لنشر معلومات التتبع إلى خلفية.
parseTraceparentHeader(string)	تحليل قيمة عنوان traceparent في <xref:TracingSpanContext>.
startSpan<Options>(string, Options, TracingSpanOptions)	يبدأ امتدادا معينا ولكن لا يعينه على أنه النطاق النشط. يجب إنهاء الامتداد باستخدام نهاية. في معظم الأحيان، ستحتاج إلى استخدام مع Span بدلا من ذلك.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)	يلتف رد الاتصال مع سياق نشط ويستدعي رد الاتصال. اعتمادا على التنفيذ، قد يؤدي هذا إلى تعيين السياق النشط المتاح عالميا. مفيد عندما تريد ترك حدود SDK (إجراء طلب أو رد اتصال إلى التعليمات البرمجية للمستخدم) وغير قادر على استخدام معSpan API.
withSpan<Options, Callback>(string, Options, Callback, TracingSpanOptions)	يغلف رد الاتصال في نطاق تتبع، ويستدعي رد الاتصال، ويغلق النطاق. هذه هي الواجهة الأساسية لاستخدام التتبع وستتعامل مع تسجيل الأخطاء بالإضافة إلى تعيين الحالة على النطاق. سيتم انتظار كل من الدالات المتزامنة وغير المتزامنة لتعكس نتيجة رد الاتصال على النطاق. مثل: 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"; }, );

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

createRequestHeaders(TracingContext)

إنشاء مجموعة من رؤوس الطلبات لنشر معلومات التتبع إلى خلفية.

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

المعلمات

tracingContext

TracingContext

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

المرتجعات

Record<string, string>

مجموعة الرؤوس المراد إضافتها إلى طلب.

parseTraceparentHeader(string)

تحليل قيمة عنوان traceparent في <xref:TracingSpanContext>.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

المعلمات

traceparentHeader

string

عنوان traceparent المراد تحليله.

المرتجعات

undefined | TracingContext

معرف خاص بالتنفيذ للامتداد.

startSpan<Options>(string, Options, TracingSpanOptions)

يبدأ امتدادا معينا ولكن لا يعينه على أنه النطاق النشط.

يجب إنهاء الامتداد باستخدام نهاية.

في معظم الأحيان، ستحتاج إلى استخدام مع Span بدلا من ذلك.

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

المعلمات

name

string

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

operationOptions

Options

خيارات العملية الأصلية.

spanOptions

TracingSpanOptions

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

المرتجعات

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

TracingSpan وخيارات العملية المحدثة.

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

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

مفيد عندما تريد ترك حدود SDK (إجراء طلب أو رد اتصال إلى التعليمات البرمجية للمستخدم) وغير قادر على استخدام معSpan API.

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

المعلمات

context

TracingContext

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

callback

Callback

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

callbackArgs

CallbackArgs

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

المرتجعات

ReturnType<Callback>

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

يغلف رد الاتصال في نطاق تتبع، ويستدعي رد الاتصال، ويغلق النطاق.

هذه هي الواجهة الأساسية لاستخدام التتبع وستتعامل مع تسجيل الأخطاء بالإضافة إلى تعيين الحالة على النطاق.

سيتم انتظار كل من الدالات المتزامنة وغير المتزامنة لتعكس نتيجة رد الاتصال على النطاق.

مثل:

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

المعلمات

name

string

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

operationOptions

Options

تم تمرير الخيارات الأصلية إلى الأسلوب . سيتلقى رد الاتصال هذه الخيارات مع TracingContext التي تم إنشاؤها حديثا.

callback

Callback

رد الاتصال الذي سيتم استدعاؤه بالخيارات المحدثة TracingSpan التي تم إنشاؤها حديثا.

spanOptions

TracingSpanOptions

المرتجعات

Promise<Resolved<ReturnType<Callback>>>