KEPLIN Docs

Alertes par e-mail

Ce qui déclenche une alerte, ce que dit l'e-mail, qui le reçoit, et comment activer les avertissements et régler les seuils.

Le Radar raconte ce qui se passe à qui ouvre l'écran. Les alertes font l'inverse : elles préviennent sans que personne n'ait à regarder. C'est la différence entre savoir qu'une app a été hors service et savoir qu'elle l'est.

Une alerte n'arrive que lorsque quelqu'un doit agir, et elle dit ce qui a cassé, où, combien de fois, pour combien de personnes et depuis quand, avec un lien pour le voir dans le Radar.

Elles s'activent et se règlent dans les Paramètres de la plateforme, en bas de la barre latérale.

Note

Ces paramètres sont réservés à qui administre l'installation. Avec un profil de développeur, le menu Paramètres n'apparaît pas.

Ce qui déclenche une alerte

Situation Quand elle prévient
Nouveau problème Un problème apparaît dans une app publiée : une erreur dans un écran, un workflow ou une route du serveur, une API qui échoue sur le serveur, ou un test qui échoue lors d'une exécution planifiée (voir Exécuter et lire les résultats).
Problème revenu Un problème marqué comme résolu se reproduit.
Problème ouvert revenu Un problème ouvert, dont personne n'avait été prévenu, se reproduit.
Échec généralisé Le pourcentage de requêtes qui échouent sur le serveur dépasse le seuil, avec au moins 5 échecs et le minimum de requêtes.
Scripts en échec Les exécutions de scripts en échec dépassent le seuil.
File de l'index et Disque La file de l'index prend du retard ou le disque manque d'espace libre.
Antivirus L'antivirus refuse un fichier envoyé, ou met en quarantaine un fichier déjà enregistré (voir Antivirus).
Secret d'un fournisseur sur le point d'expirer Le secret d'un fournisseur Microsoft Entra ID expire dans moins de 30 jours, ou a déjà expiré (voir Se connecter avec des fournisseurs d'authentification).

Les problèmes suivent l'état qu'ils ont dans le Radar (voir Enquêter sur un problème) :

  • Tant qu'un problème est ouvert, aucun autre e-mail n'arrive à son sujet.
  • Résoudre un problème ferme l'alerte sans e-mail : la personne qui l'a résolu le sait déjà. Si le problème se reproduit, un nouvel e-mail indique qu'il est revenu.
  • Ignorer un problème le fait taire : il ne déclenche jamais d'alerte.
  • Ce qui se passe dans le studio, pendant que quelqu'un construit ou teste l'app, ne prévient personne.

Pour l'échec généralisé, seuls les échecs du serveur comptent (statut 500 ou plus). Les refus de permission, les requêtes annulées par la personne qui les a faites et les erreurs de validation de ce que quelqu'un a saisi ne comptent pas. Quand une app n'a pas assez de trafic pour décider, l'alerte reste telle qu'elle était : elle ne se ferme pas simplement parce que les gens ont cessé d'utiliser l'app.

Ce que dit un e-mail

Chaque personne reçoit un e-mail avec les alertes qui la concernent, dans la langue avec laquelle elle utilise la plateforme. Pour un problème, l'e-mail indique :

  • Le nom de l'app et le message de l'erreur, dans l'objet.
  • Où : l'API, l'écran, le workflow ou la route du serveur.
  • Combien d'occurrences il y a eu dans la fenêtre, et combien au total.
  • Combien d'utilisateurs sont concernés.
  • Quand le problème a été vu pour la première fois et, pour un problème revenu, quand il avait été marqué comme résolu.
  • Ouvrir dans le Radar : le lien qui ouvre le problème dans le Radar de l'app.

Les alertes d'échec généralisé et de scripts indiquent quelles API ou quels scripts ont échoué, combien de fois, et le dernier message d'erreur de chacun.

