diff --git a/pica-metrologie/README.md b/pica-metrologie/README.md index b18b4e8d1314ba8d30ff70d823871123b75eee77..3e0672d63befeac914ab89a979f247f7de6da984 100644 --- a/pica-metrologie/README.md +++ b/pica-metrologie/README.md @@ -1,25 +1,41 @@ -# Doc dépréciée +# Stack de monitoring -Elle sera mise à jour dans quelques jours après la fusion, pour que le wiki puisse référencer les nouveaux fichiers et inversement que cette doc soit plus synthétique et fasse référence au wiki. +Ce dossier contient les ressources nécessaires pour déployer la partie serveur de la stack de monitoring de Picasoft, à savoir : -# Stack de métrologie - -Ce dossier contient les ressources nécessaires pour déployer la partie serveur de la stack de métrologie de Picasoft, à savoir : - -- Victoria Metrics pour le stockage de métriques -- BlackBox Exporter pour le probing des services webs et des serveurs DNS - `vmagent` pour l'ingestion de métriques +- Victoria Metrics pour le stockage de métriques +- BlackBox Exporter pour la vérification de la santé des services webs et des serveurs DNS - `vmalert` pour la génération d'alertes - AlertManager pour la gestion et la transmission des alertes - Grafana pour visualiser les métriques Pour des raisons de simplicités mais aussi de sécurité, ces services sont déployés sur la même machine, en partageant un même réseau Docker. -Il est fortement recommandé de consulter la [documentation associée](https://wiki.picasoft.net/doku.php?id=technique:adminsys:monitoring:metrologie:stack-picasoft) pour comprendre l'architecture de cette stack de métrologie. +Ce README se veut le plus court possible : voir la [documentation associée à la pile de monitoring](https://wiki.picasoft.net/doku.php?id=technique:adminsys:monitoring:start). ## Lancement -[Documentation générique](https://wiki.picasoft.net/doku.php?id=technique:docker:picasoft:admin#lancement_d_un_nouveau_service). +→ [Documentation générique](https://wiki.picasoft.net/doku.php?id=technique:docker:picasoft:admin#lancement_d_un_nouveau_service). + +`exporters-auth.secrets` contient les identifiants pour les Basic Auth des pages `/metrics` des services. Voir [cette page](https://wiki.picasoft.net/doku.php?id=technique:adminsys:monitoring:metrologie:collect:service_metrics#configuration_traefik) pour savoir où les récupérer (normalement dans le pass, dossier `Tech/Prometheus-Exporters-Auth`). + +Créer un fichier `.env` et renseigner les variables suivantes : + +- `METRICS_AUTH` : chaîne d'authentification pour l'exporter Blackbox +- `ALERTMANAGER_AUTH` : chaîne d'authentification pour l'interface web d'`alertmanager` + +Voir [cette page](https://wiki.picasoft.net/doku.php?id=technique:docker:good_practices:traefik#securiser_une_sous-partie_du_service_par_authentification) pour le format. + +Ensuite, il ne reste plus qu'à construire les images qui le nécessitent et à tout lancer : + +```bash +docker-compose build +docker-compose up -d +# On vérifie que tout marche bien +docker-compose logs -f +# Si tout a bien marché +docker-compose push +``` ## Configuration @@ -58,17 +74,21 @@ Grafana est l'outil de visualisation de métriques [utilisé par Picasoft](https La configuration est réalisée : -- Par les variables d'environnement de [Compose](./docker-compose.yml), qui permettent d'accéder à tous les paramètres de la configuration (voir la [documentation](https://grafana.com/docs/grafana/latest/administration/configuration/#configure-with-environment-variables)) : cette méthode est utilisée pour tous les paramètres non-critiques. +- Par les variables d'environnement de [Compose](./docker-compose.yml), qui permettent de configurer tous les paramètres (voir la [documentation](https://grafana.com/docs/grafana/latest/administration/configuration/#configure-with-environment-variables)) : cette méthode est utilisée pour tous les paramètres non-critiques. - Par le fichier [ldap.toml](./ldap.toml) pour la configuration spécifique au LDAP. Ce fichier peut faire référence à des variables d'environnement avec [cette syntaxe](https://grafana.com/docs/grafana/latest/auth/ldap/#using-environment-variables), pour les données critiques (_e.g._ mot de passe) - Par le fichier [grafana.secrets](./secrets/grafana.secrets.example), pour les secrets. -#### Utilisateurs +### Blackbox + +Voir [le wiki](https://wiki.picasoft.net/doku.php?id=technique:adminsys:monitoring:metrologie:collect:blackbox). + +### vmalert + +Voir [le wiki](https://wiki.picasoft.net/doku.php?id=technique:adminsys:monitoring:alerting:vmalert). -Il y a trois types d'utilisateurs : +### alertmanager -- L'administrateur de l'instance, configuré via l'environnement (Compose et secret) -- Les utilisateurs LDAP -- Les utilisateurs créés manuellement, non utilisés par Picasoft +Voir [le wiki](https://wiki.picasoft.net/doku.php?id=technique:adminsys:monitoring:alerting:alertmanager). ## Mise à jour