Aller au contenu

Notifications Trigv

Aperçu

  • Source: https://trigv.com/
  • Prise en charge des images: Oui
  • Prise en charge des pièces jointes: Non
  • Limites de caractères des messages:
    • Titre: 255
    • Corps: 1000
  • Format(s) de message pris en charge:
    • ✓TEXT
  • Créer votre URL Apprise

Pour utiliser ce plugin, vous devez disposer d’un espace de travail Trigv et d’une clé API d’ingestion.

  1. Connectez-vous à votre espace de travail Trigv.
  2. Dans les paramètres de l’espace de travail, générez une clé API d’ingestion. Elle ressemble à trgv_AbCdEfGh_0123456789abcdef0123456789abcdef.
  3. Choisissez le ou les canaux (channels) vers lesquels les alertes doivent être envoyées. Si vous n’en indiquez aucun, les alertes sont envoyées vers le canal general.

La syntaxe valide est la suivante :

  • trigvs://{api_key}
  • trigvs://{api_key}/{channel}

Plusieurs canaux peuvent être notifiés en un seul appel en les séparant par une barre oblique :

  • trigvs://{api_key}/{channel1}/{channel2}

Si vous exploitez votre propre passerelle d’ingestion Trigv auto-hébergée, vous pouvez y connecter Apprise directement, avec un port optionnel :

  • trigv://{api_key}@{hostname}/{channel}
  • trigvs://{api_key}@{hostname}:{port}/{channel}

trigv:// communique avec votre nom d’hôte en HTTP simple ; trigvs:// (utilisé par défaut lorsqu’aucun nom d’hôte n’est fourni) utilise toujours HTTPS.

Variable Obligatoire Description
api_key Oui Votre clé API d’ingestion de l’espace de travail Trigv.
channel Non Un ou plusieurs canaux vers lesquels envoyer l’alerte (séparez plusieurs canaux par un / dans le chemin de l’URL). Par défaut general si aucun n’est fourni.
to Non Une liste de canaux supplémentaires à notifier, séparés par des virgules, fournie via l’argument ?to=.
url Non Une URL supplémentaire à joindre à l’alerte (par ex. un lien vers un tableau de bord ou une exécution).
image_url Non Une URL d’image publiquement accessible à afficher avec l’alerte.
urgency Non Force le niveau d’urgence de livraison à standard ou time_sensitive. Par défaut, les échecs sont automatiquement escaladés vers time_sensitive.
event_type Non Une étiquette de type d’événement libre associée à l’alerte (par ex. backup.failed).
priority Non Une priorité de style Pushover. Toute valeur de 1 ou plus est traitée comme ?urgency=time_sensitive.
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.

Envoyer une alerte simple vers le canal par défaut :

Fenêtre de terminal
apprise -vv -t "Cron" -b "Échec de la sauvegarde" \
"trigvs://trgv_AbCdEfGh_0123456789abcdef0123456789abcdef"

Envoyer vers un canal spécifique avec un lien supplémentaire :

Fenêtre de terminal
apprise -vv -t "Déploiement terminé" -b "v2.4.1 livrée en production" \
"trigvs://trgv_AbCdEfGh_0123456789abcdef0123456789abcdef/deploys/?url=https://ci.example.com/runs/42"

Notifier plusieurs canaux en une seule fois :

Fenêtre de terminal
apprise -vv -t "Disque presque plein" -b "/var est à 95 %" \
"trigvs://trgv_AbCdEfGh_0123456789abcdef0123456789abcdef/ops/oncall"

Forcer une livraison urgente :

Fenêtre de terminal
apprise -vv -t "Disque presque plein" -b "/var est à 95 %" \
"trigvs://trgv_AbCdEfGh_0123456789abcdef0123456789abcdef/?urgency=time_sensitive"

Utiliser une passerelle d’ingestion auto-hébergée sur un port personnalisé au lieu de api.trigv.com :

Fenêtre de terminal
apprise -vv -t "Test" -b "Bonjour depuis une passerelle locale" \
"trigv://trgv_AbCdEfGh_0123456789abcdef0123456789abcdef@trigv.internal.example.com:8080/general"
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