Builder class
Générateur de configuration de l’agent 365 avec le suivi OpenTelemetry
Méthodes
| build() | Génère et initialise la configuration agent 365 |
| shutdown() | Arrête le Kit de développement logiciel (SDK) OpenTelemetry |
| start() | Démarre le Kit de développement logiciel (SDK) OpenTelemetry |
| with |
Configure la catégorie de cluster pour l’exportateur Agent 365 |
| with |
Configure le fournisseur de configuration pour ObservabilityConfiguration. Lorsqu’il est défini, ce fournisseur est utilisé par le générateur et ses composants internes au lieu du fournisseur par défaut qui lit à partir de variables d’environnement. |
| with |
Définit une implémentation d’enregistreur d’événements personnalisée pour le Kit de développement logiciel (SDK) observabilité |
| with |
Fournissez un ensemble partiel d’Agent365ExporterOptions. Ceux-ci sont fusionnés avec les valeurs par défaut et tous les clusterCategory/tokenResolver explicitement configurés. |
| with |
Configure le nom et la version du service pour la télémétrie |
| with |
Configure l’espace de noms de service pour la télémétrie (attribut de ressource service.namespace) |
| with |
Configure le programme de résolution de jetons pour l’exportateur Agent 365 |
Détails de la méthode
build()
Génère et initialise la configuration agent 365
function build(): boolean
Retours
boolean
Instance NodeSDK configurée
shutdown()
Arrête le Kit de développement logiciel (SDK) OpenTelemetry
function shutdown(): Promise<void>
Retours
Promise<void>
start()
Démarre le Kit de développement logiciel (SDK) OpenTelemetry
function start()
withClusterCategory(ClusterCategory)
Configure la catégorie de cluster pour l’exportateur Agent 365
function withClusterCategory(clusterCategory: ClusterCategory): ObservabilityBuilder
Paramètres
- clusterCategory
- ClusterCategory
Catégorie de cluster (par exemple, « preprod », « prod »)
Retours
Instance du générateur pour le chaînage de méthodes
withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)
Configure le fournisseur de configuration pour ObservabilityConfiguration. Lorsqu’il est défini, ce fournisseur est utilisé par le générateur et ses composants internes au lieu du fournisseur par défaut qui lit à partir de variables d’environnement.
function withConfigurationProvider(configProvider: IConfigurationProvider<ObservabilityConfiguration>): ObservabilityBuilder
Paramètres
- configProvider
Fournisseur de configuration
Retours
Instance du générateur pour le chaînage de méthodes
withCustomLogger(ILogger)
Définit une implémentation d’enregistreur d’événements personnalisée pour le Kit de développement logiciel (SDK) observabilité
function withCustomLogger(customLogger: ILogger): ObservabilityBuilder
Paramètres
- customLogger
- ILogger
Implémentation de l’enregistreur d’événements personnalisé (doit implémenter l’interface ILogger)
Retours
Instance du générateur pour le chaînage de méthodes
Exemple avec 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>)
Fournissez un ensemble partiel d’Agent365ExporterOptions. Ceux-ci sont fusionnés avec les valeurs par défaut et tous les clusterCategory/tokenResolver explicitement configurés.
function withExporterOptions(exporterOptions: Partial<Agent365ExporterOptions>): ObservabilityBuilder
Paramètres
- exporterOptions
-
Partial<Agent365ExporterOptions>
Options d’exportation partielle
Retours
Instance du générateur pour le chaînage
withService(string, string)
Configure le nom et la version du service pour la télémétrie
function withService(serviceName: string, serviceVersion?: string): ObservabilityBuilder
Paramètres
- serviceName
-
string
Nom du service
- serviceVersion
-
string
Version du service
Retours
Instance du générateur pour le chaînage de méthodes
withServiceNamespace(string)
Configure l’espace de noms de service pour la télémétrie (attribut de ressource service.namespace)
function withServiceNamespace(serviceNamespace: string): ObservabilityBuilder
Paramètres
- serviceNamespace
-
string
Espace de noms de service
Retours
Instance du générateur pour le chaînage de méthodes
withTokenResolver(TokenResolver)
Configure le programme de résolution de jetons pour l’exportateur Agent 365
function withTokenResolver(tokenResolver: TokenResolver): ObservabilityBuilder
Paramètres
- tokenResolver
-
TokenResolver
Fonction pour résoudre les jetons d’authentification
Retours
Instance du générateur pour le chaînage de méthodes