Aller au contenu

Notifications SIGNL4

Aperçu

Vous devez disposer d’un compte chez SIGNL4 et utiliser le secret de votre équipe ou d’intégration SIGNL4.

SIGNL4 envoie des alertes mobiles exploitables aux utilisateurs ou équipes responsables. Il offre un ensemble de fonctionnalités puissantes comprenant une application mobile, des notifications push, des SMS, des appels vocaux, des escalades automatisées et la planification des astreintes. Cela garantit que les alertes critiques sont transmises instantanément et de manière fiable aux bonnes personnes, à tout moment et en tout lieu.

  1. Visitez signl4.com et inscrivez-vous si vous n’avez pas encore de compte.
  2. Une fois connecté, obtenez le secret de votre équipe ou d’intégration SIGNL4 comme décrit ici.
  3. Le secret de votre équipe ou d’intégration SIGNL4 constitue le nom d’hôte dans votre URL Apprise.

La syntaxe valide est la suivante :

  • signl4://{secret}
VariableRequisDescription
secretOuiLe « secret » est le secret de votre équipe ou d’intégration SIGNL4.
serviceNonAssigne l’alerte à la catégorie service/système avec le nom spécifié.
locationNonTransmet des informations de localisation (‘latitude, longitude’) avec votre événement et affiche une carte dans l’application mobile.
alerting_scenarioNonSi cet événement déclenche une alerte, permet de contrôler la façon dont SIGNL4 notifie l’équipe. single_ack : Une seule personne doit acquitter cette alerte. multi_ack : L’alerte doit être confirmée par le nombre de personnes d’astreinte au moment de sa création. emergency : Toutes les personnes de l’équipe sont notifiées indépendamment de leur statut d’astreinte et doivent acquitter l’alerte, qui est également assignée à la catégorie d’urgence intégrée.
filteringNonSpécifiez une valeur booléenne true ou false pour appliquer ou non le filtrage d’événements à cet événement. Si défini à true, l’événement ne déclenchera une notification à l’équipe que s’il contient au moins un mot-clé de l’une de vos catégories de services et systèmes (c’est-à-dire s’il est sur liste blanche).
external_idNonSi l’événement provient d’un enregistrement dans un système tiers, utilisez ce paramètre pour transmettre l’identifiant unique de cet enregistrement. Cet identifiant sera communiqué dans les notifications webhook sortantes de SIGNL4, ce qui est idéal pour la corrélation/synchronisation de cet enregistrement avec l’alerte.
statusNonSi vous souhaitez résoudre une alerte existante via un identifiant externe (external_id), vous pouvez ajouter ce paramètre de statut. Il possède trois valeurs possibles : new : Valeur par défaut signifiant que cet événement déclenche une nouvelle alerte. acknowledged : Si vous souhaitez acquitter une alerte précédemment déclenchée (par exemple, quelqu’un a répondu dans le système tiers et non dans l’application mobile pendant les heures de bureau), définissez le « statut » à « acknowledged » et fournissez un identifiant externe via le paramètre « external_id » pour l’alerte à acquitter. Il n’est possible d’acquitter une alerte qu’avec un identifiant externe fourni lors de son déclenchement initial. resolved : Si vous souhaitez résoudre une alerte précédemment déclenchée (par exemple, un système de supervision a fermé automatiquement l’événement), assurez-vous de définir X-S4-Statut à ‘resolved’ et fournissez un identifiant externe via le paramètre « external_id » pour l’alerte à résoudre. Il n’est possible de résoudre une alerte qu’avec un identifiant externe fourni lors de son déclenchement initial.

Vous trouverez plus d’informations ici.

VariableDescription
overflowCe paramètre peut être défini sur split, truncate ou upstream. Il détermine la manière dont Apprise remet le message que vous lui transmettez. Par défaut, il vaut upstream.
👉 upstream : ne fait aucune modification et transmet le message exactement tel qu’il a été reçu au service.
👉 truncate : veille à ce que le message tienne dans la limite amont documentée par le service. Si plus d’informations sont fournies que la limite définie, l’excédent est tronqué.
👉 split : similaire à truncate, sauf que si le message dépasse la limite amont documentée par le service, il est découpé en plusieurs morceaux plus petits puis envoyés séquentiellement.
formatCe 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é.
verifyLes 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.
ctoSignifie 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.
rtoSignifie 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.
emojisActive 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.
tzIdentifie 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.

Envoyer une alerte SIGNL4 simple :

Fenêtre de terminal
apprise -vv \
--title 'Alerte d'Apprise' \
--body 'Bonjour tout le monde.' \
'signl4://secret'

Voici un autre exemple :

Fenêtre de terminal
apprise -vv --title 'Alerte d'Apprise' \
--body 'Bonjour tout le monde.' \
'signl4://secret?service=IoT&location=52.3984235,13.0544149&external_id=a2&status=new'
Questions ou commentaires ?

Documentation

Vous avez repéré une faute de frappe ou une erreur ? Signalez-la ou proposez une correction .

Problèmes Techniques

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

Conçu avec amour depuis le Canada