Builder class
Generador para configurar el agente 365 con seguimiento de OpenTelemetry
Métodos
| build() | Compila e inicializa la configuración del Agente 365. |
| shutdown() | Cierra el SDK de OpenTelemetry. |
| start() | Inicia el SDK de OpenTelemetry |
| with |
Configura la categoría de clúster para el exportador del Agente 365 |
| with |
Configura el proveedor de configuración para ObservabilityConfiguration. Cuando se establece, el generador usa este proveedor y sus componentes internos en lugar del proveedor predeterminado que lee de las variables de entorno. |
| with |
Establece una implementación de registrador personalizada para el SDK de observabilidad |
| with |
Proporcione un conjunto parcial de Agent365ExporterOptions. Se combinarán con valores predeterminados y cualquier clúster configurado explícitamenteCategory/tokenResolver. |
| with |
Configura el nombre y la versión del servicio para la telemetría. |
| with |
Configura el espacio de nombres del servicio para la telemetría (atributo de recurso service.namespace) |
| with |
Configura la resolución de tokens para el exportador del Agente 365 |
Detalles del método
build()
Compila e inicializa la configuración del Agente 365.
function build(): boolean
Devoluciones
boolean
La instancia de NodeSDK configurada
shutdown()
Cierra el SDK de OpenTelemetry.
function shutdown(): Promise<void>
Devoluciones
Promise<void>
start()
Inicia el SDK de OpenTelemetry
function start()
withClusterCategory(ClusterCategory)
Configura la categoría de clúster para el exportador del Agente 365
function withClusterCategory(clusterCategory: ClusterCategory): ObservabilityBuilder
Parámetros
- clusterCategory
- ClusterCategory
Categoría del clúster (por ejemplo, "preprod", "prod")
Devoluciones
Instancia del generador para el encadenamiento de métodos
withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)
Configura el proveedor de configuración para ObservabilityConfiguration. Cuando se establece, el generador usa este proveedor y sus componentes internos en lugar del proveedor predeterminado que lee de las variables de entorno.
function withConfigurationProvider(configProvider: IConfigurationProvider<ObservabilityConfiguration>): ObservabilityBuilder
Parámetros
- configProvider
Proveedor de configuración
Devoluciones
Instancia del generador para el encadenamiento de métodos
withCustomLogger(ILogger)
Establece una implementación de registrador personalizada para el SDK de observabilidad
function withCustomLogger(customLogger: ILogger): ObservabilityBuilder
Parámetros
- customLogger
- ILogger
La implementación del registrador personalizado (debe implementar la interfaz ILogger)
Devoluciones
Instancia del generador para el encadenamiento de métodos
Ejemplo 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>)
Proporcione un conjunto parcial de Agent365ExporterOptions. Se combinarán con valores predeterminados y cualquier clúster configurado explícitamenteCategory/tokenResolver.
function withExporterOptions(exporterOptions: Partial<Agent365ExporterOptions>): ObservabilityBuilder
Parámetros
- exporterOptions
-
Partial<Agent365ExporterOptions>
Opciones de exportador parcial
Devoluciones
Instancia del generador para encadenar
withService(string, string)
Configura el nombre y la versión del servicio para la telemetría.
function withService(serviceName: string, serviceVersion?: string): ObservabilityBuilder
Parámetros
- serviceName
-
string
Nombre del servicio
- serviceVersion
-
string
La versión del servicio
Devoluciones
Instancia del generador para el encadenamiento de métodos
withServiceNamespace(string)
Configura el espacio de nombres del servicio para la telemetría (atributo de recurso service.namespace)
function withServiceNamespace(serviceNamespace: string): ObservabilityBuilder
Parámetros
- serviceNamespace
-
string
El espacio de nombres del servicio
Devoluciones
Instancia del generador para el encadenamiento de métodos
withTokenResolver(TokenResolver)
Configura la resolución de tokens para el exportador del Agente 365
function withTokenResolver(tokenResolver: TokenResolver): ObservabilityBuilder
Parámetros
- tokenResolver
-
TokenResolver
Función para resolver tokens de autenticación
Devoluciones
Instancia del generador para el encadenamiento de métodos