Observabilité

Erreurs

Checklist

• utiliser un outil de remontée d'erreurs avec toute la pile d'appels de fonctions (ex Sentry)

• ajouter des alertes et des notifications sur l'environnement de production

Bonnes pratiques

• Les erreurs doivent être remontées avec un maximum de contexte.

• Attention : ne pas transmettre d'informations personnelles et sensibles

Suivi des performances

Checklist

• utiliser une solution de traces pour suivre les performances (APM: application performance management)

  • ex de solutions : Sentry, Elastic APM ou Tempo via Grafana.

• ajouter des alertes et des notifications sur l'environnement de production

  • ex : alerte si le P95 des requêtes backend dépasse 1s

Logs

Checklist

Les logs de l'application doivent :

• être formatés en json (pour être facilement filtrables dans Grafana ou Kibana)

• ne pas contenir d'information personnelle et/ou sensible

• contenir un maximum de contexte (ex: requête http en cours, id utilisateur, autres informations utiles au débogage)

• contenir la liste des requêtes http (access logs) : domaine, path, duration, etc.

Des alertes peuvent être mises en place sur les logs pour détecter des comportements anormaux si les alertes d'erreurs et de performance ne suffisent pas.