OpenTelemetryScope class

الحزمة:

@microsoft/agents-a365-observability

الفئة الأساسية لنطاقات تتبع OpenTelemetry

الأساليب

dispose()	أسلوب التخلص القديم للتوافق
getSpanContext()	الحصول على سياق النطاق لهذا النطاق. يمكن استخدام هذا لإنشاء ParentSpanRef لربط أصل-تابع صريح عبر الحدود غير المتزامنة.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	تسجيل أزواج متعددة من مفاتيح/قيم السمات لتعقب بيانات تتبع الاستخدام.
recordCancellation(string)	تسجيل حدث إلغاء على النطاق. تعيين حالة النطاق إلى ERROR مع سبب الإلغاء ووضع علامة على نوع الخطأ على أنه "TaskCanceledException".
recordError(Error)	تسجيل خطأ حدث أثناء العملية
setEndTime(TimeInput)	تعيين وقت انتهاء مخصص للنطاق. عند التعيين، سيمرر التخلص هذه القيمة إلى span.end() بدلا من استخدام وقت ساعة الحائط الحالي. وهذا مفيد عندما يكون وقت الانتهاء الفعلي للعملية معروفا قبل التخلص من النطاق.
withActiveSpanAsync<T>(() => Promise<T>)	جعل هذا النطاق نشطا طوال مدة تنفيذ رد الاتصال غير المتزامن

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

dispose()

أسلوب التخلص القديم للتوافق

function dispose()

getSpanContext()

الحصول على سياق النطاق لهذا النطاق. يمكن استخدام هذا لإنشاء ParentSpanRef لربط أصل-تابع صريح عبر الحدود غير المتزامنة.

function getSpanContext(): SpanContext

المرتجعات

SpanContext

SpanContext الذي يحتوي على traceId و spanId

recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

تسجيل أزواج متعددة من مفاتيح/قيم السمات لتعقب بيانات تتبع الاستخدام.

function recordAttributes(attributes: undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

المعلمات

attributes

undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>

مجموعة أزواج مفتاح/قيمة السمة (صفيف أو قابل للكرر من [مفتاح أو قيمة] أو مخطط كائن).

recordCancellation(string)

تسجيل حدث إلغاء على النطاق. تعيين حالة النطاق إلى ERROR مع سبب الإلغاء ووضع علامة على نوع الخطأ على أنه "TaskCanceledException".

function recordCancellation(reason?: string)

المعلمات

reason

string

سبب الإلغاء الاختياري. الإعدادات الافتراضية ل "تم إلغاء المهمة".

recordError(Error)

تسجيل خطأ حدث أثناء العملية

function recordError(error: Error)

المعلمات

error

Error

الخطأ الذي حدث

setEndTime(TimeInput)

تعيين وقت انتهاء مخصص للنطاق. عند التعيين، سيمرر التخلص هذه القيمة إلى span.end() بدلا من استخدام وقت ساعة الحائط الحالي. وهذا مفيد عندما يكون وقت الانتهاء الفعلي للعملية معروفا قبل التخلص من النطاق.

function setEndTime(endTime: TimeInput)

المعلمات

endTime

TimeInput

وقت الانتهاء بالمللي ثانية منذ فترة أو تاريخ أو مجموعة HrTime.

withActiveSpanAsync<T>(() => Promise<T>)

جعل هذا النطاق نشطا طوال مدة تنفيذ رد الاتصال غير المتزامن

function withActiveSpanAsync<T>(callback: () => Promise<T>): Promise<T>

المعلمات

callback

() => Promise<T>

المرتجعات

Promise<T>