Activer les avertissements

  1. Ouvrez Paramètres dans la barre latérale.
  2. Choisissez Alertes, dans le groupe Avertissements.
  3. Activez Avertissements par e-mail. L'aide dit ce qui est en jeu : « Prévient quand un nouveau problème apparaît dans une app, quand un problème résolu se reproduit et quand quelque chose dépasse les limites ci-dessous. Sans cela, vous ne le savez qu'en ouvrant l'écran. »
  4. Cliquez sur Enregistrer, dans l'en-tête. La confirmation dit « Paramètres enregistrés. »

La section Alertes, avec l'interrupteur Avertissements par e-mail
La section Alertes, avec l'interrupteur Avertissements par e-mail

La section Processus, dans le groupe Plateforme, contient trois autres interrupteurs qui valent la peine d'être connus, parce que la moitié des « alertes qui n'arrivent pas » vient de l'un d'eux qui est désactivé :

Interrupteur Ce qu'il fait
Planificateur Exécute les planifications, les rapports planifiés et les minuteurs des workflows.
Index d'observabilité Transfère ce que les apps enregistrent vers l'index central et applique les délais de rétention de chaque app. Désactivé, les écrans affichent des données périmées.
Notifications en temps réel Serveur temps réel des notifications. Sans lui, les notifications sont remises à la prochaine visite.

Où vont les avertissements

La section E-mail, dans le groupe Avertissements, contient le serveur d'envoi et les destinataires : « Le serveur par lequel partent les avertissements de la plateforme. Il est distinct de l'e-mail de chaque app. »

La section E-mail, avec le serveur d'envoi et les destinataires
La section E-mail, avec le serveur d'envoi et les destinataires

Champ Ce que c'est
Serveur L'adresse du serveur d'e-mail sortant.
Port Son port.
Sécurité SSL/TLS (port 465), STARTTLS si le serveur le propose (port 587) ou Aucune (port 25).
Utilisateur Le compte d'authentification sur le serveur.
Mot de passe « Elle est chiffrée et ne revient jamais sur cet écran. Laisser vide conserve celle qui est en place. »
Expéditeur L'adresse de qui envoie. Elle est obligatoire.
Destinataires Qui reçoit tous les avertissements, à la place du choix automatique.

Avec les Destinataires vides, la plateforme choisit qui prévenir :

  • Les alertes d'une app vont aux personnes affectées à cette app.
  • Les alertes d'une app sans personne affectée, et celles de la plateforme (la file de l'index et le disque), vont aux administrateurs actifs.

Astuce

Laissez les Destinataires vides. Chaque app prévient les personnes qui travaillent dessus, et la liste se met à jour toute seule quand quelqu'un rejoint ou quitte l'équipe. Une liste écrite à la main reçoit tout de toutes les apps et devient obsolète le jour où quelqu'un change d'emploi.

L'état du mot de passe apparaît sous le champ : Définie — saisissez pour la remplacer ou À définir.

À partir de quand avertir

Les Seuils se trouvent dans la section Alertes, sous l'interrupteur : « Les nouveaux problèmes préviennent toujours. Les valeurs ci-dessous décident quand un échec généralisé, les scripts, la file de l'index ou le disque envoient un e-mail. »

Les seuils de la section Alertes, avec la fenêtre
Les seuils de la section Alertes, avec la fenêtre

Seuil Ce qu'il mesure Note
Échecs du serveur dans les API (%) « Pourcentage de requêtes qui échouent sur le serveur (5xx), par app, avec au moins 5 échecs dans la fenêtre. » Cela se compte app par app, pas sur la somme de toutes.
Requêtes minimales Combien d'appels sont nécessaires pour que le pourcentage compte « En dessous, le pourcentage ne dit rien : 1 erreur sur 3 fait 33%. »
Scripts en échec Combien d'exécutions de scripts peuvent échouer avant d'avertir
Retard de la file (s) De combien la file de l'index peut prendre du retard « Tant que la file est en retard, les écrans affichent des données périmées. »
Disque libre (%) En dessous de quel pourcentage de disque libre on avertit
Fenêtre (min) La période sur laquelle tout cela est compté « Période sur laquelle les nombres ci-dessus sont comptés. »

