Builder class

Pakke:

@microsoft/agents-a365-observability

Builder for konfigurasjon av Agent 365 med OpenTelemetry-sporing

Metoder

build()	Bygger og initialiserer Agent 365-konfigurasjonen
shutdown()	Slår av OpenTelemetry SDK
start()	Starter OpenTelemetry SDK
withClusterCategory(ClusterCategory)	Konfigurerer klyngekategorien for Agent 365-eksportør
withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)	Konfigurerer konfigurasjonsleverandøren for ObservabilityConfiguration. Når den er angitt, brukes denne leverandøren av byggherren og dens interne komponenter i stedet for standardleverandøren som leser fra miljøvariabler.
withCustomLogger(ILogger)	Angir en egendefinert loggerimplementering for SDK for observerbarhet
withExporterOptions(Partial<Agent365ExporterOptions>)	Angi et delvis sett med Agent365ExporterOptions. Disse slås sammen med standarder og alle eksplisitt konfigurerte clusterCategory/tokenResolver.
withService(string, string)	Konfigurerer tjenestenavnet og -versjonen for telemetri
withServiceNamespace(string)	Konfigurerer tjenestenavneområdet for telemetri (service.namespace resource attribute)
withTokenResolver(TokenResolver)	Konfigurerer token resolver for Agent 365 eksportør

Metodedetaljer

build()

Bygger og initialiserer Agent 365-konfigurasjonen

function build(): boolean

Returnerer

boolean

Den konfigurerte NodeSDK-forekomsten

shutdown()

Slår av OpenTelemetry SDK

function shutdown(): Promise<void>

Returnerer

Promise<void>

start()

Starter OpenTelemetry SDK

function start()

withClusterCategory(ClusterCategory)

Konfigurerer klyngekategorien for Agent 365-eksportør

function withClusterCategory(clusterCategory: ClusterCategory): ObservabilityBuilder

Parametere

clusterCategory

ClusterCategory

Klyngekategorien (f.eks. «preprod», «prod»)

Returnerer

Builder

Utbyggerforekomsten for metodekjedering

withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)

Konfigurerer konfigurasjonsleverandøren for ObservabilityConfiguration. Når den er angitt, brukes denne leverandøren av byggherren og dens interne komponenter i stedet for standardleverandøren som leser fra miljøvariabler.

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

Parametere

configProvider

IConfigurationProvider<ObservabilityConfiguration>

Konfigurasjonsleverandøren

Returnerer

Builder

Utbyggerforekomsten for metodekjedering

withCustomLogger(ILogger)

Angir en egendefinert loggerimplementering for SDK for observerbarhet

function withCustomLogger(customLogger: ILogger): ObservabilityBuilder

Parametere

customLogger

ILogger

Den egendefinerte loggerimplementeringen (må implementere ILogger-grensesnittet)

Returnerer

Builder

Utbyggerforekomsten for metodekjedering

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

Angi et delvis sett med Agent365ExporterOptions. Disse slås sammen med standarder og alle eksplisitt konfigurerte clusterCategory/tokenResolver.

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

Parametere

exporterOptions

Partial<Agent365ExporterOptions>

Alternativer for delvis eksportør

Returnerer

Builder

Byggherreforekomsten for kjede

withService(string, string)

Konfigurerer tjenestenavnet og -versjonen for telemetri

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

Parametere

serviceName

string

Tjenestenavnet

serviceVersion

string

Tjenesteversjonen

Returnerer

Builder

Utbyggerforekomsten for metodekjedering

withServiceNamespace(string)

Konfigurerer tjenestenavneområdet for telemetri (service.namespace resource attribute)

function withServiceNamespace(serviceNamespace: string): ObservabilityBuilder

Parametere

serviceNamespace

string

Tjenestenavneområdet

Returnerer

Builder

Utbyggerforekomsten for metodekjedering

withTokenResolver(TokenResolver)

Konfigurerer token resolver for Agent 365 eksportør

function withTokenResolver(tokenResolver: TokenResolver): ObservabilityBuilder

Parametere

tokenResolver

TokenResolver

Funksjon for å løse godkjenningstokener

Returnerer

Builder

Utbyggerforekomsten for metodekjedering