Builder class

Pacote:

@microsoft/agents-a365-observability

Construtor para configurar o Agente 365 com rastreamento OpenTelemetry

Métodos

build()	Compila e inicializa a configuração do Agent 365
shutdown()	Desliga o SDK do OpenTelemetry
start()	Inicia o SDK do OpenTelemetry
withClusterCategory(ClusterCategory)	Configura a categoria de cluster para o exportador do Agente 365
withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)	Configura o provedor de configuração para ObservabilityConfiguration. Quando definido, esse provedor é usado pelo construtor e seus componentes internos em vez do provedor padrão que lê de variáveis de ambiente.
withCustomLogger(ILogger)	Define uma implementação de agente personalizado para o SDK de observabilidade
withExporterOptions(Partial<Agent365ExporterOptions>)	Forneça um conjunto parcial de Agent365ExporterOptions. Elas serão mescladas com padrões e qualquer clusterCategory/tokenResolver explicitamente configurado.
withService(string, string)	Configura o nome do serviço e a versão para telemetria
withServiceNamespace(string)	Configura o namespace de serviço para telemetria (atributo de recurso service.namespace)
withTokenResolver(TokenResolver)	Configura o resolvedor de token para o exportador do Agente 365

Detalhes do método

build()

Compila e inicializa a configuração do Agent 365

function build(): boolean

Retornos

boolean

A instância do NodeSDK configurada

shutdown()

Desliga o SDK do OpenTelemetry

function shutdown(): Promise<void>

Retornos

Promise<void>

start()

Inicia o SDK do OpenTelemetry

function start()

withClusterCategory(ClusterCategory)

Configura a categoria de cluster para o exportador do Agente 365

function withClusterCategory(clusterCategory: ClusterCategory): ObservabilityBuilder

Parâmetros

clusterCategory

ClusterCategory

A categoria de cluster (por exemplo, "preprod", "prod")

Retornos

Builder

A instância do construtor para encadeamento de métodos

withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)

Configura o provedor de configuração para ObservabilityConfiguration. Quando definido, esse provedor é usado pelo construtor e seus componentes internos em vez do provedor padrão que lê de variáveis de ambiente.

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

Parâmetros

configProvider

IConfigurationProvider<ObservabilityConfiguration>

O provedor de configuração

Retornos

Builder

A instância do construtor para encadeamento de métodos

withCustomLogger(ILogger)

Define uma implementação de agente personalizado para o SDK de observabilidade

function withCustomLogger(customLogger: ILogger): ObservabilityBuilder

Parâmetros

customLogger

ILogger

A implementação do agente personalizado (deve implementar a interface ILogger)

Retornos

Builder

A instância do construtor para encadeamento de métodos

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

Forneça um conjunto parcial de Agent365ExporterOptions. Elas serão mescladas com padrões e qualquer clusterCategory/tokenResolver explicitamente configurado.

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

Parâmetros

exporterOptions

Partial<Agent365ExporterOptions>

Opções parciais do exportador

Retornos

Builder

A instância do construtor para encadeamento

withService(string, string)

Configura o nome do serviço e a versão para telemetria

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

Parâmetros

serviceName

string

O nome do serviço

serviceVersion

string

A versão do serviço

Retornos

Builder

A instância do construtor para encadeamento de métodos

withServiceNamespace(string)

Configura o namespace de serviço para telemetria (atributo de recurso service.namespace)

function withServiceNamespace(serviceNamespace: string): ObservabilityBuilder

Parâmetros

serviceNamespace

string

O namespace do serviço

Retornos

Builder

A instância do construtor para encadeamento de métodos

withTokenResolver(TokenResolver)

Configura o resolvedor de token para o exportador do Agente 365

function withTokenResolver(tokenResolver: TokenResolver): ObservabilityBuilder

Parâmetros

tokenResolver

TokenResolver

Função para resolver tokens de autenticação

Retornos

Builder

A instância do construtor para encadeamento de métodos