BaggageBuilder class

الحزمة:

@microsoft/agents-a365-observability

لكل منشئ أمتعة طلب لنشر سياق القياس المفتوح.

توفر هذه الفئة واجهة برمجة تطبيقات بطلاقة لإعداد قيم الأمتعة التي سيتم نشرها في سياق OpenTelemetry.

مثال

const scope = new BaggageBuilder()
  .tenantId("tenant-123")
  .agentId("agent-456")
  .build();

scope.enter();
// Baggage is set in this context
// ... do work ...
scope.exit();
// Baggage is restored after exiting the context

الأساليب

agentAuid(undefined | null | string)	تعيين قيمة الأمتعة AUID الوكيل.
agentBlueprintId(undefined | null | string)	تعيين قيمة الأمتعة لمعرف مخطط العامل.
agentDescription(undefined | null | string)	تعيين قيمة الأمتعة وصف العامل.
agentEmail(undefined | null | string)	تعيين قيمة الأمتعة البريد الإلكتروني للوكيل.
agentId(undefined | null | string)	تعيين قيمة الأمتعة معرف الوكيل.
agentName(undefined | null | string)	تعيين قيمة الأمتعة اسم الوكيل.
agentPlatformId(undefined | null | string)	قم بتعيين قيمة الأمتعة لمعرف النظام الأساسي للوكيل.
agentVersion(undefined | null | string)	تعيين قيمة الأمتعة إصدار العامل.
build()	تطبيق الأمتعة التي تم جمعها على السياق الحالي.
callerAgentPlatformId(undefined | null | string)	قم بتعيين قيمة الأمتعة الخاصة بحقائب النظام الأساسي لوكيل المتصل.
callerClientIp(undefined | null | string)	تعيين قيمة الأمتعة IP لعميل المتصل. يستخدم لالتقاط عنوان IP للعميل الأصلي للطلب بحيث يمكن نشره عبر الأمتعة OpenTelemetry.
channelLink(undefined | null | string)	تعيين ارتباط/عنوان URL للقناة.
channelName(undefined | null | string)	تعيين اسم القناة (على سبيل المثال، Teams، Slack).
conversationId(undefined | null | string)	تعيين قيمة الأمتعة لمعرف المحادثة.
conversationItemLink(undefined | null | string)	تعيين قيمة الأمتعة لرابط عنصر المحادثة.
invokeAgentServer(undefined | null | string, number)	تعيين عنوان خادم عامل الاستدعاء وقيم أمتعة المنفذ.
operationSource(undefined | null | string)	تعيين قيمة الأمتعة المصدر للعملية. يستخدم لامتدادات الخادم لتحديد الخدمة (على سبيل المثال، ATG، ACF).
sessionDescription(undefined | null | string)	تعيين قيمة الأمتعة لوصف الجلسة.
sessionId(string)	تعيين قيمة أمتعة معرف الجلسة.
setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)	تعيين أزواج أمتعة متعددة من قاموس أو قابلة للتكدير.
setRequestContext(null | string, null | string)	طريقة الراحة لبدء نطاق أمتعة الطلب مع الحقول المشتركة.
tenantId(undefined | null | string)	تعيين قيمة أمتعة معرف المستأجر.
userEmail(undefined | null | string)	تعيين قيمة الأمتعة البريد الإلكتروني للمستخدم.
userId(undefined | null | string)	تعيين قيمة الأمتعة لمعرف المستخدم.
userName(undefined | null | string)	تعيين قيمة الأمتعة اسم المستخدم.

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

agentAuid(undefined | null | string)

تعيين قيمة الأمتعة AUID الوكيل.

function agentAuid(value: undefined | null | string): BaggageBuilder

المعلمات

value

undefined | null | string

معرف AUID للعامل

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

agentBlueprintId(undefined | null | string)

تعيين قيمة الأمتعة لمعرف مخطط العامل.

function agentBlueprintId(value: undefined | null | string): BaggageBuilder

المعلمات

value

undefined | null | string

معرف مخطط العامل

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

agentDescription(undefined | null | string)

تعيين قيمة الأمتعة وصف العامل.

function agentDescription(value: undefined | null | string): BaggageBuilder

المعلمات

value

undefined | null | string

وصف العامل

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

agentEmail(undefined | null | string)

تعيين قيمة الأمتعة البريد الإلكتروني للوكيل.

function agentEmail(value: undefined | null | string): BaggageBuilder

المعلمات

value

undefined | null | string

البريد الإلكتروني للعامل

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

agentId(undefined | null | string)

تعيين قيمة الأمتعة معرف الوكيل.

function agentId(value: undefined | null | string): BaggageBuilder

المعلمات

value

undefined | null | string

معرف العامل

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

agentName(undefined | null | string)

تعيين قيمة الأمتعة اسم الوكيل.

function agentName(value: undefined | null | string): BaggageBuilder

المعلمات

value

undefined | null | string

اسم العامل

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

agentPlatformId(undefined | null | string)

قم بتعيين قيمة الأمتعة لمعرف النظام الأساسي للوكيل.

function agentPlatformId(value: undefined | null | string): BaggageBuilder

المعلمات

value

undefined | null | string

معرف النظام الأساسي للوكيل

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

agentVersion(undefined | null | string)

