Passer au contenu principal
Le package AppSignal Node.js est livré avec un outil d’auto-diagnostic. Cet outil peut être utilisé pour déboguer votre installation AppSignal et c’est l’une des premières choses que notre équipe de support demande lorsqu’un problème survient.

​
Le rapport de diagnostic

Cet outil en ligne de commande est utile lors du test d’AppSignal sur un système et de la validation de la configuration locale. Il fournit des informations utiles pour déboguer les problèmes et vérifie si l’agent AppSignal peut s’exécuter sur l’architecture de la machine et communiquer avec les serveurs AppSignal. Cet outil de diagnostic collecte et fournit les éléments suivants :
  • des informations sur le package AppSignal.
  • des informations sur le système hôte et Node.js.
  • si l’extension et l’agent d’AppSignal peuvent s’exécuter sur le système hôte.
  • toutes les options de configuration configurées (y compris les valeurs par défaut).
  • si la configuration est valide et active.
  • si la clé d’API Push est présente et valide (connexion Internet requise).
  • l’origine des valeurs des options de configuration.
Pour en savoir plus sur l’utilisation de la commande diagnose, consultez la page Débogage.

​
Soumission du rapport

Vous devez passer l’option --send-report pour envoyer le rapport de diagnostic à AppSignal. Si elle est utilisée, le rapport sera envoyé à nos serveurs et vous recevrez un jeton de support. Lorsque vous nous envoyez ce jeton de support, nous examinerons le rapport et vous aiderons à déboguer le problème. Nous avons constaté que copier-coller la sortie du rapport entraîne généralement une perte de mise en forme et le rend plus difficile à lire, c’est pourquoi il est envoyé à nos serveurs au format JSON.

​
Utilisation

Sur la ligne de commande dans votre projet (un répertoire avec un package.json et @appsignal/nodejs installé), exécutez : 
npx @appsignal/cli diagnose
Au minimum, APPSIGNAL_PUSH_API_KEY doit être défini avant que la commande diagnose puisse être exécutée. Si cela n’est pas déjà défini dans votre environnement, vous pouvez également le définir au moment de l’exécution avec l’option --api-key : 
npx @appsignal/cli diagnose --api-key="<PUSH API KEY HERE>"
Vous pouvez également définir la variable d’environnement au moment de l’exécution : 
APPSIGNAL_PUSH_API_KEY="<PUSH API KEY HERE>" npx @appsignal/cli diagnose
Pour exécuter le diagnostic sur votre serveur de production et envoyer le rapport à AppSignal à des fins de support, vous pouvez exécuter la commande suivante : 
npx @appsignal/cli diagnose --environment=production --send-report --api-key="<PUSH API KEY HERE>"
L’option environment est utile lorsque l’environnement par défaut n’est pas celui que vous souhaitez diagnostiquer. L’outil diagnose vous avertira lorsqu’aucun environnement n’est sélectionné.

​
Options

OptionDescription
--environment=<environment>Définit l’environnement à utiliser dans la commande, par exemple production ou staging.
--api-keyDéfinit la clé d’API à utiliser.
--[no-]send-reportEnvoyer automatiquement, ou ne pas envoyer le rapport.

​
Option environment

Définit l’environnement d’application qu’AppSignal doit charger dans la CLI diagnose. 
npx @appsignal/cli diagnose --environment=production

​
Option de soumission du rapport

Les options pour soumettre le rapport immédiatement, ou non, ont été ajoutées au package AppSignal Node.js version 1.2.5. Soumettre le rapport à AppSignal : 
npx @appsignal/cli diagnose --send-report
Ne pas soumettre le rapport à AppSignal : 
npx @appsignal/cli diagnose --no-send-report

​
Format de sortie de la configuration

​
Format des valeurs des options de configuration

Les options de configuration sont affichées dans la CLI sous forme de leurs valeurs inspectées. Cela signifie que nous les affichons comme Node.js le ferait dans une console.
  • Les valeurs de chaînes sont affichées entre guillemets doubles, par exemple "My app name".
  • Les valeurs booléennes sont affichées sous leur forme brute : true et false.
  • Les valeurs de tableau sont affichées comme une collection de valeurs entourée de crochets, par exemple ["HTTP_ACCEPT", "HTTP_ACCEPT_CHARSET"].
    • Les tableaux vides sont affichés sous forme de deux crochets : [].
  • Les valeurs null ou undefined sont affichées comme null ou undefined.