Incidents - AppSignal Documentation

Mit der CLI können Sie Incidents bearbeiten, ohne die Web-UI zu öffnen. Sie können Incidents aller Typen oder nach Typ auflisten, sie nach Zustand, Namespace oder Aktion eingrenzen, die Details eines einzelnen Incidents öffnen, dessen Zustand, Schweregrad oder Benachrichtigungshäufigkeit aktualisieren und die Notizen dazu verwalten. Jeder incidents-Befehl richtet sich an eine Anwendung, die entweder über Name und Umgebung (--app "MyApp" --environment production) oder über ID (--app-id <APP_ID>, die lange hexadezimale App-ID aus appsignal-cli apps list) identifiziert wird. Das Flag --environment wird nur benötigt, wenn mehrere Apps denselben Namen teilen. Fügen Sie --org hinzu, um Ihre Standard-Organisation zu überschreiben. Siehe Apps und Organisationen dazu, wie Apps identifiziert werden.

Incidents auflisten

Um aktuelle Incidents aller Typen für eine App aufzulisten:

Shell

appsignal-cli incidents list --app "MyApp" --environment production --limit 5

Standardmäßig geben die List-Befehle die 10 jüngsten Incidents zurück, sortiert nach der neuesten Aktivität.

Nach Typ auflisten

Drei Befehle grenzen die Ergebnisse auf einen einzigen Incident-Typ ein:

Shell

# Exception incidents
appsignal-cli incidents list-exceptions --app "MyApp" --environment production

# Performance traces
appsignal-cli incidents list-performance --app "MyApp" --environment production

# Anomaly detection incidents
appsignal-cli incidents list-anomalies --app "MyApp" --environment production

Filtern und suchen

Die List-Befehle teilen sich einen gemeinsamen Satz von Filtern:

Flag	Beschreibung
`--state <STATE>`	Nach Zustand filtern: `OPEN`, `CLOSED` oder `WIP`
`--order <ORDER>`	Sortieren nach `LAST` (neueste Aktivität, der Standard) oder `ID` (Erstellungsreihenfolge)
`--limit <N>`	Maximale Ergebnisse (Standard: 10)
`--offset <N>`	Anzahl der zu überspringenden Ergebnisse, für Paginierung

incidents list, list-exceptions und list-performance akzeptieren außerdem:

Flag	Beschreibung
`--namespaces <list>`	Nach Namespaces filtern, kommagetrennt (z. B. `web,background`)
`--action <name>`	Nach Aktionsname filtern (z. B. `UsersController#show`)
`--query <text>`	Durchsucht Exception-Incidents nach Name oder Meldung, oder Performance-Incidents nach Aktionsname (nur `list-exceptions` und `list-performance`)

Um Timeout-Fehler zu finden:

Shell

appsignal-cli incidents list-exceptions --app "MyApp" --environment production --query "TimeoutError"

Sie können mehrere Filter in einem Befehl übergeben; sie werden gemeinsam angewendet, um die Ergebnisse einzugrenzen. Listen Sie zum Beispiel nur die offenen Exceptions im Namespace web auf:

Shell

appsignal-cli incidents list-exceptions --app "MyApp" --environment production \
  --state OPEN --namespaces web

Die List-Befehle geben aktuelle Incidents zurück, sodass ältere möglicherweise nicht erscheinen, selbst wenn sie noch offen sind. Um einen bestimmten Incident unabhängig vom Alter zu öffnen, verwenden Sie incidents show mit dessen Nummer.

Einen Incident anzeigen

Um die vollständigen Details eines einzelnen Incidents zu sehen, übergeben Sie dessen Nummer:

Shell

appsignal-cli incidents show --number 42 --app "MyApp" --environment production

Bei Exception-Incidents listet show außerdem die Fehlerursachen aus den Trace-Daten des Incidents auf. Manchmal umschließt ein Fehler einen anderen, etwa wenn ein Timeout als generischer Request-Fehler auftaucht. In diesem Fall erscheinen die zugrunde liegenden Ursachen neben der obersten Exception, sodass Sie die Grundursache finden können, ohne einen Trace in der Web-UI zu öffnen.

