> ## Documentation Index
> Fetch the complete documentation index at: https://docs.appsignal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AppSignal pour Node.js : outil de diagnostic

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](/appsignal/how-appsignal-operates#extension) et l'[agent](/appsignal/how-appsignal-operates#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][debugging].

## 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](mailto:support@appsignal.com), 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 :

<CodeGroup>
  ```bash Bash theme={null}
  npx @appsignal/cli diagnose
  ```
</CodeGroup>

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` :

<CodeGroup>
  ```bash Bash theme={null}
  npx @appsignal/cli diagnose --api-key="<PUSH API KEY HERE>"
  ```
</CodeGroup>

Vous pouvez également définir la variable d'environnement au moment de l'exécution :

<CodeGroup>
  ```bash Bash theme={null}
  APPSIGNAL_PUSH_API_KEY="<PUSH API KEY HERE>" npx @appsignal/cli diagnose
  ```
</CodeGroup>

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 :

<CodeGroup>
  ```bash Bash theme={null}
  npx @appsignal/cli diagnose --environment=production --send-report --api-key="<PUSH API KEY HERE>"
  ```
</CodeGroup>

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

| Option                                               | Description                                                                                 |
| ---------------------------------------------------- | ------------------------------------------------------------------------------------------- |
| [`--environment=<environment>`](#environment-option) | Définit l'environnement à utiliser dans la commande, par exemple `production` ou `staging`. |
| `--api-key`                                          | Définit la clé d'API à utiliser.                                                            |
| [`--[no-]send-report`](#report-submission-option)    | Envoyer automatiquement, ou ne pas envoyer le rapport.                                      |

### Option environment

Définit l'environnement d'application qu'AppSignal doit charger dans la CLI diagnose.

<CodeGroup>
  ```bash Bash theme={null}
  npx @appsignal/cli diagnose --environment=production
  ```
</CodeGroup>

### Option de soumission du rapport

Les options pour [soumettre le rapport](#submitting-the-report) immédiatement, ou non, ont été ajoutées au package AppSignal Node.js version `1.2.5`.

Soumettre le rapport à AppSignal :

<CodeGroup>
  ```bash Bash theme={null}
  npx @appsignal/cli diagnose --send-report
  ```
</CodeGroup>

Ne pas soumettre le rapport à AppSignal :

<CodeGroup>
  ```bash Bash theme={null}
  npx @appsignal/cli diagnose --no-send-report
  ```
</CodeGroup>

## 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`.

[debugging]: /support/debugging.html