Notifications Squadcast
Configuration du compte
Section intitulée « Configuration du compte »Squadcast (désormais SolarWinds Incident Response) reçoit les notifications d’Apprise sous forme d’incidents, qui préviennent ensuite la personne d’astreinte pour le service.
- Connectez-vous à Squadcast et ouvrez Services.
- Choisissez l’équipe et le service à alerter, puis cliquez sur Alert Sources.
- Recherchez Incident Webhook et copiez la Webhook URL. Elle ressemble à
https://api.squadcast.com/v2/incidents/api/7f550a9f4c44173a37664d938f1355f0f92a47a7. La valeur à la fin est votre clé de webhook.
Vous pouvez aussi coller cette URL telle quelle dans Apprise. Les comptes hébergés en Europe reçoivent une URL commençant par https://api.eu.squadcast.com ; Apprise en déduit la région, ou vous pouvez ajouter ?region=eu à une URL squadcast://.
La syntaxe valide est la suivante :
squadcast://{webhook_key}squadcast://{webhook_key}?region=eusquadcast://{webhook_key}?action=resolve&dedup={key}https://api.squadcast.com/v2/incidents/api/{webhook_key}https://api.eu.squadcast.com/v2/incidents/api/{webhook_key}
Détails des paramètres
Section intitulée « Détails des paramètres »| Variable | Requis | Description |
|---|---|---|
| webhook_key | Oui | La valeur à la fin de l’URL de l’Incident Webhook fournie par Squadcast pour votre service. |
| region | Non | L’endroit où votre compte Squadcast est hébergé. Les valeurs possibles sont us et eu. La valeur par défaut est us. |
| action | Non | Ce qu’il faut faire de l’incident. Les valeurs possibles sont map, trigger et resolve. map résout l’incident quand le type de notification est success et en déclenche un pour tous les autres types. trigger déclenche un nouvel incident à chaque fois, même si le titre se répète, et resolve le résout toujours. La valeur par défaut est map. |
| dedup | Non | L’identifiant d’événement (event ID) que Squadcast utilise pour rattacher les notifications à un même incident. Une résolution ferme tous les incidents ayant le même identifiant. Sans cette valeur, map et resolve utilisent le titre (ou la première ligne du message s’il n’y a pas de titre) comme identifiant : une notification success résout donc l’incident qu’une notification failure avec le même titre a déclenché, tandis que trigger déclenche un nouvel incident à chaque fois. |
| priority | Non | La priorité de l’incident. Les valeurs possibles sont P1, P2, P3, P4 et P5 (un simple chiffre comme 2 fonctionne aussi). Si elle n’est pas définie, Squadcast laisse la priorité à Unset. |
| +key | Non | Ajoute une étiquette (tag) à l’incident, par exemple +severity=high. |
Paramètres Globaux
Section intitulée « Paramètres Globaux »| 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. |
Exemples
Section intitulée « Exemples »Déclencher un incident :
apprise -vv -t "Base de données en panne" -b "La base de données principale ne répond pas" \ "squadcast://7f550a9f4c44173a37664d938f1355f0f92a47a7?priority=P1"Déclencher un incident, puis le résoudre plus tard en envoyant une notification success avec le même titre :
apprise -vv -n failure -t "Disque presque plein" -b "db01 utilise 95 % de son disque" \ "squadcast://7f550a9f4c44173a37664d938f1355f0f92a47a7?+service=database"
apprise -vv -n success -t "Disque presque plein" -b "db01 est revenu à la normale" \ "squadcast://7f550a9f4c44173a37664d938f1355f0f92a47a7"Toujours résoudre l’incident avec un identifiant d’événement fixe, pour un compte hébergé en Europe, quel que soit le type de notification :
apprise -vv -t "Disque" -b "db01 est revenu à la normale" \ "squadcast://7f550a9f4c44173a37664d938f1355f0f92a47a7?region=eu&dedup=db01-disk&action=resolve"Si vous n’indiquez pas de titre, votre message sert de titre à l’incident.
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 :