Incidents - AppSignal Documentation

La CLI vous permet de traiter les incidents sans ouvrir l’interface web. Vous pouvez lister les incidents tous types confondus ou par type, les restreindre par état, namespace ou action, ouvrir les détails d’un incident, mettre à jour son état, sa sévérité ou sa fréquence de notification, et gérer les notes qui lui sont associées. Chaque commande incidents cible une application, identifiée soit par nom et environnement (--app "MyApp" --environment production), soit par ID (--app-id <APP_ID>, l’identifiant hexadécimal long de l’application obtenu via appsignal-cli apps list). Le drapeau --environment n’est nécessaire que lorsque plusieurs applications partagent le même nom. Ajoutez --org pour remplacer votre organisation par défaut. Voir Applications et organisations pour savoir comment les applications sont identifiées.

Lister les incidents

Pour lister les incidents récents de tous types pour une application :

Shell

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

Par défaut, les commandes de listage renvoient les 10 incidents les plus récents, classés par activité la plus récente.

Lister par type

Trois commandes restreignent les résultats à un seul type d’incident :

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

Filtrer et rechercher

Les commandes de listage partagent un ensemble de filtres :

Drapeau	Description
`--state <STATE>`	Filtrer par état : `OPEN`, `CLOSED` ou `WIP`
`--order <ORDER>`	Trier par `LAST` (activité la plus récente, par défaut) ou `ID` (ordre de création)
`--limit <N>`	Nombre maximum de résultats (par défaut : 10)
`--offset <N>`	Nombre de résultats à ignorer, pour la pagination

incidents list, list-exceptions et list-performance acceptent aussi :

Drapeau	Description
`--namespaces <list>`	Filtrer par namespaces, séparés par des virgules (par exemple `web,background`)
`--action <name>`	Filtrer par nom d’action (par exemple `UsersController#show`)
`--query <text>`	Recherche les incidents d’exception par nom ou message, ou les incidents de performance par nom d’action (`list-exceptions` et `list-performance` uniquement)

Pour trouver les erreurs de timeout :

Shell

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

Vous pouvez passer plusieurs filtres dans une seule commande, ils s’appliquent tous ensemble pour restreindre les résultats. Par exemple, pour lister uniquement les exceptions ouvertes dans le namespace web :

Shell

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

Les commandes de listage renvoient les incidents récents, donc les plus anciens peuvent ne pas apparaître même s’ils sont encore ouverts. Pour ouvrir un incident spécifique quel que soit son âge, utilisez incidents show avec son numéro.

Afficher un incident

Pour voir tous les détails d’un incident, passez son numéro :

Shell

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

Pour les incidents d’exception, show liste également les causes d’erreur issues des données de trace de l’incident. Parfois, une erreur en enveloppe une autre, par exemple un timeout qui apparaît comme une erreur de requête générique. Dans ce cas, les causes sous-jacentes s’affichent à côté de l’exception de premier niveau, afin que vous puissiez trouver la cause racine sans ouvrir une trace dans l’interface web.

Mettre à jour un incident

Mettez à jour l’état, la sévérité, la fréquence de notification, les assignés ou la description d’un incident par son numéro :

Shell

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

Drapeau	Description
`--state <STATE>`	Nouvel état : `OPEN`, `CLOSED` ou `WIP`
`--severity <SEV>`	Nouvelle sévérité : `UNTRIAGED`, `CRITICAL`, `HIGH`, `LOW`, `NONE` ou `INFORMATIONAL`
`--notification-frequency <FREQ>`	Nouvelle fréquence de notification : `ALWAYS`, `NEVER`, `FIRST_IN_DEPLOY`, `FIRST_AFTER_CLOSE`, `NTH_IN_HOUR` ou `NTH_IN_DAY`
`--notification-threshold <N>`	Numéro d’occurrence qui envoie une notification `NTH_IN_HOUR` ou `NTH_IN_DAY`
`--assign <NAMES_OR_IDS>`	Noms d’utilisateurs ou IDs à ajouter comme assignés, séparés par des virgules
`--assign-me`	Assigner l’incident à votre utilisateur authentifié
`--unassign <NAMES_OR_IDS>`	Noms d’utilisateurs ou IDs à retirer des assignés, séparés par des virgules
`--description <text>`	Nouvelle description

