OutputScope class

الحزمة:

@microsoft/agents-a365-observability

يوفر نطاق تتبع OpenTelemetry لتتبع رسائل الإخراج مع ارتباط الامتداد الأصل.

يمتد

OpenTelemetryScope

الأساليب

recordOutputMessages(ResponseMessagesParam)	تسجيل رسائل الإخراج لتعقب بيانات تتبع الاستخدام. الكتابة فوق أي رسائل إخراج مسجلة مسبقا على النطاق. يقبل سلسلة واحدة، أو صفيف من السلاسل (ملفوف تلقائيا ك OTEL OutputMessage)، أو برنامج تضمين OutputMessages تم إصداره، أو إملاء أولي (يتم التعامل معه كنتيجة استدعاء أداة لكل مواصفات OTEL، يتم تسلسله مباشرة).
start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)	إنشاء نطاق جديد لتعقب رسائل الإخراج وبدء تشغيله.

الأساليب المتوارثة

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>)	جعل هذا النطاق نشطا طوال مدة تنفيذ رد الاتصال غير المتزامن

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

recordOutputMessages(ResponseMessagesParam)

تسجيل رسائل الإخراج لتعقب بيانات تتبع الاستخدام. الكتابة فوق أي رسائل إخراج مسجلة مسبقا على النطاق. يقبل سلسلة واحدة، أو صفيف من السلاسل (ملفوف تلقائيا ك OTEL OutputMessage)، أو برنامج تضمين OutputMessages تم إصداره، أو إملاء أولي (يتم التعامل معه كنتيجة استدعاء أداة لكل مواصفات OTEL، يتم تسلسله مباشرة).

function recordOutputMessages(messages: ResponseMessagesParam)

المعلمات

messages

ResponseMessagesParam

سلسلة أو صفيف من السلاسل أو برنامج تضمين OutputMessages أو إملاء.

start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)

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

static function start(request: Request, response: OutputResponse, agentDetails: AgentDetails, userDetails?: UserDetails, spanDetails?: SpanDetails): OutputScope

المعلمات

request

Request

حمولة الطلب (القناة ومعرف المحادثة والمحتوى ومعرف الجلسة).

response

OutputResponse

الاستجابة التي تحتوي على رسائل الإخراج الأولية.

agentDetails

AgentDetails

العامل الذي ينتج الإخراج. معرف المستأجر مشتق من agentDetails.tenantId.

userDetails

UserDetails

تفاصيل هوية المتصل البشري الاختيارية.

spanDetails

SpanDetails

تكوين النطاق الاختياري (parentContext، startTime، endTime، spanLinks).

المرتجعات

OutputScope

مثيل OutputScope جديد.

تفاصيل الأساليب المتوارثة

dispose()

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

function dispose()

موروث منOpenTelemetryScope.dispose

getSpanContext()

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

function getSpanContext(): SpanContext

المرتجعات

SpanContext

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

موروث منOpenTelemetryScope.getSpanContext

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>

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

موروث منOpenTelemetryScope.recordAttributes

recordCancellation(string)

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

function recordCancellation(reason?: string)

المعلمات

reason

string

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

موروث منOpenTelemetryScope.recordCancellation

recordError(Error)

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

function recordError(error: Error)

المعلمات

error

Error

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

موروث منOpenTelemetryScope.recordError

setEndTime(TimeInput)

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

function setEndTime(endTime: TimeInput)

المعلمات

endTime

TimeInput

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

موروث منOpenTelemetryScope.setEndTime

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

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

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

المعلمات

callback

() => Promise<T>

المرتجعات

Promise<T>

موروث منOpenTelemetryScope.withActiveSpanAsync