Skip to main content
Die dashboards-Befehle listen die Dashboards einer App auf, erstellen und aktualisieren sie, und zeigen, fügen hinzu und aktualisieren die Charts darauf. Jeder Befehl zielt auf eine Anwendung, nach Name und Umgebung (--app "MyApp" --environment production) oder nach ID (--app-id <APP_ID>, die lange hexadezimale App-ID aus appsignal-cli apps list). Das Flag --environment wird nur benötigt, wenn mehrere Apps einen Namen teilen. Jeder Befehl verwendet Ihre Standard-Organisation, sofern Sie nicht --org übergeben. Siehe Apps und Organisationen für die Identifizierung von Apps.

Dashboards auflisten

Shell
Die Liste enthält die ID jedes Dashboards, die Sie benötigen, um eines zu aktualisieren.

Ein Dashboard anzeigen

Um die Details eines Dashboards und seine Charts zu sehen, übergeben Sie die --id des Dashboards:
Shell
Die Ausgabe listet jedes Chart mit seiner ID, seinem Typ und seinen Einstellungen auf. Sie benötigen die ID eines Charts, um es zu aktualisieren. Mit --output json stehen die Charts in dashboard.visuals, jeweils mit seiner id, seinem Typ in __typename und seinen Einstellungen. add-visual und update-visual liefern dieselbe Struktur zurück.

Ein Dashboard erstellen

Ein neues Dashboard benötigt einen Titel und eine Beschreibung:
Shell

Ein Dashboard aktualisieren

Übergeben Sie die --id des Dashboards (aus dashboards list) zusammen mit dem neuen Titel:
Shell
--title ist auch dann erforderlich, wenn Sie nur die Beschreibung ändern.

Ein Chart hinzufügen

Sie beschreiben ein Chart in einer JSON-Datei und fügen es dann mit add-visual hinzu. Angenommen, Sie betreiben einen Online-Shop. Ihr Checkout health-Dashboard sollte zwei Fragen beantworten: Ist der Checkout langsam, und schlägt er fehl? Um zu sehen, wie langsam der Checkout für Ihre langsamsten Kunden ist, stellen Sie die 95. Perzentil-Antwortzeit im Zeitverlauf als Chart dar. Das ist ein timeseries-Chart. Speichern Sie es als checkout-speed.json:
checkout-speed.json
Fügen Sie es dann dem Dashboard hinzu:
Shell
Um zu sehen, wie oft der Checkout fehlschlägt, fügen Sie eine Big-Number-Kachel mit der Gesamtzahl der Fehler im ausgewählten Zeitraum hinzu. Das ist ein number-Chart, das eine einzelne metric verwendet. Der Metrikname und die Tags dürfen keinen Platzhalter (*) enthalten, da das Chart eine einzelne Serie zeigt. Speichern Sie es als checkout-errors.json:
checkout-errors.json
Shell
Ersetzen Sie CheckoutsController#create durch die Action, die den Checkout in Ihrer App verarbeitet. Jedes neue Chart benötigt ein nicht leeres title und description. Um das JSON von der Standardeingabe statt aus einer Datei zu lesen, übergeben Sie --file -.
Die CLI wiederholt eine fehlgeschlagene Chart-Erstellung nicht automatisch. Wenn add-visual mit einem Netzwerkfehler fehlschlägt, prüfen Sie das Dashboard mit dashboards show, bevor Sie es erneut versuchen. So fügen Sie das Chart nicht doppelt hinzu.

Ein Chart aktualisieren

Um ein Chart zu ändern, übergeben Sie nur die Einstellungen, die Sie ändern möchten. Alles andere bleibt unverändert. Um zum Beispiel die Checkout-Antwortzeit als Flächen-Chart darzustellen, holen Sie sich die ID des Charts aus dashboards show und führen Sie aus:
Shell
update-visual verwendet dieselben App-Flags wie add-visual, plus: Bei einigen Einstellungen ist mehr Sorgfalt nötig:
  • Listen und Objekte werden vollständig ersetzt. Um auch den Payment-Schritt darzustellen, übergeben Sie metrics mit sowohl der Checkout-Metrik als auch der neuen. Um ein Chart zu verschieben, übergeben Sie alle vier layout-Werte.
  • Um eine Einstellung zu leeren, setzen Sie sie auf null. Dies funktioniert für description, formatInput, layout, lineLabel, minYAxis und die metric eines Number-Charts. format kann nicht geleert werden, setzen Sie stattdessen ein anderes Format.
  • Um alle Metriken eines Timeseries-Charts zu entfernen, übergeben Sie "metrics": [].
  • Wenn Sie format von size weg ändern, wird auch formatInput geleert.
Ein Chart behält seinen Typ, Sie können also kein Timeseries-Chart in ein Number-Chart umwandeln. Ein Update ohne Einstellungen wird abgelehnt.

Chart-Einstellungen

Das Chart-JSON verwendet camelCase-Schlüssel und enthält ausschließlich Einstellungen. Die Dashboard-ID, die Chart-ID und der Chart-Typ werden in den Befehls-Flags angegeben. Unbekannte Schlüssel, ungültige Werte und Einstellungen für den jeweils anderen Chart-Typ führen zu einem Fehler. Diese Einstellungen akzeptieren einen festen Satz von Werten:

Nächste Schritte

Ein Dashboard visualisiert Ihre Metriken. Um benachrichtigt zu werden, wenn eine einen Schwellenwert überschreitet, richten Sie Anomaly-Detection-Triggers ein.