Zum Hauptinhalt springen
Das AppSignal-Paket für Python enthält ein Selbstdiagnose-Tool, mit dem sich die Installation und Konfiguration Ihrer AppSignal-Integration debuggen lässt. Es gehört zu den ersten Tools, deren Ausführung unser Support-Team bei der Fehlersuche anfordert.

​
Der Diagnosebericht

Sie können dieses Diagnose-Tool verwenden, um Ihre AppSignal-Installation zu testen und 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 kann und mit den AppSignal-Servern kommunizieren kann. Dieses Diagnose-Tool erfasst und gibt Folgendes aus:
  • Informationen über das AppSignal-Paket.
  • Informationen über das Host-System und Python.
  • Ob der AppSignal-Agent auf dem Host-System laufen kann.
  • 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.
  • Ob die erforderlichen Systempfade existieren, beschreibbar sind und welcher Benutzer und welche Gruppe Eigentümer sind.
  • Kleine Teile vom Ende der verfügbaren Logdateien.
Weitere Informationen zur Verwendung des Diagnose-Befehls finden Sie in unserer Debugging-Dokumentation.

​
Den Bericht einreichen

Nachdem der Bericht erstellt wurde, werden Sie aufgefordert, ihn an unsere Server zu senden. Wenn Sie diese Aufforderung bestätigen, wird der Bericht an unsere Server gesendet und Sie erhalten einen Support-Token. Wenn Sie uns diesen Support-Token zusenden, prüfen wir den Bericht und helfen Ihnen, das Problem zu debuggen. Da das Kopieren und Einfügen der Berichtsausgabe in der Regel die Formatierung zerstört und das Lesen erschwert, wird der Bericht im JSON-Format an unsere Server gesendet. Nach dem Senden des Berichts an unsere Server wird in der Diagnose-Ausgabe ein Link zur Webansicht des Berichts ausgegeben. Diese Webansicht zeigt auch alle Validierungsprobleme und Warnungen an, die unser System erkannt hat.

​
Verwendung

Führen Sie in der Befehlszeile in Ihrem Projekt aus: 
python -m appsignal diagnose
Wenn Sie ein Problem in der Produktion haben und den Bericht an AppSignal-Support senden müssen, können Sie den folgenden Befehl ausführen, um den Bericht zu erstellen und an unsere Server zu senden: 
python -m appsignal diagnose --send-report

​
Optionen

OptionVerwendungBeschreibung
[no]-send-report--[no-]send-reportBericht automatisch senden oder nicht senden.

​
Flag zum Einreichen des Berichts

Mit dem Flag --send-report lässt sich der Bericht automatisch senden, ohne dass eine Bestätigung erforderlich ist. Das erleichtert die Nutzung in nicht-interaktiven Umgebungen. Um die Diagnose auszuführen und die Berichtsdaten an AppSignal zu senden, führen Sie den folgenden Befehl aus: 
python -m appsignal diagnose --send-report
Um die Diagnose auszuführen, ohne die Berichtsdaten an AppSignal zu senden, führen Sie den folgenden Befehl aus: 
python -m appsignal diagnose --no-send-report

​
Format der Konfigurationsausgabe

​
Format der Konfigurationsoptionswerte

Die Konfigurationsoptionen werden in der CLI als deren inspizierte Werte ausgegeben. Das bedeutet, dass wir sie so ausgeben, wie Python sie in einer Konsole ausgeben würde.
  • Zeichenkettenwerte werden mit doppelten Anführungszeichen ausgegeben, z. B. "My app name".
  • Boolesche Werte werden als Rohwerte ausgegeben: True und False.
  • Array-Werte werden als Sammlung von Werten in eckigen Klammern ausgegeben, z. B. ["accept", "accept-charset"].
    • Leere Arrays werden als zwei eckige Klammern ausgegeben: [].

​
Konfigurationsquellen

Der Konfigurationsabschnitt zeigt auch die Herkunft der Werte der Konfigurationsoptionen an, was dabei hilft, Quellen zu identifizieren, die in anderen Konfigurationsquellen definierte Werte überschreiben. Weitere Informationen zu Konfigurationsquellen, deren Ladereihenfolge und Priorität finden Sie in der Dokumentation zur Konfigurations-Ladereihenfolge. Die Konfigurationsoptionen werden basierend auf der Quelle ihrer Werte und der Anzahl der Quellen, die sie setzen, angezeigt, wie im folgenden Beispiel:
Shell
Configuration
  # Option with a value loaded only from the default source
  send_params: True

  # Option with one source
  # A different source than the default source
  name: "My app name" (Loaded from file)

  # Option with multiple sources
  # Listed in order of priority (highest priority last)
  active: True
    Sources:
      default: False
      file:    False
      env:     True