Notifications PagerTree

Aperçu

• Source: https://pagertree.com
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Non
• Limites de caractères des messages:
  • Corps: 32768
• Créer votre URL Apprise

Configuration du Compte

1. Pour que cela fonctionne, vous devez creer un compte PagerTree, l’essai gratuit convient parfaitement. Veillez a suivre l’assistant de configuration, car vous voudrez etre d’astreinte pour l’equipe vers laquelle l’integration pointera a l’etape 2.
2. Creez une integration webhook et pointez-la vers l’equipe voulue, par defaut “Devops Team”.
3. Depuis la page de l’integration, copiez le Prefix ID de l’integration, utilise pour l’URL Apprise.
4. Utilisez ensuite ce Prefix ID dans l’URL Apprise : ./bin/apprise -t test -b message "pagertree://int_xxxxxxxxxx"

Syntaxe

La syntaxe valide est la suivante :

• pagertree://{integration}
• pagertree://{integration}?action=resolve&thirdparty_id=abc123
• pagertree://{integration}?+pagertree-token=123&:env=prod&-incident=true&-incident_severity=SEV-1&-incident-message=Please join the bridge&tags=prod,server,outage

Détail des Paramètres

Variable	Obligatoire	Description
integration	Oui	Prefix ID de votre integration webhook. Il se trouve en haut de la page de l’integration.
action	Non	Action du webhook. Les valeurs possibles sont create, acknowledge et resolve. Lorsque vous utilisez acknowledge ou resolve, utilisez aussi le parametre thirdparty_id pour indiquer a PagerTree quelle alerte doit etre traitee.
thirdparty	Non	Identifiant utilise par PagerTree pour faire le lien entre des applications tierces et des alertes. Vous pouvez fournir le votre, sinon un UUID aleatoire sera genere pour vous.
urgency	Non	Niveau d’urgence de l’alerte a generer. Les valeurs possibles sont silent, low, medium, high ou critical. Si aucune valeur n’est fournie, PagerTree utilisera celle definie par defaut dans l’integration.
tags	Non	Liste de tags separes par des virgules, par exemple prod,server,outage.

Paramètres Globaux

Variable	Description
overflow	Ce 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.
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.
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.

Exemples

Envoyer une commande de creation PagerTree.

# Supposons que notre {integration_id} soit int_0123456789
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "pagertree://int_0123456789"

Manipulation du Payload

L’utilisation de : dans l’URL Apprise vous permet de modifier et d’ajouter du contenu au corps envoye en amont a PagerTree. C’est utile lorsque vous exploitez la fonctionnalite Capture Additional Data.

# Ajouter des donnees au payload envoye a PagerTree
#
# Supposons que notre {integration_id} soit int_xxxxxxxxxx
# Supposons que nous voulions inclure "server": "blue-ranger-2" dans le payload existant :
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "pagertree://int_xxxxxxxxxx/?:server=blue-ranger-2"

Cela publierait un message comme celui-ci :

{
  "id": "0f85aa1c-711e-4873-95b6-e441c291537d",
  "action": "create",
  "title": "Titre du Message de Test",
  "message": "Corps du Message de Test",
  "server": "blue-ranger-2"
}

Manipulation des En-têtes

Certains utilisateurs peuvent avoir besoin d’en-tetes HTTP speciaux lors de l’envoi de leurs donnees a PagerTree. Pour cela, il suffit d’ajouter un symbole plus, +, devant n’importe quel parametre defini dans votre URL. C’est utile lorsque vous exploitez la fonctionnalite PagerTree Token.

# L'exemple ci-dessous definirait l'en-tete :
#    pagertree-token: abcdefg
#
# Supposons que notre {integration_id} soit int_xxxxxxxxxx
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "pagertree://int_xxxxxxxxxx?+pagertree-token=abcdefg"

Manipulation des Métadonnées

Certaines fonctionnalites de PagerTree, comme les incidents, se trouvent dans la propriete meta du payload. Pour ajouter des donnees dans meta, il suffit de prefixer vos entrees avec le symbole moins, -. Voir l’exemple.

# Indiquer a PagerTree que cette alerte doit etre marquee comme incident
# Le symbole `-` sera retire lors de l'envoi en amont
# Apprise sait qu'il ne doit pas traiter cet argument et qu'il doit le transmettre tel quel.
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "pagertree://int_xxxxxxxxxx?-incident=true&-incident_severity=SEV-1&-incident_message=Join the war room"