Builder class

Pakke:

@microsoft/agents-a365-observability

Generator til konfiguration af Agent 365 med OpenTelemetry-sporing

Metoder

build()	Opretter og initialiserer Agent 365-konfigurationen
shutdown()	Lukker OpenTelemetry SDK
start()	Starter OpenTelemetry SDK
withClusterCategory(ClusterCategory)	Konfigurerer klyngekategorien for Agent 365-eksportøren
withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)	Konfigurerer konfigurationsprovideren for ObservabilityConfiguration. Når den er angivet, bruges denne provider af generatoren og dens interne komponenter i stedet for den standardudbyder, der læser fra miljøvariabler.
withCustomLogger(ILogger)	Angiver en brugerdefineret logføringsimplementering for OBSERVABILITY SDK
withExporterOptions(Partial<Agent365ExporterOptions>)	Angiv et delvist sæt Agent365ExporterOptions. Disse flettes med standarder og alle eksplicit konfigurerede clusterCategory/tokenResolver.
withService(string, string)	Konfigurerer tjenestenavnet og -versionen for telemetri
withServiceNamespace(string)	Konfigurerer tjenestens navneområde for telemetri (tjeneste.namespace-ressourceattribut)
withTokenResolver(TokenResolver)	Konfigurerer tokenreklaratoren for Agent 365-eksportøren

Oplysninger om metode

build()

Opretter og initialiserer Agent 365-konfigurationen

function build(): boolean

Returnerer

boolean

Den konfigurerede NodeSDK-forekomst

shutdown()

Lukker OpenTelemetry SDK

function shutdown(): Promise<void>

Returnerer

Promise<void>

start()

Starter OpenTelemetry SDK

function start()

withClusterCategory(ClusterCategory)

Konfigurerer klyngekategorien for Agent 365-eksportøren

function withClusterCategory(clusterCategory: ClusterCategory): ObservabilityBuilder

Parametre

clusterCategory

ClusterCategory

Klyngekategorien (f.eks. "preprod", "prod")

Returnerer

Builder

Generatorforekomsten for metodekæde

withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)

Konfigurerer konfigurationsprovideren for ObservabilityConfiguration. Når den er angivet, bruges denne provider af generatoren og dens interne komponenter i stedet for den standardudbyder, der læser fra miljøvariabler.

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

Parametre

configProvider

IConfigurationProvider<ObservabilityConfiguration>

Konfigurationsprovideren

Returnerer

Builder

Generatorforekomsten for metodekæde

withCustomLogger(ILogger)

Angiver en brugerdefineret logføringsimplementering for OBSERVABILITY SDK

function withCustomLogger(customLogger: ILogger): ObservabilityBuilder

Parametre

customLogger

ILogger

Den brugerdefinerede logføringsimplementering (skal implementere ILogger-grænsefladen)

Returnerer

Builder

Generatorforekomsten for metodekæde

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

Angiv et delvist sæt Agent365ExporterOptions. Disse flettes med standarder og alle eksplicit konfigurerede clusterCategory/tokenResolver.

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

Parametre

exporterOptions

Partial<Agent365ExporterOptions>

Indstillinger for delvis eksport

Returnerer

Builder

Generatorforekomsten til sammenkædning

withService(string, string)

Konfigurerer tjenestenavnet og -versionen for telemetri

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

Parametre

serviceName

string

Tjenestenavnet

serviceVersion

string

Tjenesteversionen

Returnerer

Builder

Generatorforekomsten for metodekæde

withServiceNamespace(string)

Konfigurerer tjenestens navneområde for telemetri (tjeneste.namespace-ressourceattribut)

function withServiceNamespace(serviceNamespace: string): ObservabilityBuilder

Parametre

serviceNamespace

string

Navneområdet for tjenesten

Returnerer

Builder

Generatorforekomsten for metodekæde

withTokenResolver(TokenResolver)

Konfigurerer tokenreklaratoren for Agent 365-eksportøren

function withTokenResolver(tokenResolver: TokenResolver): ObservabilityBuilder

Parametre

tokenResolver

TokenResolver

Funktion til løsning af godkendelsestokens

Returnerer

Builder

Generatorforekomsten for metodekæde