تعيين قيمة الأمتعة إصدار العامل.

function agentVersion(value: undefined | null | string): BaggageBuilder

المعلمات

value

undefined | null | string

إصدار العامل (على سبيل المثال، '1.0.0'، '2025-05-01')

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

build()

تطبيق الأمتعة التي تم جمعها على السياق الحالي.

function build(): BaggageScope

المرتجعات

BaggageScope

مدير سياق يستعيد الأمتعة السابقة عند الخروج

callerAgentPlatformId(undefined | null | string)

قم بتعيين قيمة الأمتعة الخاصة بحقائب النظام الأساسي لوكيل المتصل.

function callerAgentPlatformId(value: undefined | null | string): BaggageBuilder

المعلمات

value

undefined | null | string

معرف النظام الأساسي لعامل المتصل

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

callerClientIp(undefined | null | string)

تعيين قيمة الأمتعة IP لعميل المتصل. يستخدم لالتقاط عنوان IP للعميل الأصلي للطلب بحيث يمكن نشره عبر الأمتعة OpenTelemetry.

function callerClientIp(value: undefined | null | string): BaggageBuilder

المعلمات

value

undefined | null | string

عنوان IP لعميل المتصل

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

channelLink(undefined | null | string)

تعيين ارتباط/عنوان URL للقناة.

function channelLink(value: undefined | null | string): BaggageBuilder

المعلمات

value

undefined | null | string

ارتباط القناة

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

channelName(undefined | null | string)

تعيين اسم القناة (على سبيل المثال، Teams، Slack).

function channelName(value: undefined | null | string): BaggageBuilder

المعلمات

value

undefined | null | string

اسم القناة

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

conversationId(undefined | null | string)

تعيين قيمة الأمتعة لمعرف المحادثة.

function conversationId(value: undefined | null | string): BaggageBuilder

المعلمات

value

undefined | null | string

معرف المحادثة

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

conversationItemLink(undefined | null | string)

تعيين قيمة الأمتعة لرابط عنصر المحادثة.

function conversationItemLink(value: undefined | null | string): BaggageBuilder

المعلمات

value

undefined | null | string

ارتباط عنصر المحادثة

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

invokeAgentServer(undefined | null | string, number)

تعيين عنوان خادم عامل الاستدعاء وقيم أمتعة المنفذ.

function invokeAgentServer(address: undefined | null | string, port?: number): BaggageBuilder

المعلمات

address

undefined | null | string

عنوان الخادم (اسم المضيف) لخدمة العامل الهدف.

port

number

منفذ خادم اختياري. مسجل فقط عندما يختلف عن 443.

المرتجعات

BaggageBuilder

مثيل المنشئ الحالي لتسلسل الأسلوب.

operationSource(undefined | null | string)

تعيين قيمة الأمتعة المصدر للعملية. يستخدم لامتدادات الخادم لتحديد الخدمة (على سبيل المثال، ATG، ACF).

function operationSource(value: undefined | null | string): BaggageBuilder

المعلمات

value

undefined | null | string

مصدر العملية

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

sessionDescription(undefined | null | string)

تعيين قيمة الأمتعة لوصف الجلسة.

function sessionDescription(value: undefined | null | string): BaggageBuilder

المعلمات

value

undefined | null | string

وصف الجلسة

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

sessionId(string)

تعيين قيمة أمتعة معرف الجلسة.

function sessionId(value: string): BaggageBuilder

المعلمات

value

string

معرف الجلسة

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

setPairs(undefined | null | Record<string, any> | Iterable<[string, any]>)

تعيين أزواج أمتعة متعددة من قاموس أو قابلة للتكدير.

function setPairs(pairs: undefined | null | Record<string, any> | Iterable<[string, any]>): BaggageBuilder

المعلمات

pairs

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

قاموس أزواج قيم المفاتيح أو تكرارها

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

setRequestContext(null | string, null | string)

طريقة الراحة لبدء نطاق أمتعة الطلب مع الحقول المشتركة.

static function setRequestContext(tenantId?: null | string, agentId?: null | string): BaggageScope

المعلمات

tenantId

null | string

معرف المستأجر

agentId

null | string

معرف العامل

المرتجعات

BaggageScope

مدير سياق يستعيد الأمتعة السابقة عند الخروج

tenantId(undefined | null | string)

تعيين قيمة أمتعة معرف المستأجر.

function tenantId(value: undefined | null | string): BaggageBuilder

المعلمات

value

undefined | null | string

معرف المستأجر

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

userEmail(undefined | null | string)

تعيين قيمة الأمتعة البريد الإلكتروني للمستخدم.

function userEmail(value: undefined | null | string): BaggageBuilder

المعلمات

value

undefined | null | string

البريد الإلكتروني للمستخدم

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

userId(undefined | null | string)

تعيين قيمة الأمتعة لمعرف المستخدم.

function userId(value: undefined | null | string): BaggageBuilder

المعلمات

value

undefined | null | string

معرف المستخدم

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب

userName(undefined | null | string)

تعيين قيمة الأمتعة اسم المستخدم.

function userName(value: undefined | null | string): BaggageBuilder

المعلمات

value

undefined | null | string

اسم المستخدم

المرتجعات

BaggageBuilder

ذاتي لتسلسل الأسلوب