Builder class

Generatore per la configurazione dell'agente 365 con la traccia OpenTelemetry

Metodi

build()

Compila e inizializza la configurazione di Agent 365

shutdown()

Arresta OpenTelemetry SDK

start()

Avvia OpenTelemetry SDK

withClusterCategory(ClusterCategory)

Configura la categoria di cluster per l'utilità di esportazione di Agent 365

withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)

Configura il provider di configurazione per ObservabilityConfiguration. Se impostato, questo provider viene usato dal generatore e dai relativi componenti interni anziché dal provider predefinito che legge dalle variabili di ambiente.

withCustomLogger(ILogger)

Imposta un'implementazione del logger personalizzata per l'SDK di osservabilità

withExporterOptions(Partial<Agent365ExporterOptions>)

Specificare un set parziale di Agent365ExporterOptions. Questi verranno uniti con le impostazioni predefinite ed eventuali cluster configurati in modo esplicitoCategory/tokenResolver.

withService(string, string)

Configura il nome e la versione del servizio per i dati di telemetria

withServiceNamespace(string)

Configura lo spazio dei nomi del servizio per i dati di telemetria (attributo della risorsa service.namespace)

withTokenResolver(TokenResolver)

Configura il sistema di risoluzione dei token per l'utilità di esportazione di Agent 365

Dettagli metodo

build()

Compila e inizializza la configurazione di Agent 365

function build(): boolean

Valori restituiti

boolean

Istanza di NodeSDK configurata

shutdown()

Arresta OpenTelemetry SDK

function shutdown(): Promise<void>

Valori restituiti

Promise<void>

start()

Avvia OpenTelemetry SDK

function start()

withClusterCategory(ClusterCategory)

Configura la categoria di cluster per l'utilità di esportazione di Agent 365

function withClusterCategory(clusterCategory: ClusterCategory): ObservabilityBuilder

Parametri

clusterCategory
ClusterCategory

Categoria di cluster (ad esempio, "preprod", "prod")

Valori restituiti

Istanza del generatore per il concatenamento dei metodi

withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)

Configura il provider di configurazione per ObservabilityConfiguration. Se impostato, questo provider viene usato dal generatore e dai relativi componenti interni anziché dal provider predefinito che legge dalle variabili di ambiente.

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

Parametri

configProvider

IConfigurationProvider<ObservabilityConfiguration>

Provider di configurazione

Valori restituiti

Istanza del generatore per il concatenamento dei metodi

withCustomLogger(ILogger)

Imposta un'implementazione del logger personalizzata per l'SDK di osservabilità

function withCustomLogger(customLogger: ILogger): ObservabilityBuilder

Parametri

customLogger
ILogger

Implementazione del logger personalizzata (deve implementare l'interfaccia ILogger)

Valori restituiti

Istanza del generatore per il concatenamento dei metodi

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

Specificare un set parziale di Agent365ExporterOptions. Questi verranno uniti con le impostazioni predefinite ed eventuali cluster configurati in modo esplicitoCategory/tokenResolver.

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

Parametri

exporterOptions

Partial<Agent365ExporterOptions>

Opzioni di esportazione parziale

Valori restituiti

Istanza del generatore per il concatenamento

withService(string, string)

Configura il nome e la versione del servizio per i dati di telemetria

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

Parametri

serviceName

string

Nome del servizio

serviceVersion

string

Versione del servizio

Valori restituiti

Istanza del generatore per il concatenamento dei metodi

withServiceNamespace(string)

Configura lo spazio dei nomi del servizio per i dati di telemetria (attributo della risorsa service.namespace)

function withServiceNamespace(serviceNamespace: string): ObservabilityBuilder

Parametri

serviceNamespace

string

Spazio dei nomi del servizio

Valori restituiti

Istanza del generatore per il concatenamento dei metodi

withTokenResolver(TokenResolver)

Configura il sistema di risoluzione dei token per l'utilità di esportazione di Agent 365

function withTokenResolver(tokenResolver: TokenResolver): ObservabilityBuilder

Parametri

tokenResolver

TokenResolver

Funzione per risolvere i token di autenticazione

Valori restituiti

Istanza del generatore per il concatenamento dei metodi