Recommandations pour le logging de l'intégration

L'agent infrastructure de New Relic fournit un SDK pour créer une intégration sur hôte. Ce document explique les exigences et les bonnes pratiques pour générer un log d'intégration.

Exigences en matière de logging

C'est à vous de décider quel type de message de log créer et quel type d'informations seront utiles pour résoudre les problèmes. Il n'y a qu'une seule exigence : l'exécutable d'intégration doit écrire le log sur l'erreur standard (stderr).

L'agent d'infrastructure capturera les lignes écrites dans l'erreur standard et les fusionnera dans le flux de logging écrit par l'agent d'infrastructure lui-même.

Pour éviter de dépendre de solutions de logging tierces, la bibliothèque de construction d'intégration Go fournit un simple log package avec le niveau de log commun.

Recommandations et bonnes pratiques

Voici les pratiques recommandées pour générer le log d’intégration :

• Par défaut, une intégration doit être « silencieuse ». Outre les données émises vers la sortie standard, il devrait y avoir très peu de messages de logging ou de diagnostic générés.
• Nous vous recommandons d'inclure un mode de logging détaillé similaire au paramètre verbose dans l'agent d'infrastructure. Inclure un commutateur de ligne de commande pour activer et désactiver le logging détaillé (par exemple, -verbose).
• Pour déboguer votre intégration pendant que l'intégration est en cours d'exécution, incluez le commutateur verbose dans le fichier de définition dans le cadre de la ligne de commande à exécuter. Cela enverra le log détaillé au infrastructure propre fichier de de l'agent log.
• À des fins de débogage générales, utilisez un indicateur qui écrit les données JSON de sortie standard sous une forme « joliment imprimée » lisible par l'homme (par exemple, --pretty). Notez que la sortie écrite sous une forme « jolie » est uniquement destinée à vos besoins de débogage et n'est pas compatible avec l'agent d'infrastructure.
• Votre intégration doit être créée de manière à pouvoir fonctionner de manière autonome. En cas de doute sur le fait que l'intégration communique avec l'agent, vous pouvez exécuter l'intégration à partir de la ligne de commande et voir si elle produit la sortie ou le message de log correct que vous attendez.

Pour plus d'informations sur le package de logging du langage Go, voir package de logging.