Pour modifier plusieurs incidents à la fois, passez une liste de numéros séparés par des virgules. Les mises à jour groupées prennent actuellement en charge uniquement --state :

Shell

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

Définir la fréquence de notification

--notification-frequency contrôle quand AppSignal vous notifie des occurrences d’un incident. Elle prend les mêmes options que le paramètre de notification dans l’interface AppSignal, décrit dans Paramètres de notification :

Valeur	Paramètre dans l’interface
`ALWAYS`	Every Occurrence
`FIRST_IN_DEPLOY`	First in Deploy (la valeur par défaut pour les nouveaux incidents d’erreur)
`FIRST_AFTER_CLOSE`	First After Close
`NEVER`	Never Notify
`NTH_IN_HOUR`	Every Nth per Hour
`NTH_IN_DAY`	Every Nth per Day

Pour n’être notifié que lorsqu’un incident fermé se reproduit :

Shell

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

NTH_IN_HOUR et NTH_IN_DAY utilisent --notification-threshold pour définir quelle occurrence envoie la notification. Passez-le avec la fréquence. Pour être notifié toutes les dix occurrences par jour :

Shell

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

Assigner un incident

Pour vous assigner un incident, utilisez --assign-me. Aucun ID utilisateur n’est nécessaire :

Shell

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

Pour assigner d’autres personnes, passez leurs noms ou IDs utilisateur à --assign, séparés par des virgules. Un ID utilisateur est une longue chaîne hexadécimale. Trouvez les noms et IDs avec apps resources users, qui liste le nom, l’ID et l’e-mail de chaque utilisateur :

Shell

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

Ensuite, passez-en un ou plusieurs à --assign :

Shell

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

Pour retirer des assignés, passez leurs noms ou IDs à --unassign de la même manière.

Notes

Les notes consignent ce que vous avez trouvé sur un incident et restent attachées à celui-ci, afin que quiconque ouvre l’incident par la suite dispose du contexte. Vous pouvez ajouter une note, lister les notes d’un incident, et modifier ou supprimer celles que vous avez écrites.

Ajouter une note

Shell

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

Le contenu des notes prend en charge Markdown, une note plus longue peut donc contenir des titres, des listes, du code et des liens :

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`'

Les guillemets $'...' transforment \n en un véritable saut de ligne dans Bash et Zsh. Dans un shell qui ne le prend pas en charge, passez le contenu sous forme de chaîne multiligne entre guillemets.

Lister les notes

Modifier ou supprimer une note nécessite son ID. Listez les notes d’un incident pour la trouver, avec l’auteur, la source, l’horodatage et si vous pouvez la modifier ou la supprimer :

Shell

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

Modifier ou supprimer une note

Passez l’ID de la note obtenu avec list-notes. update-note remplace le contenu de la note :

Shell

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

delete-note la supprime :

Shell

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

Vous ne pouvez modifier et supprimer que les notes que vous avez écrites. list-notes les indique dans ses colonnes CAN EDIT et CAN DELETE.

Sortie JSON

Comme toutes les commandes, les commandes incidents acceptent le drapeau global --output json (ou --format json), qui renvoie une sortie lisible par machine pour les scripts et les agents IA :

Shell

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

Pour renvoyer un seul incident au format JSON, restreignez par son numéro avec incidents show :

Shell

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

Étapes suivantes

Les incidents vous indiquent ce qui échoue. Pour voir les traces individuelles derrière l’un d’eux, récupérez ses traces par numéro d’incident. Pour voir les lignes de log environnantes, suivez ou recherchez vos logs depuis le terminal.

​Lister les incidents

​Lister par type

​Filtrer et rechercher

​Afficher un incident

​Mettre à jour un incident

​Définir la fréquence de notification

​Assigner un incident

​Notes

​Ajouter une note

​Lister les notes

​Modifier ou supprimer une note

​Sortie JSON

​Étapes suivantes

Lister les incidents

Lister par type

Filtrer et rechercher

Afficher un incident

Mettre à jour un incident

Définir la fréquence de notification

Assigner un incident

Notes

Ajouter une note

Lister les notes

Modifier ou supprimer une note

Sortie JSON

Étapes suivantes