Les Requêtes minimales évitent qu'une app peu fréquentée ne déclenche des alertes d'échec généralisé : avec trois requêtes et un échec, le pourcentage est de 33 % et ne veut rien dire. Chaque échec du serveur déclenche déjà sa propre alerte de problème ; le pourcentage sert pour le jour où beaucoup de choses échouent en même temps.

Comment choisir les valeurs

Il n'y a pas de nombres universels, mais il y a une méthode qui fonctionne :

  1. Laissez la plateforme tourner une semaine avec les valeurs d'origine.
  2. Ouvrez Observabilité → Vue d'ensemble avec la période sur 7j et regardez le Taux d'erreur et la Réponse (p95) réels.
  3. Placez le seuil d'Échecs du serveur dans les API (%) un peu au-dessus de ce qui est normal sur cette installation — l'objectif est d'attraper l'anormal, pas de confirmer le normal.
  4. Ajustez les Requêtes minimales au trafic de l'app la plus calme.

Attention

Un seuil trop serré est pire que pas de seuil du tout. Des alertes qui se déclenchent tous les jours cessent d'être lues au bout d'une semaine — et le jour où l'importante arrivera, elle arrivera au milieu des autres.

Confirmer que les alertes fonctionnent vraiment

La section État de l'Observabilité porte, en haut, une phrase qui dit la vérité sur les alertes de cette installation. C'est l'endroit où confirmer après avoir touché aux paramètres.

L'avertissement sur l'état des alertes, en haut de la section État de l'Observabilité
L'avertissement sur l'état des alertes, en haut de la section État de l'Observabilité

Trois phrases sont possibles :

Ce qui s'y trouve Ce que cela signifie
« Alertes activées : prévient les personnes qui travaillent sur chaque app quand un nouveau problème apparaît et quand un problème résolu se reproduit, ainsi que quand plus de 5% des requêtes échouent sur le serveur, à partir de 20 requêtes. » Tout fonctionne — et avec vos seuils sous les yeux.
« Les alertes sont désactivées. Personne n'est prévenu lorsqu'un problème survient — cette page ne raconte ce qui se passe qu'à qui l'ouvre. » Il reste à activer Avertissements par e-mail.
« Alertes activées, mais sans envoi d'e-mail : … Les alarmes sont enregistrées et personne n'est prévenu. » L'avertissement se déclenche, mais ne part pas — il reste à configurer le serveur d'e-mail.

La troisième est la plus traître, parce que tout semble configuré. Si vous la voyez, revenez à la section E-mail et complétez ce qui manque.

Sessions et limites

Toujours dans les Paramètres, la section Limites, dans le groupe Plateforme, contient deux valeurs qui ne sont pas des alertes mais que l'on cherche généralement en même temps :

  • Durée de la session (h) — « Une session active se renouvelle toute seule ; il s'agit ici du temps d'inactivité qui la fait expirer. »
  • Fichier maximum (Mo) — la taille maximale d'un fichier téléversé.

Pourquoi je ne vois pas… ?

  • …d'alertes arriver, alors que tout est activé ? Vérifiez le panneau État : s'il dit « sans envoi d'e-mail », il manque le serveur d'envoi. S'il dit « désactivées », il reste à enregistrer.
  • …la section Alertes ? Vous êtes dans les paramètres d'une app, pas dans ceux de la plateforme. Ceux de la plateforme s'ouvrent par le menu Paramètres de la barre latérale.
  • …mes seuils s'appliquer ? Sans Enregistrer, dans l'en-tête, rien n'est enregistré. La confirmation est « Paramètres enregistrés. »
  • …les alertes d'une app ? Les alertes d'une app vont aux personnes qui lui sont affectées. Vérifiez dans Utilisateurs que vous êtes affecté à l'app.
  • …un autre e-mail pour le même problème ? Un problème ouvert ne prévient qu'une fois. Il prévient de nouveau s'il est marqué comme résolu et se reproduit.
  • …l'alerte d'une erreur vue dans le studio ? Ce qui se passe dans le studio, pour qui construit l'app, ne prévient personne. Seule l'app publiée déclenche des alertes.