Zum Hauptinhalt springen
Das AppSignal Ruby-Gem enthält ein Selbstdiagnose-Tool, mit dem Sie die Installation und Konfiguration Ihrer AppSignal-Integration debuggen können. Es ist eines der ersten Tools, dessen Ausführung unser Support-Team beim Debuggen eines Problems empfiehlt.

​
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 und mit den AppSignal-Servern kommunizieren kann. Dieses Diagnose-Tool sammelt und gibt Folgendes aus:
  • Informationen über das AppSignal-Gem.
  • Informationen über das Hostsystem und Ruby.
  • Ob die AppSignal-Extension und der Agent auf dem Hostsystem ausgeführt werden können.
  • Alle konfigurierten Konfigurationsoptionen (einschließlich Standardwerten).
  • Ob die Konfiguration gültig und aktiv ist.
  • Ob der Push API-Schlüssel vorhanden und gültig ist (Internetverbindung erforderlich).
  • Aus welcher Quelle die Werte der Konfigurationsoptionen stammen.
  • Ob die benötigten Systempfade existieren, beschreibbar sind und welcher Benutzer und welche Gruppe Eigentümer sind.
  • Kleine Teile vom Ende der verfügbaren Log-Dateien.
Mehr darüber, wie Sie den Diagnose-Befehl verwenden, erfahren Sie in unserer Debugging-Dokumentation.

​
Bericht einreichen

Ab Gem-Version 2.2.0 und höher werden Sie aufgefordert, den Bericht an AppSignal zu senden. Wenn Sie zustimmen, wird der Bericht an unsere Server gesendet und Sie erhalten ein Support-Token. Wenn Sie dieses Support-Token an uns senden, prüfen wir den Bericht und helfen Ihnen, das Problem zu debuggen. Wir haben festgestellt, dass das Kopieren der Berichtsausgabe normalerweise die Formatierung verliert und die Lesbarkeit erschwert, weshalb der Bericht im JSON-Format an unsere Server gesendet wird. In Gem-Version 2.8.0 wurde die Option hinzugefügt, den Bericht selbst auf AppSignal.com einzusehen. Ein Link zum Bericht wird in der Ausgabe der Diagnose ausgegeben. Diese Webansicht zeigt auch alle Validierungsprobleme und Warnungen an, die unser System erkannt hat.

​
Verwendung

Führen Sie auf der Kommandozeile in Ihrem Projekt aus: 
appsignal diagnose
Wenn Sie ein Problem in der Produktion haben und den Bericht zur Unterstützung an AppSignal senden müssen, können Sie den folgenden Befehl ausführen, um den Bericht zu erstellen und an unsere Server zu senden: 
bundle exec appsignal diagnose --environment=production --send-report

​
Optionen

OptionBeschreibung
--environment=<environment>Legt die im Befehl zu verwendende Umgebung fest, z. B. production oder staging.
--[no-]send-reportBericht automatisch senden oder nicht senden.
--[no-]colorSchaltet die Einfärbung der Ausgabe um.

​
Environment-Option

Um eine bestimmte Umgebung mit der CLI auszuwählen, führen Sie den folgenden Befehl aus: 
appsignal diagnose --environment=production
Die Environment-Option ist nützlich, wenn es keine Standardumgebung gibt (Nicht-Rails-Apps und Apps, die mit einer Konfigurationsdatei konfiguriert sind) oder die Standardumgebung nicht die ist, die Sie diagnostizieren möchten. Das Diagnose-Tool warnt Sie, wenn keine Umgebung ausgewählt ist.

​
Option zur Berichtseinreichung

Die Optionen, den Bericht sofort zu senden oder nicht, wurden in der AppSignal-Gem-Version 2.8.0 hinzugefügt. Wenn Sie mit diesen Optionen auswählen, ob der Bericht gesendet wird oder nicht, wird diese Frage nicht mehr gestellt, was die Verwendung in nicht-interaktiven Umgebungen vereinfacht. Um die Diagnose auszuführen und die Berichtsdaten an AppSignal zu übermitteln, führen Sie den folgenden Befehl aus: 
appsignal diagnose --send-report
Um die Diagnose auszuführen, ohne die Berichtsdaten an AppSignal zu senden, führen Sie den folgenden Befehl aus: 
appsignal diagnose --no-send-report

​
Format der Konfigurationsausgabe

​
Format der Werte der Konfigurationsoptionen

Die Konfigurationsoptionen werden in der CLI als ihre inspizierten Werte ausgegeben. Das bedeutet, dass wir sie so ausgeben, wie Ruby es in einer Konsole tun würde.
  • String-Werte werden mit doppelten Anführungszeichen ausgegeben, z. B. "My app name".
  • Boolean-Werte werden als ihre Rohwerte ausgegeben: true und false.
  • Array-Werte werden als eine Sammlung von Werten in eckigen Klammern ausgegeben, z. B. ["HTTP_ACCEPT", "HTTP_ACCEPT_CHARSET"].
    • Leere Arrays werden als zwei eckige Klammern ausgegeben: [].
  • Nil-Werte werden als nil ausgegeben.

​
Konfigurationsquellen

Der Konfigurationsabschnitt zeigt auch den Ursprung der Werte der Konfigurationsoptionen, was helfen kann, Quellen zu identifizieren, die in anderen Konfigurationsquellen definierte Werte überschreiben. Mehr über Konfigurationsquellen, deren Ladereihenfolge und Priorität erfahren Sie in der Dokumentation zur Ladereihenfolge der Konfiguration. 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