Aller au contenu

Notifications GoAlert

Aperçu

  • Source: https://goalert.me
  • Prise en charge des images: Non
  • Prise en charge des pièces jointes: Non
  • Limites de caractères des messages:
    • Title: 1024
    • Body: 6144
  • Format(s) de message pris en charge:
    • ✓MARKDOWN
  • Créer votre URL Apprise

GoAlert est une plateforme auto-hébergée de gestion des astreintes et des alertes. Apprise déclenche des alertes à l’aide d’une clé d’intégration GoAlert de type Generic API :

  1. Connectez-vous à GoAlert et ouvrez le Service qui doit recevoir les alertes.
  2. Dans la section Integration Keys, cliquez sur le bouton +.
  3. Donnez un nom à la clé, par exemple Apprise, choisissez le type Generic API et enregistrez-la.
  4. Copiez l’URL générée. Elle ressemble à https://goalert.example.com/api/v2/generic/incoming?token=ab12cd34-ab12-4c5d-8e9f-0123456789ab.

La valeur token à la fin est votre clé d’intégration, et le début de l’URL correspond à votre serveur GoAlert. Pour l’exemple ci-dessus, l’URL Apprise est goalerts://goalert.example.com/ab12cd34-ab12-4c5d-8e9f-0123456789ab.

Chaque clé d’intégration appartient à un seul service GoAlert. Ajoutez d’autres clés à la même URL pour déclencher l’alerte dans plusieurs services à la fois.

La syntaxe valide est la suivante :

  • goalert://{hostname}/{integration_key}
  • goalerts://{hostname}/{integration_key}
  • goalerts://{hostname}:{port}/{integration_key}
  • goalerts://{hostname}/{path}/{integration_key}
  • goalerts://{hostname}/{integration_key1}/{integration_key2}/{integration_keyN}

Utilisez goalerts:// pour les connexions sécurisées (https) et goalert:// pour les connexions non sécurisées (http).

Variable Obligatoire Description
hostname Oui Le serveur GoAlert auquel vous envoyez votre alerte.
integration_key Oui Une ou plusieurs clés d’intégration GoAlert de type Generic API. Chaque clé déclenche l’alerte dans le service auquel elle appartient.
port Non Le port sur lequel le serveur GoAlert écoute. La valeur par défaut est 80 pour goalert:// et 443 pour goalerts://.
path Non Si GoAlert est hébergé sous un sous-chemin (par exemple derrière un proxy inverse), indiquez-le avant vos clés d’intégration. La valeur par défaut est /.
action Non Ce qu’il faut faire de l’alerte. Les valeurs possibles sont map, trigger et close. map clôture les alertes correspondantes lorsque le type de notification est success et déclenche une alerte pour tous les autres types. trigger déclenche toujours une alerte et close clôture toujours les alertes correspondantes. 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 action close la clôture. Sans elle, GoAlert ne fait correspondre que les alertes ayant exactement le même titre et le même corps. Définissez donc une clé dedup dès qu’un message ultérieur doit clôturer une alerte.

Vous pouvez aussi joindre des métadonnées à une alerte en ajoutant des entrées +clé=valeur à l’URL, par exemple +env=prod&+team=ops.

Le titre devient le résumé de l’alerte, que GoAlert envoie par SMS et par appel vocal. Le corps devient le détail de l’alerte. Sans titre, le début du corps sert de résumé. GoAlert n’accepte pas de pièces jointes sur cette API.

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 GoAlert :

Fenêtre de terminal
# Supposons que notre {hostname} soit goalert.example.com
# Supposons que notre {integration_key} soit ab12cd34-ab12-4c5d-8e9f-0123456789ab
apprise -vv -t "Espace disque faible" -b "Seulement 2 % libre sur /var" \
"goalerts://goalert.example.com/ab12cd34-ab12-4c5d-8e9f-0123456789ab"

Déclencher une alerte avec une clé de déduplication, puis la clôturer une fois le problème résolu :

Fenêtre de terminal
# Déclencher l'alerte
apprise -vv -n failure -t "Espace disque faible" -b "Seulement 2 % libre sur /var" \
"goalerts://goalert.example.com/ab12cd34-ab12-4c5d-8e9f-0123456789ab?dedup=disk-var"
# La clôturer (une notification success clôture les alertes par défaut)
apprise -vv -n success -t "Espace disque rétabli" -b "40 % libre sur /var" \
"goalerts://goalert.example.com/ab12cd34-ab12-4c5d-8e9f-0123456789ab?dedup=disk-var"

Déclencher la même alerte dans deux services, avec des métadonnées :

Fenêtre de terminal
apprise -vv -t "Échec de la sauvegarde" -b "La sauvegarde nocturne ne s'est pas terminée" \
"goalerts://goalert.example.com/ab12cd34-ab12-4c5d-8e9f-0123456789ab/cd34ef56-cd34-4e5f-9a0b-0123456789cd?+env=prod"
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