Zum Hauptinhalt springen
Das AppSignal Node.js-Paket wird mit einem Selbstdiagnose-Tool ausgeliefert. Dieses Tool kann verwendet werden, um Ihre AppSignal-Installation zu debuggen, und ist eines der ersten Dinge, nach denen unser Support-Team fragt, wenn ein Problem auftritt.

​
Der Diagnosebericht

Dieses Kommandozeilen-Tool ist nützlich, um AppSignal auf einem System zu testen und die lokale Konfiguration zu validieren. Es gibt nützliche Informationen zur Fehlersuche aus und prüft, ob der AppSignal-Agent auf der Architektur des Rechners ausgeführt werden und mit den AppSignal-Servern kommunizieren kann. Dieses Diagnose-Tool sammelt und gibt Folgendes aus:
  • Informationen über das AppSignal-Paket.
  • Informationen über das Host-System und Node.js.
  • ob die AppSignal-Extension und der Agent auf dem Host-System ausgeführt werden können.
  • alle konfigurierten Konfigurationsoptionen (einschließlich Standardwerte).
  • ob die Konfiguration gültig und aktiv ist.
  • ob der Push-API-Schlüssel vorhanden und gültig ist (Internetverbindung erforderlich).
  • woher die Werte der Konfigurationsoptionen stammen.
Weitere Informationen zur Verwendung des Diagnosebefehls finden Sie auf der Seite Debugging.

​
Einreichen des Berichts

Sie müssen die Option --send-report übergeben, um den Diagnosebericht an AppSignal zu senden. Bei Verwendung wird der Bericht an unsere Server gesendet und Sie erhalten ein Support-Token. Wenn Sie uns dieses Support-Token senden, prüfen wir den Bericht und helfen Ihnen, das Problem zu debuggen. Wir haben festgestellt, dass beim Kopieren und Einfügen der Berichtsausgabe normalerweise die Formatierung verloren geht, was die Lesbarkeit erschwert. Daher wird der Bericht im JSON-Format an unsere Server gesendet.

​
Verwendung

Führen Sie in der Kommandozeile Ihres Projekts (ein Verzeichnis mit einer package.json und installiertem @appsignal/nodejs) Folgendes aus: 
npx @appsignal/cli diagnose
Zumindest muss APPSIGNAL_PUSH_API_KEY gesetzt sein, bevor der Diagnosebefehl ausgeführt werden kann. Falls dies in Ihrer Umgebung noch nicht gesetzt ist, können Sie es auch zur Laufzeit mit der Option --api-key setzen: 
npx @appsignal/cli diagnose --api-key="<PUSH API KEY HERE>"
Sie können die Umgebungsvariable auch zur Laufzeit setzen: 
APPSIGNAL_PUSH_API_KEY="<PUSH API KEY HERE>" npx @appsignal/cli diagnose
Um die Diagnose auf Ihrem Produktionsserver auszuführen und den Bericht zu Support-Zwecken an AppSignal zu senden, können Sie den folgenden Befehl ausführen: 
npx @appsignal/cli diagnose --environment=production --send-report --api-key="<PUSH API KEY HERE>"
Die Umgebungsoption ist nützlich, wenn die Standardumgebung nicht diejenige ist, die Sie diagnostizieren möchten. Das Diagnose-Tool warnt Sie, wenn keine Umgebung ausgewählt ist.

​
Optionen

OptionBeschreibung
--environment=<environment>Legen Sie die im Befehl zu verwendende Umgebung fest, z. B. production oder staging.
--api-keyDefinieren Sie, welcher API-Schlüssel verwendet werden soll.
--[no-]send-reportBericht automatisch senden oder nicht senden.

​
Umgebungsoption

Definieren Sie, welche App-Umgebung AppSignal im Diagnose-CLI laden soll. 
npx @appsignal/cli diagnose --environment=production

​
Option zum Einreichen des Berichts

Die Optionen, den Bericht sofort einzureichen oder nicht, wurden in Version 1.2.5 des AppSignal Node.js-Pakets hinzugefügt. Bericht an AppSignal senden: 
npx @appsignal/cli diagnose --send-report
Bericht nicht an AppSignal senden: 
npx @appsignal/cli diagnose --no-send-report

​
Format der Konfigurationsausgabe

​
Format der Werte von Konfigurationsoptionen

Die Konfigurationsoptionen werden als ihre inspizierten Werte im CLI ausgegeben. Das bedeutet, wir geben sie so aus, wie Node.js sie in einer Konsole ausgeben würde.
  • Zeichenketten-Werte werden mit doppelten Anführungszeichen ausgegeben, z. B. "My app name".
  • Boolesche Werte werden als ihre rohen Werte ausgegeben: true und false.
  • Array-Werte werden als Sammlung von Werten in eckigen Klammern ausgegeben, z. B. ["HTTP_ACCEPT", "HTTP_ACCEPT_CHARSET"].
    • Leere Arrays werden als zwei eckige Klammern ausgegeben: [].
  • Null- oder undefinierte Werte werden als null oder undefined ausgegeben.