Einen Incident aktualisieren

Aktualisieren Sie den Zustand, den Schweregrad, die Benachrichtigungshäufigkeit, die Zuständigen oder die Beschreibung eines Incidents anhand seiner Nummer:

Shell

appsignal-cli incidents update --number 42 --app "MyApp" --environment production --state CLOSED

Flag	Beschreibung
`--state <STATE>`	Neuer Zustand: `OPEN`, `CLOSED` oder `WIP`
`--severity <SEV>`	Neuer Schweregrad: `UNTRIAGED`, `CRITICAL`, `HIGH`, `LOW`, `NONE` oder `INFORMATIONAL`
`--notification-frequency <FREQ>`	Neue Benachrichtigungshäufigkeit: `ALWAYS`, `NEVER`, `FIRST_IN_DEPLOY`, `FIRST_AFTER_CLOSE`, `NTH_IN_HOUR` oder `NTH_IN_DAY`
`--notification-threshold <N>`	Vorkommen-Nummer, die eine `NTH_IN_HOUR`- oder `NTH_IN_DAY`-Benachrichtigung auslöst
`--assign <NAMES_OR_IDS>`	Benutzernamen oder IDs, die als Zuständige hinzugefügt werden, kommagetrennt
`--assign-me`	Den Incident Ihrem authentifizierten Benutzer zuweisen
`--unassign <NAMES_OR_IDS>`	Benutzernamen oder IDs, die aus den Zuständigen entfernt werden, kommagetrennt
`--description <text>`	Neue Beschreibung

Um mehrere Incidents auf einmal zu ändern, übergeben Sie eine kommagetrennte Liste von Nummern. Bulk-Updates unterstützen derzeit nur --state:

Shell

appsignal-cli incidents update --number 41,42,43 --app "MyApp" --environment production --state CLOSED

Benachrichtigungshäufigkeit festlegen

--notification-frequency legt fest, wann AppSignal Sie über die Vorkommen eines Incidents benachrichtigt. Es verwendet dieselben Optionen wie die Benachrichtigungseinstellung in der AppSignal-UI, beschrieben unter Benachrichtigungseinstellungen:

Wert	Einstellung in der UI
`ALWAYS`	Every Occurrence
`FIRST_IN_DEPLOY`	First in Deploy (der Standard für neue Fehler-Incidents)
`FIRST_AFTER_CLOSE`	First After Close
`NEVER`	Never Notify
`NTH_IN_HOUR`	Every Nth per Hour
`NTH_IN_DAY`	Every Nth per Day

Um nur benachrichtigt zu werden, wenn ein geschlossener Incident erneut auftritt:

Shell

appsignal-cli incidents update --number 42 --app "MyApp" --environment production \
  --notification-frequency FIRST_AFTER_CLOSE

NTH_IN_HOUR und NTH_IN_DAY verwenden --notification-threshold, um festzulegen, welches Vorkommen die Benachrichtigung auslöst. Übergeben Sie es zusammen mit der Häufigkeit. Um bei jedem zehnten Vorkommen pro Tag benachrichtigt zu werden:

Shell

appsignal-cli incidents update --number 42 --app "MyApp" --environment production \
  --notification-frequency NTH_IN_DAY --notification-threshold 10

Einen Incident zuweisen

Um sich einen Incident selbst zuzuweisen, verwenden Sie --assign-me. Es wird keine Benutzer-ID benötigt:

Shell

appsignal-cli incidents update --number 42 --app "MyApp" --environment production --assign-me

Um andere Personen zuzuweisen, übergeben Sie deren Namen oder Benutzer-IDs an --assign, kommagetrennt. Eine Benutzer-ID ist eine lange hexadezimale Zeichenkette. Finden Sie Namen und IDs mit apps resources users, was Name, ID und E-Mail-Adresse jedes Benutzers auflistet:

Shell

appsignal-cli apps resources users --app "MyApp" --environment production

Übergeben Sie dann einen oder mehrere davon an --assign:

Shell

