Builder class

Paketti:

@microsoft/agents-a365-observability

Muodostin Agent 365:n määrittämiselle OpenTelemetry-jäljitystoiminnolla

Menetelmät

build()	Luo ja alustaa Agent 365 -määrityksen
shutdown()	Sulkee OpenTelemetry SDK:n
start()	Käynnistää OpenTelemetry SDK:n
withClusterCategory(ClusterCategory)	Määrittää klusteriluokan agentille 365 viejälle
withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)	Määrittää määrityspalvelun ObservabilityConfiguration-määritystä varten. Kun asetus on määritetty, muodostin ja sen sisäiset osat käyttävät tätä palvelua sen oletuspalvelun sijaan, joka lukee ympäristömuuttujista.
withCustomLogger(ILogger)	Määrittää mukautetun lokitoiminnon toteutuksen sDK:lle
withExporterOptions(Partial<Agent365ExporterOptions>)	Anna agentti365ExporterOptions-asetuksen osittainen joukko. Ne yhdistetään oletusarvoihin ja mihin tahansa eksplisiittisesti määritettyihin klusteriluokkaan/tokenResolveriin.
withService(string, string)	Määrittää palvelun nimen ja version telemetriaa varten
withServiceNamespace(string)	Määrittää palvelun nimitilan telemetrialle (service.namespace resource attribute)
withTokenResolver(TokenResolver)	Määrittää tunnuksen ratkaisemisen agentille 365 viejälle

Menetelmän tiedot

build()

Luo ja alustaa Agent 365 -määrityksen

function build(): boolean

Palautukset

boolean

Määritetty NodeSDK-esiintymä

shutdown()

Sulkee OpenTelemetry SDK:n

function shutdown(): Promise<void>

Palautukset

Promise<void>

start()

Käynnistää OpenTelemetry SDK:n

function start()

withClusterCategory(ClusterCategory)

Määrittää klusteriluokan agentille 365 viejälle

function withClusterCategory(clusterCategory: ClusterCategory): ObservabilityBuilder

Parametrit

clusterCategory

ClusterCategory

Klusteriluokka (esim. "preprod", "prod")

Palautukset

Builder

Menetelmän ketjutuksen muodostimen esiintymä

withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)

Määrittää määrityspalvelun ObservabilityConfiguration-määritystä varten. Kun asetus on määritetty, muodostin ja sen sisäiset osat käyttävät tätä palvelua sen oletuspalvelun sijaan, joka lukee ympäristömuuttujista.

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

Parametrit

configProvider

IConfigurationProvider<ObservabilityConfiguration>

Määrityspalvelu

Palautukset

Builder

Menetelmän ketjutuksen muodostimen esiintymä

withCustomLogger(ILogger)

Määrittää mukautetun lokitoiminnon toteutuksen sDK:lle

function withCustomLogger(customLogger: ILogger): ObservabilityBuilder

Parametrit

customLogger

ILogger

Mukautetun lokitoiminnon toteutus (pitää ottaa käyttöön ILogger-liittymä)

Palautukset

Builder

Menetelmän ketjutuksen muodostimen esiintymä

Esimerkki Winstonin kanssa:

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

Anna agentti365ExporterOptions-asetuksen osittainen joukko. Ne yhdistetään oletusarvoihin ja mihin tahansa eksplisiittisesti määritettyihin klusteriluokkaan/tokenResolveriin.

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

Parametrit

exporterOptions

Partial<Agent365ExporterOptions>

Osittaisen viejän vaihtoehdot

Palautukset

Builder

Ketjutuksen muodostimen esiintymä

withService(string, string)

Määrittää palvelun nimen ja version telemetriaa varten

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

Parametrit

serviceName

string

Palvelun nimi

serviceVersion

string

Palveluversio

Palautukset

Builder

Menetelmän ketjutuksen muodostimen esiintymä

withServiceNamespace(string)

Määrittää palvelun nimitilan telemetrialle (service.namespace resource attribute)

function withServiceNamespace(serviceNamespace: string): ObservabilityBuilder

Parametrit

serviceNamespace

string

Palvelun nimitila

Palautukset

Builder

Menetelmän ketjutuksen muodostimen esiintymä

withTokenResolver(TokenResolver)

Määrittää tunnuksen ratkaisemisen agentille 365 viejälle

function withTokenResolver(tokenResolver: TokenResolver): ObservabilityBuilder

Parametrit

tokenResolver

TokenResolver

Toiminto todennustunnusten ratkaisemiseksi

Palautukset

Builder

Menetelmän ketjutuksen muodostimen esiintymä