Builder class

Paket:

@microsoft/agents-a365-observability

Builder för att konfigurera Agent 365 med OpenTelemetry-spårning

Metoder

build()	Skapar och initierar Agent 365-konfigurationen
shutdown()	Stänger av OpenTelemetry SDK
start()	Startar OpenTelemetry SDK
withClusterCategory(ClusterCategory)	Konfigurerar klusterkategorin för Agent 365-exportör
withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)	Konfigurerar konfigurationsprovidern för ObservabilityConfiguration. När den här providern anges används den av byggaren och dess interna komponenter i stället för standardprovidern som läser från miljövariabler.
withCustomLogger(ILogger)	Anger en anpassad loggningsimplementering för observerbarhets-SDK
withExporterOptions(Partial<Agent365ExporterOptions>)	Ange en partiell uppsättning Agent365ExporterOptions. Dessa sammanfogas med standardvärden och alla explicit konfigurerade klusterKategori/tokenResolver.
withService(string, string)	Konfigurerar tjänstnamnet och versionen för telemetri
withServiceNamespace(string)	Konfigurerar tjänstnamnområdet för telemetri (resursattributet service.namespace)
withTokenResolver(TokenResolver)	Konfigurerar tokenlösaren för Agent 365-exportör

Metodinformation

build()

Skapar och initierar Agent 365-konfigurationen

function build(): boolean

Returer

boolean

Den konfigurerade NodeSDK-instansen

shutdown()

Stänger av OpenTelemetry SDK

function shutdown(): Promise<void>

Returer

Promise<void>

start()

Startar OpenTelemetry SDK

function start()

withClusterCategory(ClusterCategory)

Konfigurerar klusterkategorin för Agent 365-exportör

function withClusterCategory(clusterCategory: ClusterCategory): ObservabilityBuilder

Parametrar

clusterCategory

ClusterCategory

Klusterkategorin (t.ex. "preprod", "prod")

Returer

Builder

Builder-instansen för metodlänkning

withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)

Konfigurerar konfigurationsprovidern för ObservabilityConfiguration. När den här providern anges används den av byggaren och dess interna komponenter i stället för standardprovidern som läser från miljövariabler.

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

Parametrar

configProvider

IConfigurationProvider<ObservabilityConfiguration>

Konfigurationsprovidern

Returer

Builder

Builder-instansen för metodlänkning

withCustomLogger(ILogger)

Anger en anpassad loggningsimplementering för observerbarhets-SDK

function withCustomLogger(customLogger: ILogger): ObservabilityBuilder

Parametrar

customLogger

ILogger

Implementeringen av anpassad loggning (måste implementera ILogger-gränssnittet)

Returer

Builder

Builder-instansen för metodlänkning

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

Ange en partiell uppsättning Agent365ExporterOptions. Dessa sammanfogas med standardvärden och alla explicit konfigurerade klusterKategori/tokenResolver.

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

Parametrar

exporterOptions

Partial<Agent365ExporterOptions>

Alternativ för partiell exportör

Returer

Builder

Builder-instansen för länkning

withService(string, string)

Konfigurerar tjänstnamnet och versionen för telemetri

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

Parametrar

serviceName

string

Tjänstnamnet

serviceVersion

string

Tjänstversionen

Returer

Builder

Builder-instansen för metodlänkning

withServiceNamespace(string)

Konfigurerar tjänstnamnområdet för telemetri (resursattributet service.namespace)

function withServiceNamespace(serviceNamespace: string): ObservabilityBuilder

Parametrar

serviceNamespace

string

Tjänstens namnområde

Returer

Builder

Builder-instansen för metodlänkning

withTokenResolver(TokenResolver)

Konfigurerar tokenlösaren för Agent 365-exportör

function withTokenResolver(tokenResolver: TokenResolver): ObservabilityBuilder

Parametrar

tokenResolver

TokenResolver

Funktion för att lösa autentiseringstoken

Returer

Builder

Builder-instansen för metodlänkning