Aller au contenu

Notifications incident.io

Aperçu

incident.io reçoit les notifications d’Apprise sous forme d’alertes. Une alerte peut ensuite prévenir la personne d’astreinte ou ouvrir un incident, selon les règles de routage d’alertes configurées dans incident.io.

  1. Connectez-vous à incident.io, ouvrez Alerts, puis allez dans Sources.
  2. Créez une nouvelle source d’alertes et choisissez HTTP.
  3. incident.io vous affiche une URL et un jeton secret. L’URL ressemble à https://api.incident.io/v2/alert_events/http/01GW2G3V0S59R238FAHPDS1R66. L’identifiant à la fin est l’ID de votre source d’alertes.

Vous pouvez aussi coller cette URL telle quelle dans Apprise, à condition d’y ajouter votre jeton avec ?token=.

La syntaxe valide est la suivante :

  • incidentio://{source_id}/{token}
  • incidentio://{source_id}/{token}?action=resolve&dedup={key}
  • https://api.incident.io/v2/alert_events/http/{source_id}?token={token}
Variable Requis Description
source_id Oui L’identifiant à la fin de l’URL fournie par incident.io pour votre source d’alertes HTTP.
token Oui Le jeton secret fourni par incident.io pour votre source d’alertes HTTP.
action Non Ce qu’il faut faire de l’alerte. Les valeurs possibles sont map, trigger et resolve. map résout l’alerte quand le type de notification est success et déclenche une alerte pour tous les autres types. trigger déclenche une nouvelle alerte à chaque fois, même si le titre se répète, et resolve la résout toujours. La valeur par défaut est map.
dedup Non Une clé de déduplication. Les alertes envoyées avec la même clé mettent à jour la même alerte ouverte au lieu d’en créer une nouvelle, et une résolution la ferme. Sans cette clé, map et resolve utilisent le titre (ou la première ligne du message s’il n’y a pas de titre) comme clé : une notification success résout donc l’alerte qu’une notification failure avec le même titre a déclenchée, tandis que trigger déclenche une nouvelle alerte à chaque fois.
click Non Un lien vers l’endroit d’où provient l’alerte. incident.io l’affiche sur l’alerte.
+key Non Ajoute des détails à l’alerte, par exemple +service=web. Votre source d’alertes doit être configurée pour lire ces détails avant qu’incident.io ne les utilise.
Variable Description
overflow Gère les messages qui dépassent la limite documentée d’un service. La valeur par défaut est upstream.
👉 upstream : envoie un seul message sans le découper ni le tronquer selon cette limite.
👉 truncate : conserve la partie qui tient dans la limite et supprime le reste.
👉 split : privilégie une coupure lisible, utilise une coupure stricte si nécessaire, puis envoie toutes les parties dans l’ordre.
Le découpage d’un contenu non déclaré ou structuré reste une solution au mieux. Utilisez upstream si le corps doit rester intact.
format Ce paramètre peut être défini sur text, html ou markdown. Certains services prennent en charge plusieurs formats de publication du contenu. La valeur par défaut varie selon le service choisi et peut correspondre à l’un de ces trois formats. Vous pouvez facultativement forcer cette option pour vous écarter du comportement par défaut. Si le service ne prend pas en charge plusieurs formats de transmission, ce champ est ignoré.
verify Les requêtes externes vers des emplacements sécurisés, par exemple via https, utilisent des certificats. Par défaut, Apprise vérifie la validité de ces certificats ; si ce n’est pas le cas, aucune notification n’est envoyée à la source. Dans certains cas, un utilisateur ne dispose pas d’une autorité de certification pour valider la clé ou fait simplement confiance à la source ; dans ce cas, vous pouvez définir ce drapeau sur no. Par défaut, il vaut yes.
redirect Par défaut, Apprise suit les redirections HTTP (réponses 3xx) émises par le serveur distant, conformément au comportement de la bibliothèque requests sous-jacente. Si vous souhaitez empêcher la transmission des en-têtes personnalisés et des identifiants vers des destinations différentes de l’URL d’origine, définissez cette option sur no. Par défaut, elle vaut yes.
cto Signifie Socket Connect Timeout. Il s’agit du nombre de secondes pendant lesquelles Requests attend que votre client établisse une connexion avec une machine distante, ce qui correspond à l’appel connect() sur la socket. La valeur par défaut est de 4.0 secondes.
rto Signifie Socket Read Timeout. Il s’agit du nombre de secondes pendant lesquelles le client attend que le serveur envoie une réponse. La valeur par défaut est de 4.0 secondes.
emojis Active la prise en charge des emojis, par exemple :+1: qui sera traduit en 👍. Par défaut, cette option vaut no.
Remarque : selon la configuration côté serveur, l’administrateur peut désactiver globalement la prise en charge des emojis ; mais par défaut, ce n’est pas le cas.
tz Identifie le fuseau horaire de la base IANA que vous souhaitez utiliser. Par défaut, celui-ci est détecté à partir de la configuration du serveur qui exécute Apprise. Vous pouvez le définir sur des valeurs comme America/Toronto, ou sur tout autre fuseau correctement formaté correspondant à votre région.
retry Nombre de tentatives de remise supplémentaires après le premier échec, avant d’abandonner. Accepte un entier compris entre 0 et 10. La valeur par défaut est 0 (aucune nouvelle tentative – une seule tentative est effectuée). Lorsqu’il est combiné avec wait, Apprise marque une pause du nombre de secondes spécifié entre chaque tentative.
wait Nombre de secondes à attendre entre les nouvelles tentatives. Accepte une valeur décimale comprise entre 0.0 et 20.0 ; les entiers sont automatiquement convertis en virgule flottante. La valeur par défaut est 0.5. Ce paramètre n’est utile que si retry est supérieur à zéro – un service avec retry=0 effectue exactement une tentative, quelle que soit la valeur de wait.
optional Lorsqu’il est défini sur yes, un échec de remise pour ce service est silencieusement absorbé. Le résultat global de notify() est quand même considéré comme réussi même si ce point de terminaison était injoignable, à condition que tous les services requis (non optionnels) du même lot aient réussi. Ce drapeau ne saute pas la remise ni ne contourne la logique de nouvelles tentatives – toutes les tentatives configurées sont effectuées avant que l’échec soit absorbé. Par défaut, il vaut no, ce qui signifie que chaque échec est propagé à l’appelant.

