Notifications PagerDuty

Aperçu

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

Configuration du Compte

Vous devez disposer d’un compte chez PagerDuty et generer, ou recuperer, votre cle API.

Ensuite, vous pouvez definir une integration API V2.

Syntaxe

La syntaxe valide est la suivante :

• pagerduty://{integration_key}@{api_key}
• pagerduty://{integration_key}@{api_key}/{source}
• pagerduty://{integration_key}@{api_key}/{source}/{component}

Détail des Paramètres

Variable	Obligatoire	Description
integration_key	Oui	Cette valeur vous est fournie sur la page de details de l’integration Events API V2. Elle peut aussi etre appelee Routing Key.
api_key	Oui	Cle API associee a votre configuration.
group	Non	Fournit un groupe, sous forme de chaine, dans la charge utile.
class	Non	Fournit une classe, sous forme de chaine, dans la charge utile.
region	Non	La valeur par defaut est us. Vous pouvez egalement la definir sur eu.
source	Non	Fournit une source, sous forme de chaine, dans la charge utile ; la valeur par defaut est Apprise si rien n’est precise.
component	Non	Fournit un composant, sous forme de chaine, dans la charge utile ; la valeur par defaut est Notification si rien n’est precise.
click	Non	Fournit une URL cliquable a associer a l’avis.
image	Non	Associe l’etat de la notification a une icone representative. Vous pouvez definir cette valeur sur no si vous ne souhaitez pas ce comportement.
severity	Non	Le niveau de gravite de la notification est normalement detecte automatiquement, mais si vous souhaitez toujours imposer un mode specifique, vous pouvez le faire via l’URL. Les valeurs possibles sont info, warning, critical et error.

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 un declenchement PagerDuty pour notre source node01.local et le component drive_sda

# Supposons que notre {integration_key} soit A1BRTD4JD
# Supposons que notre {api_key} soit TIiajkdnlazkcOXrIdevi7F
# Supposons que notre {source} soit node01.local
# Supposons que notre {component} soit drive_sda
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "pagerduty://A1BRTD4JD@TIiajkdnlazkcOXrIdevi7F/node01.local/drive_sda/"

Détails Personnalisés

Vous pouvez aussi fournir des details personnalises dans la charge utile. Pour cela, il suffit d’ajouter un symbole plus, +, devant n’importe quel parametre precise dans votre URL.

# L'exemple ci-dessous transmettrait dans `custom_details` de l'API
#    "disk_space_left": "145GB"
#
# Supposons que notre {integration_key} soit abc123
# Supposons que notre {api_key} soit 98754
# Supposons que notre {source} soit node01.local
# Supposons que notre {component} soit drive_sda
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "pagerduty://abc123@98754/node01.local/drive_sda/?+disk_space_left=145GB"

# Pour plusieurs details, il suffit d'ajouter plus d'entrees :
# L'exemple ci-dessous definirait les details personnalises suivants :
#    "disk_space_left": "145GB"
#    "disk_space_total": "500GB"
#
# Supposons que notre {integration_key} soit abc123
# Supposons que notre {api_key} soit 98754
# Supposons que notre {source} soit node01.local
# Supposons que notre {component} soit drive_sda
apprise -vv -t "Titre du Message de Test" -b "Corps du Message de Test" \
   "pagerduty://abc123@98754/node01.local/drive_sda/?+disk_space_left=145GB&+disk_space_total=500GB"