appsignal-cli incidents update --number 42 --app "MyApp" --environment production \
  --assign <NAME_OR_ID>

Um Zuständige zu entfernen, übergeben Sie deren Namen oder IDs auf dieselbe Weise an --unassign.

Notizen

Notizen halten fest, was Sie zu einem Incident herausgefunden haben, und bleiben bei ihm, sodass jeder, der den Incident als Nächstes öffnet, den Kontext hat. Sie können eine Notiz hinzufügen, die Notizen zu einem Incident auflisten und die von Ihnen verfassten bearbeiten oder entfernen.

Eine Notiz hinzufügen

Shell

appsignal-cli incidents add-note --number 42 --app "MyApp" --environment production \
  --content "Root cause identified."

Notizinhalte unterstützen Markdown, sodass eine längere Notiz Überschriften, Listen, Code und Links enthalten kann:

Shell

appsignal-cli incidents add-note --number 42 --app "MyApp" --environment production \
  --content $'## Investigation\n\n- Root cause: connection pool exhaustion\n- Fix: raised the pool limit in `database.yml`'

Die $'...'-Anführung wandelt \n in Bash und Zsh in einen echten Zeilenumbruch um. In einer Shell ohne diese Funktion übergeben Sie den Inhalt als in Anführungszeichen gesetzte mehrzeilige Zeichenkette.

Notizen auflisten

Um eine Notiz zu bearbeiten oder zu löschen, benötigen Sie deren ID. Listen Sie die Notizen eines Incidents auf, um sie zu finden, zusammen mit Autor, Quelle, Zeitstempel und ob Sie sie bearbeiten oder löschen können:

Shell

appsignal-cli incidents list-notes --number 42 --app "MyApp" --environment production

Eine Notiz aktualisieren oder löschen

Übergeben Sie die Notiz-ID aus list-notes. update-note ersetzt den Inhalt der Notiz:

Shell

appsignal-cli incidents update-note --number 42 --app "MyApp" --environment production \
  --id <NOTE_ID> --content "Root cause confirmed: connection pool exhaustion."

delete-note entfernt sie:

Shell

appsignal-cli incidents delete-note --number 42 --app "MyApp" --environment production \
  --id <NOTE_ID>

Sie können nur die Notizen aktualisieren und löschen, die Sie selbst verfasst haben. list-notes kennzeichnet dies in den Spalten CAN EDIT und CAN DELETE.

JSON-Ausgabe

Wie jeder Befehl akzeptieren auch die incidents-Befehle das globale Flag --output json (oder --format json), das maschinenlesbare Ausgabe für Skripte und KI-Agenten zurückgibt:

Shell

appsignal-cli --output json incidents list-exceptions --app "MyApp" --environment production --state OPEN

Um einen einzelnen Incident als JSON zurückzugeben, grenzen Sie ihn mit incidents show über seine Nummer ein:

Shell

appsignal-cli --output json incidents show --number 42 --app "MyApp" --environment production

Nächste Schritte

Incidents sagen Ihnen, was fehlschlägt. Um die einzelnen Traces dahinter zu sehen, rufen Sie deren Traces ab über die Incident-Nummer. Um die umgebenden Log-Zeilen zu sehen, verfolgen oder durchsuchen Sie Ihre Logs vom Terminal aus.

​Incidents auflisten

​Nach Typ auflisten

​Filtern und suchen

​Einen Incident anzeigen

​Einen Incident aktualisieren

​Benachrichtigungshäufigkeit festlegen

​Einen Incident zuweisen

​Notizen

​Eine Notiz hinzufügen

​Notizen auflisten

​Eine Notiz aktualisieren oder löschen

​JSON-Ausgabe

​Nächste Schritte

Incidents auflisten

Nach Typ auflisten

Filtern und suchen

Einen Incident anzeigen

Einen Incident aktualisieren

Benachrichtigungshäufigkeit festlegen

Einen Incident zuweisen

Notizen

Eine Notiz hinzufügen

Notizen auflisten

Eine Notiz aktualisieren oder löschen

JSON-Ausgabe

Nächste Schritte