Builder class

แพคเกจ:

@microsoft/agents-a365-observability

ตัวสร้างสําหรับการกําหนดค่า Agent 365 ด้วยการติดตาม OpenTelemetry

วิธีการ

build()	สร้างและเริ่มต้นการกําหนดค่า Agent 365
shutdown()	ปิด SDK OpenTelemetry
start()	เริ่มต้น OpenTelemetry SDK
withClusterCategory(ClusterCategory)	กําหนดค่าประเภทคลัสเตอร์สําหรับผู้ส่งออกตัวแทน 365
withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)	กําหนดค่าผู้ให้บริการการกําหนดค่าสําหรับ ObservabilityConfiguration เมื่อตั้งค่า ตัวให้บริการนี้ถูกใช้โดยตัวสร้างและคอมโพเนนต์ภายในแทนผู้ให้บริการค่าเริ่มต้นที่อ่านจากตัวแปรสภาพแวดล้อม
withCustomLogger(ILogger)	ตั้งค่าการใช้งานตัวบันทึกแบบกําหนดเองสําหรับ SDK ความสามารถในการสังเกตการณ์
withExporterOptions(Partial<Agent365ExporterOptions>)	ระบุบางส่วนของ Agent365ExporterOptions สิ่งเหล่านี้จะถูกผสานรวมกับค่าเริ่มต้นและการกําหนดค่า clusterCategory/tokenResolver อย่างชัดเจน
withService(string, string)	กําหนดค่าชื่อบริการและเวอร์ชันสําหรับการวัดและส่งข้อมูลทางไกล
withServiceNamespace(string)	กําหนดค่า namespace บริการสําหรับการวัดและส่งข้อมูลทางไกล (แอตทริบิวต์ทรัพยากร service.namespace)
withTokenResolver(TokenResolver)	กําหนดค่าตัวแก้ไขโทเค็นสําหรับตัวส่งออกตัวแทน 365

รายละเอียดวิธีการ

build()

สร้างและเริ่มต้นการกําหนดค่า Agent 365

function build(): boolean

การส่งคืน

boolean

อินสแตนซ์ NodeSDK ที่กําหนดค่าไว้

shutdown()

ปิด SDK OpenTelemetry

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)

กําหนดค่า namespace บริการสําหรับการวัดและส่งข้อมูลทางไกล (แอตทริบิวต์ทรัพยากร service.namespace)

function withServiceNamespace(serviceNamespace: string): ObservabilityBuilder

พารามิเตอร์

serviceNamespace

string

เนมสเปซบริการ

การส่งคืน

Builder

อินสแตนซ์ของตัวสร้างสําหรับการเชื่อมโยงวิธีการ

withTokenResolver(TokenResolver)

กําหนดค่าตัวแก้ไขโทเค็นสําหรับตัวส่งออกตัวแทน 365

function withTokenResolver(tokenResolver: TokenResolver): ObservabilityBuilder

พารามิเตอร์

tokenResolver

TokenResolver

ฟังก์ชันในการแก้ไขโทเค็นการรับรองความถูกต้อง

การส่งคืน

Builder

อินสแตนซ์ของตัวสร้างสําหรับการเชื่อมโยงวิธีการ