Builder class

Pakket:

@microsoft/agents-a365-observability

Opbouwfunctie voor het configureren van Agent 365 met OpenTelemetry-tracering

Methoden

build()	De configuratie van agent 365 wordt gebouwd en geïnitialiseerd
shutdown()	Hiermee wordt de OpenTelemetry SDK afgesloten
start()	Start de OpenTelemetry SDK
withClusterCategory(ClusterCategory)	Hiermee configureert u de clustercategorie voor agent 365-exporteur
withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)	Hiermee configureert u de configuratieprovider voor ObservabilityConfiguration. Wanneer deze provider is ingesteld, wordt deze provider gebruikt door de opbouwfunctie en de bijbehorende interne onderdelen in plaats van de standaardprovider die uit omgevingsvariabelen leest.
withCustomLogger(ILogger)	Hiermee stelt u een aangepaste logboekregistratie-implementatie in voor de waarneembaarheids-SDK
withExporterOptions(Partial<Agent365ExporterOptions>)	Geef een gedeeltelijke set agent365ExporterOptions op. Deze worden samengevoegd met standaardwaarden en eventuele expliciet geconfigureerde clusterCategory/tokenResolver.
withService(string, string)	Hiermee configureert u de servicenaam en -versie voor telemetrie
withServiceNamespace(string)	Hiermee configureert u de servicenaamruimte voor telemetrie (resourcekenmerk service.namespace)
withTokenResolver(TokenResolver)	Hiermee configureert u de token-resolver voor agent 365-exporteur

Methodedetails

build()

De configuratie van agent 365 wordt gebouwd en geïnitialiseerd

function build(): boolean

Retouren

boolean

Het geconfigureerde NodeSDK-exemplaar

shutdown()

Hiermee wordt de OpenTelemetry SDK afgesloten

function shutdown(): Promise<void>

Retouren

Promise<void>

start()

Start de OpenTelemetry SDK

function start()

withClusterCategory(ClusterCategory)

Hiermee configureert u de clustercategorie voor agent 365-exporteur

function withClusterCategory(clusterCategory: ClusterCategory): ObservabilityBuilder

Parameters

clusterCategory

ClusterCategory

De clustercategorie (bijvoorbeeld 'preprod', 'prod')

Retouren

Builder

Het opbouwproces voor het koppelen van methoden

withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)

Hiermee configureert u de configuratieprovider voor ObservabilityConfiguration. Wanneer deze provider is ingesteld, wordt deze provider gebruikt door de opbouwfunctie en de bijbehorende interne onderdelen in plaats van de standaardprovider die uit omgevingsvariabelen leest.

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

Parameters

configProvider

IConfigurationProvider<ObservabilityConfiguration>

De configuratieprovider

Retouren

Builder

Het opbouwproces voor het koppelen van methoden

withCustomLogger(ILogger)

Hiermee stelt u een aangepaste logboekregistratie-implementatie in voor de waarneembaarheids-SDK

function withCustomLogger(customLogger: ILogger): ObservabilityBuilder

Parameters

customLogger

ILogger

De implementatie van de aangepaste logboekregistratie (moet ILogger-interface implementeren)

Retouren

Builder

Het opbouwproces voor het koppelen van methoden

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

Geef een gedeeltelijke set agent365ExporterOptions op. Deze worden samengevoegd met standaardwaarden en eventuele expliciet geconfigureerde clusterCategory/tokenResolver.

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

Parameters

exporterOptions

Partial<Agent365ExporterOptions>

Opties voor gedeeltelijke exporteurs

Retouren

Builder

Het opbouwexemplaren voor het koppelen

withService(string, string)

Hiermee configureert u de servicenaam en -versie voor telemetrie

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

Parameters

serviceName

string

De servicenaam

serviceVersion

string

De serviceversie

Retouren

Builder

Het opbouwproces voor het koppelen van methoden

withServiceNamespace(string)

Hiermee configureert u de servicenaamruimte voor telemetrie (resourcekenmerk service.namespace)

function withServiceNamespace(serviceNamespace: string): ObservabilityBuilder

Parameters

serviceNamespace

string

De servicenaamruimte

Retouren

Builder

Het opbouwproces voor het koppelen van methoden

withTokenResolver(TokenResolver)

Hiermee configureert u de token-resolver voor agent 365-exporteur

function withTokenResolver(tokenResolver: TokenResolver): ObservabilityBuilder

Parameters

tokenResolver

TokenResolver

Functie voor het oplossen van verificatietokens

Retouren

Builder

Het opbouwproces voor het koppelen van methoden