Builder class

使用 OpenTelemetry 跟踪配置 Agent 365 的生成器

方法

build()

生成并初始化代理 365 配置

shutdown()

关闭 OpenTelemetry SDK

start()

启动 OpenTelemetry SDK

withClusterCategory(ClusterCategory)

为代理 365 导出程序配置群集类别

withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)

配置 ObservabilityConfiguration 的配置提供程序。 设置时,生成器及其内部组件使用此提供程序,而不是从环境变量中读取的默认提供程序。

withCustomLogger(ILogger)

设置可观测性 SDK 的自定义记录器实现

withExporterOptions(Partial<Agent365ExporterOptions>)

提供一组部分 Agent365ExporterOptions。 这些属性将与默认值和任何显式配置的 clusterCategory/tokenResolver 合并。

withService(string, string)

为遥测配置服务名称和版本

withServiceNamespace(string)

为遥测配置服务命名空间(service.namespace 资源属性)

withTokenResolver(TokenResolver)

为代理 365 导出程序配置令牌解析程序

方法详细信息

build()

生成并初始化代理 365 配置

function build(): boolean

返回

boolean

配置的 NodeSDK 实例

shutdown()

关闭 OpenTelemetry SDK

function shutdown(): Promise<void>

返回

Promise<void>

start()

启动 OpenTelemetry SDK

function start()

withClusterCategory(ClusterCategory)

为代理 365 导出程序配置群集类别

function withClusterCategory(clusterCategory: ClusterCategory): ObservabilityBuilder

参数

clusterCategory
ClusterCategory

群集类别(例如“preprod”、“prod”)

返回

方法链接的生成器实例

withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)

配置 ObservabilityConfiguration 的配置提供程序。 设置时,生成器及其内部组件使用此提供程序,而不是从环境变量中读取的默认提供程序。

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

参数

configProvider

IConfigurationProvider<ObservabilityConfiguration>

配置提供程序

返回

方法链接的生成器实例

withCustomLogger(ILogger)

设置可观测性 SDK 的自定义记录器实现

function withCustomLogger(customLogger: ILogger): ObservabilityBuilder

参数

customLogger
ILogger

自定义记录器实现(必须实现 ILogger 接口)

返回

方法链接的生成器实例

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

提供一组部分 Agent365ExporterOptions。 这些属性将与默认值和任何显式配置的 clusterCategory/tokenResolver 合并。

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

参数

exporterOptions

Partial<Agent365ExporterOptions>

部分导出程序选项

返回

链接的生成器实例

withService(string, string)

为遥测配置服务名称和版本

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

参数

serviceName

string

服务名称

serviceVersion

string

服务版本

返回

方法链接的生成器实例

withServiceNamespace(string)

为遥测配置服务命名空间(service.namespace 资源属性)

function withServiceNamespace(serviceNamespace: string): ObservabilityBuilder

参数

serviceNamespace

string

服务命名空间

返回

方法链接的生成器实例

withTokenResolver(TokenResolver)

为代理 365 导出程序配置令牌解析程序

function withTokenResolver(tokenResolver: TokenResolver): ObservabilityBuilder

参数

tokenResolver

TokenResolver

用于解析身份验证令牌的函数

返回

方法链接的生成器实例