Builder class

Balíček:

@microsoft/agents-a365-observability

Tvůrce pro konfiguraci agenta 365 s trasováním OpenTelemetry

Metody

build()	Sestavení a inicializace konfigurace agenta 365
shutdown()	Vypne sadu OpenTelemetry SDK.
start()	Spustí sadu OpenTelemetry SDK.
withClusterCategory(ClusterCategory)	Nakonfiguruje kategorii clusteru pro vývozce agenta 365.
withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)	Nakonfiguruje zprostředkovatele konfigurace pro ObservabilityConfiguration. Při nastavení tento zprostředkovatel používá tvůrce a jeho interní komponenty místo výchozího zprostředkovatele, který čte z proměnných prostředí.
withCustomLogger(ILogger)	Nastaví vlastní implementaci protokolovacího nástroje pro sadu SDK pozorovatelnosti.
withExporterOptions(Partial<Agent365ExporterOptions>)	Zadejte částečnou sadu Agent365ExporterOptions. Tyto hodnoty se sloučí s výchozími nastaveními a všechny explicitně nakonfigurované clusterCategory/tokenResolver.
withService(string, string)	Nakonfiguruje název a verzi služby pro telemetrii.
withServiceNamespace(string)	Nakonfiguruje obor názvů služby pro telemetrii (atribut prostředku service.namespace).
withTokenResolver(TokenResolver)	Nakonfiguruje překladač tokenů pro vývozce agenta 365.

Podrobnosti metody

build()

Sestavení a inicializace konfigurace agenta 365

function build(): boolean

Návraty

boolean

Nakonfigurovaná instance NodeSDK

shutdown()

Vypne sadu OpenTelemetry SDK.

function shutdown(): Promise<void>

Návraty

Promise<void>

start()

Spustí sadu OpenTelemetry SDK.

function start()

withClusterCategory(ClusterCategory)

Nakonfiguruje kategorii clusteru pro vývozce agenta 365.

function withClusterCategory(clusterCategory: ClusterCategory): ObservabilityBuilder

Parametry

clusterCategory

ClusterCategory

Kategorie clusteru (např. "předprod", "prod")

Návraty

Builder

Instance tvůrce pro řetězení metod

withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)

Nakonfiguruje zprostředkovatele konfigurace pro ObservabilityConfiguration. Při nastavení tento zprostředkovatel používá tvůrce a jeho interní komponenty místo výchozího zprostředkovatele, který čte z proměnných prostředí.

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

Parametry

configProvider

IConfigurationProvider<ObservabilityConfiguration>

Zprostředkovatel konfigurace

Návraty

Builder

Instance tvůrce pro řetězení metod

withCustomLogger(ILogger)

Nastaví vlastní implementaci protokolovacího nástroje pro sadu SDK pozorovatelnosti.

function withCustomLogger(customLogger: ILogger): ObservabilityBuilder

Parametry

customLogger

ILogger

Vlastní implementace protokolovacího nástroje (musí implementovat rozhraní ILogger)

Návraty

Builder

Instance tvůrce pro řetězení metod

Příklad s Winstonem:

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>)

Zadejte částečnou sadu Agent365ExporterOptions. Tyto hodnoty se sloučí s výchozími nastaveními a všechny explicitně nakonfigurované clusterCategory/tokenResolver.

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

Parametry

exporterOptions

Partial<Agent365ExporterOptions>

Možnosti částečného vývozce

Návraty

Builder

Instance tvůrce pro řetězení

withService(string, string)

Nakonfiguruje název a verzi služby pro telemetrii.

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

Parametry

serviceName

string

Název služby

serviceVersion

string

Verze služby

Návraty

Builder

Instance tvůrce pro řetězení metod

withServiceNamespace(string)

Nakonfiguruje obor názvů služby pro telemetrii (atribut prostředku service.namespace).

function withServiceNamespace(serviceNamespace: string): ObservabilityBuilder

Parametry

serviceNamespace

string

Obor názvů služby

Návraty

Builder

Instance tvůrce pro řetězení metod

withTokenResolver(TokenResolver)

Nakonfiguruje překladač tokenů pro vývozce agenta 365.

function withTokenResolver(tokenResolver: TokenResolver): ObservabilityBuilder

Parametry

tokenResolver

TokenResolver

Funkce pro překlad ověřovacích tokenů

Návraty

Builder

Instance tvůrce pro řetězení metod