Builder class

الحزمة:

@microsoft/agents-a365-observability

منشئ لتكوين Agent 365 مع تتبع OpenTelemetry

الأساليب

build()	إنشاء تكوين العامل 365 وتهيئته
shutdown()	إيقاف تشغيل OpenTelemetry SDK
start()	بدء تشغيل OpenTelemetry SDK
withClusterCategory(ClusterCategory)	تكوين فئة نظام المجموعة لمصدر الوكيل 365
withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)	تكوين موفر التكوين ل ObservabilityConfiguration. عند التعيين، يتم استخدام هذا الموفر من قبل المنشئ ومكوناته الداخلية بدلا من الموفر الافتراضي الذي يقرأ من متغيرات البيئة.
withCustomLogger(ILogger)	تعيين تطبيق مسجل مخصص ل SDK القابلة للمراقبة
withExporterOptions(Partial<Agent365ExporterOptions>)	توفير مجموعة جزئية من Agent365ExporterOptions. سيتم دمج هذه مع الإعدادات الافتراضية وأي clusterCategory/tokenResolver تم تكوينه بشكل صريح.
withService(string, string)	تكوين اسم الخدمة وإصدارها لبيانات تتبع الاستخدام
withServiceNamespace(string)	تكوين مساحة اسم الخدمة للقياس عن بعد (سمة مورد service.namespace)
withTokenResolver(TokenResolver)	تكوين محلل الرمز المميز لمصدر الوكيل 365

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

build()

إنشاء تكوين العامل 365 وتهيئته

function build(): boolean

المرتجعات

boolean

مثيل NodeSDK المكون

shutdown()

إيقاف تشغيل OpenTelemetry SDK

function shutdown(): Promise<void>

المرتجعات

Promise<void>

start()

بدء تشغيل OpenTelemetry SDK

function start()

withClusterCategory(ClusterCategory)

تكوين فئة نظام المجموعة لمصدر الوكيل 365

function withClusterCategory(clusterCategory: ClusterCategory): ObservabilityBuilder

المعلمات

clusterCategory

ClusterCategory

فئة نظام المجموعة (على سبيل المثال، "preprod"، "prod")

المرتجعات

Builder

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

withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)

تكوين موفر التكوين ل ObservabilityConfiguration. عند التعيين، يتم استخدام هذا الموفر من قبل المنشئ ومكوناته الداخلية بدلا من الموفر الافتراضي الذي يقرأ من متغيرات البيئة.

function withConfigurationProvider(configProvider: IConfigurationProvider<ObservabilityConfiguration>): ObservabilityBuilder

المعلمات

configProvider

IConfigurationProvider<ObservabilityConfiguration>

موفر التكوين

المرتجعات

Builder

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

withCustomLogger(ILogger)

تعيين تطبيق مسجل مخصص ل SDK القابلة للمراقبة

function withCustomLogger(customLogger: ILogger): ObservabilityBuilder

المعلمات

customLogger

ILogger

تنفيذ المسجل المخصص (يجب تنفيذ واجهة ILogger)

المرتجعات

Builder

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

مثال على Winston:

const winstonLogger = winston.createLogger({...});
builder.withCustomLogger({
  info: (msg, ...args) => winstonLogger.info(msg, ...args),
  warn: (msg, ...args) => winstonLogger.warn(msg, ...args),
  error: (msg, ...args) => winstonLogger.error(msg, ...args)
});

withExporterOptions(Partial<Agent365ExporterOptions>)

توفير مجموعة جزئية من Agent365ExporterOptions. سيتم دمج هذه مع الإعدادات الافتراضية وأي clusterCategory/tokenResolver تم تكوينه بشكل صريح.

function withExporterOptions(exporterOptions: Partial<Agent365ExporterOptions>): ObservabilityBuilder

المعلمات

exporterOptions

Partial<Agent365ExporterOptions>

خيارات المصدر الجزئي

المرتجعات

Builder

مثيل المنشئ للتسلسل

withService(string, string)

تكوين اسم الخدمة وإصدارها لبيانات تتبع الاستخدام

function withService(serviceName: string, serviceVersion?: string): ObservabilityBuilder

المعلمات

serviceName

string

اسم الخدمة

serviceVersion

string

إصدار الخدمة

المرتجعات

Builder

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

withServiceNamespace(string)

تكوين مساحة اسم الخدمة للقياس عن بعد (سمة مورد service.namespace)

function withServiceNamespace(serviceNamespace: string): ObservabilityBuilder

المعلمات

serviceNamespace

string

مساحة اسم الخدمة

المرتجعات

Builder

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

withTokenResolver(TokenResolver)

تكوين محلل الرمز المميز لمصدر الوكيل 365

function withTokenResolver(tokenResolver: TokenResolver): ObservabilityBuilder

المعلمات

tokenResolver

TokenResolver

دالة لحل رموز المصادقة المميزة

المرتجعات

Builder

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