Notifications Pinglet

Aperçu

• Source: https://pinglet.co.uk/
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Non
• Limites de caractères des messages:
  • Title: 250
  • Body: 3000
• Créer votre URL Apprise

Configuration du Compte

Connectez-vous a votre compte Pinglet (ou a votre instance auto-hebergee) et generez une cle API depuis la section compte/API.

Les notifications sont publiees sur un sujet (topic) au sein d’un espace de noms (namespace). Les deux sont crees automatiquement des la premiere publication, il n’y a donc rien a preparer au prealable dans le tableau de bord.

Syntaxe

Les connexions securisees (via HTTPS) doivent utiliser pinglets://, tandis que les connexions non securisees (via HTTP) doivent utiliser pinglet://.

La syntaxe valide est la suivante :

• pinglet://{token}@{hostname}/{namespace}/{topic}
• pinglets://{token}@{hostname}/{namespace}/{topic}
• pinglets://{token}@{hostname}:{port}/{namespace}/{topic}
• pinglets://{token}@{hostname}{path}{namespace}/{topic}

Cette derniere forme concerne un serveur Pinglet auto-heberge place derriere un prefixe de chemin de proxy inverse, ou {path} est le point de montage (par exemple /pinglet/).

Détail des Paramètres

Variable	Obligatoire	Description
token	*Oui	Votre cle API Pinglet (peut aussi etre transmise via ?token=)
hostname	*Oui	Le nom d’hote de votre serveur Pinglet
port	Non	Le port sur lequel ecoute votre serveur Pinglet
namespace	*Oui	L’espace de noms dans lequel se trouve le sujet
topic	*Oui	Le sujet sur lequel publier
priority	Non	Priorite de livraison : silent, normal (par defaut), ou urgent
:key=value	Non	Ajoute un badge (pastille) sur la carte de notification
+key=value	Non	Ajoute une metadonnee affichee sur la fiche de detail de la notification

Note

Pinglet affiche au maximum 3 badges par notification. Les entrees :key=value au-dela de la troisieme sont ignorees, et toute cle de badge de plus de 24 caracteres ou valeur de plus de 32 caracteres est tronquee. Les cles de metadonnees (+key=value) sont tronquees a 64 caracteres et les valeurs a 256 caracteres.

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.
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é. L’appel global notify() retourne quand même True 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

Envoyer une simple notification Pinglet :

# Supposons que notre {token} soit abc123
# Supposons que notre {hostname} soit app.pinglet.co.uk
apprise -vv -t "Deploiement Termine" -b "Build #482 deploye en production" \
   "pinglets://abc123@app.pinglet.co.uk/acme/deploys"

Envoyer avec une priorite, un badge et une metadonnee :

apprise -vv -t "Deploiement Termine" -b "Build #482 deploye en production" \
   "pinglets://abc123@app.pinglet.co.uk/acme/deploys?priority=urgent&:Host=web-1&+region=eu-west"

Envoyer vers une instance auto-hebergee montee derriere un prefixe de chemin de proxy inverse :

apprise -vv -t "Deploiement Termine" -b "Build #482 deploye en production" \
   "pinglet://abc123@myhost/prefix/acme/deploys"