Déclencher une alerte :

Fenêtre de terminal
apprise -vv -t "Base de données en panne" -b "La base de données principale ne répond pas" \
"incidentio://01GW2G3V0S59R238FAHPDS1R66/mySecretToken"

Déclencher une alerte, puis la résoudre plus tard en envoyant une notification success avec le même titre :

Fenêtre de terminal
apprise -vv -n failure -t "Disque presque plein" -b "db01 utilise 95 % de son disque" \
"incidentio://01GW2G3V0S59R238FAHPDS1R66/mySecretToken?+service=database"
apprise -vv -n success -t "Disque presque plein" -b "db01 est revenu à la normale" \
"incidentio://01GW2G3V0S59R238FAHPDS1R66/mySecretToken"

Toujours résoudre l’alerte avec une clé de déduplication fixe, quel que soit le type de notification :

Fenêtre de terminal
apprise -vv -t "Disque" -b "db01 est revenu à la normale" \
"incidentio://01GW2G3V0S59R238FAHPDS1R66/mySecretToken?dedup=db01-disk&action=resolve"

incident.io exige un titre pour chaque alerte. Si vous n’en indiquez pas, votre message sert de titre.

Questions ou commentaires ?

Documentation

Vous avez repéré une faute de frappe ou une erreur ?

Problèmes Techniques

Vous rencontrez un problème avec le code ? Ouvrez un ticket sur GitHub :

Conçu avec amour depuis le Canada