Recevoir des alertes

Cette fonctionnalité permet de recevoir des alertes lorsqu'une API est en timeout. Le seuil de déclenchement de l'alerte ainsi que la durée d'observation sont paramétrables. A ce jour, les alertes sont envoyées uniquement par email. Un email est envoyé par période tant que l'API reste en timeout.

Rappel : il est possible de configurer le timeout d'une API.

Cas d'usages

Pas de cas d'usage à ce jour.

Principe de fonctionnement

L'API déclare, via l'import du fichier de configuration Yaml, les paramètres et les valeurs du monitoring dans le namespace monitor. Les attributs sont les suivants :

• urlcontext : Obligatoire. Partie de l'URL renseignant le nom de l'API concernée. Ex "monapi" pour l'API https://developer.laposte.fr/products/monapi/1.
• version : Obligatoire. Numéro de version de l'API concernée. Ex "1" pour l'API https://developer.laposte.fr/products/monapi/1.
• emails : Obligatoire. Tableaux des emails destinataires de l'alerte.
• percent : Facultatif. Seuil, exprimé en pourcentage, de déclenchement de l'alerte. Si non renseigné, la valeur par défaut retenue est 20.
• period : Facultatif. Période d'observation non glissante, exprimée en minute, de déclenchement de l'alerte. Si non renseignée, la valeur par défaut retenue est 10.
• email : Obligatoire. Booléen. A renseigner à "True" pour recevoir les alertes par email (seul canal proposé pour cette fonctionnalité à ce jour)

Principe de mise en oeuvre

Toute création, modification ou suppression de paramètre dans le "monitor" est effective au maximum 1 heure après.

Paramétrage minimal : utilisation des valeurs par défaut

Dans l'exemple ci-dessous, le seuil de déclenchement et la période n'ont pas été renseignés pour l'API "monapi v1". Ainsi lorsqu'au moins 20 % des retours seront en timeout sur une période de 10 minutes, une alerte sera envoyée aux adresses email figurant dans le paramétrage. Un email d'alerte sera envoyé toutes les 10 minutes tant que le seuil des 20 % sera atteint.

- type: api
    urlContext: monapi
    version: '1'
...
- type: monitor
  value: 
    api: 
      urlContext: monapi
      version: "1"
    emails: 
      - support.monapi-v1@laposte.fr
      - direx.monapi-v1@laposte.fr
    timeout: 
      alerting: 
        email: true

Paramétrage fin des valeurs

Dans l'exemple ci-dessous, les emails d'alerte seront envoyés lorsque l'API "monapi v1" sera en timeout pour au moins 40 % de requêtes mesurées sur 20 minutes. Un email d'alerte sera envoyé toutes les 20 minutes tant que le seuil des 40 % sera atteint.

- type: api
    urlContext: monapi
    version: '1'
...
- type: monitor
  value: 
    api: 
      urlContext: monapi
      version: "1"
    emails: 
      - support.monapi-v1@laposte.fr
      - direx.monapi-v1@laposte.fr
    timeout: 
      percent: 40
      period: 20
      alerting: 
        email: true