Commit 4bea3a58 authored by Jonathan Schaeffer's avatar Jonathan Schaeffer
Browse files

Mise à jour de la doc

parent 41aae7f4
...@@ -4,7 +4,7 @@ Cet outil collecte sur un ou plusieurs espaces disques en structure SDS l'espace ...@@ -4,7 +4,7 @@ Cet outil collecte sur un ou plusieurs espaces disques en structure SDS l'espace
* À propos * À propos
- licence : Ce projet est livré sous licence CeCILLV-2.1 - licence : Ce projet est livré sous licence GPLv3 ou plus
- auteur : Jonathan Schaeffer <jonathan.schaeffer@univ-grenoble-alpes.fr> - auteur : Jonathan Schaeffer <jonathan.schaeffer@univ-grenoble-alpes.fr>
** Collecte des volumes ** Collecte des volumes
...@@ -16,32 +16,24 @@ Cet outil collecte sur un ou plusieurs espaces disques en structure SDS l'espace ...@@ -16,32 +16,24 @@ Cet outil collecte sur un ou plusieurs espaces disques en structure SDS l'espace
La représentation des mesures dans influxdb aura la structure suivante : La représentation des mesures dans influxdb aura la structure suivante :
#+BEGIN_EXAMPLE json #+BEGIN_EXAMPLE json
{
"measurement": "volumes",
"tags": {
"year": "2016",
"network": "Z3",
"class": "permanent"
},
"time": ""
"fields": {
"data": 123456
}
}
#+END_EXAMPLE
Les données collectées sont écrites en JSON dans un fichier tampon. #+END_EXAMPLE
* Configuration Les données collectées sont écrites en YAML dans un fichier cache.
Le script de collecte cherche un fichier de configuration =config.yml= dans son dossier de travail, ou dans =~/.config= ou dans =/etc=.
Le fichier =config.yml.example= fournit toute la documentation nécessaire pour un paramétrage initial. Les données sont ensuite écrites dans une base postgres ou influxdb.
* Options * Configuration
Le script de collecte a besoin d'un fichier de configuration. Le fichier =config.yml.example= fournit toute la documentation nécessaire pour un paramétrage initial.
Par défaut, le script collecte les données (en faisant des =du=), les compile et les écrit dans le fichier =data.yaml=. L'option =--human= demande au script de sortir un rapport humainement lisible. Par défaut, le script collecte les données (en faisant des =du=), les compile et les écrit dans le fichier =data.yaml=.
Si les données contenues dans =data.json= ne sont pas plus anciennes que ce que spécifie la configuration =data_cache_ttl= (en jour), alors le script scanne le fichier data.json pour le restituer et n'effectue pas le scan des volumes. Si les données contenues dans =data.json= ne sont pas plus anciennes que ce que spécifie la configuration =data_cache_ttl= (en jour), alors le script scanne le fichier data.json pour le restituer et n'effectue pas le scan des volumes.
** Postgres
Quelle config sur le serveur postgres ? Quelle base et quelles tables créer ?
** Influxdb
Mêmes questions.
* Tester * Tester
** Lancer des tests unitaires ** Lancer des tests unitaires
: pytest : pytest
...@@ -50,6 +42,7 @@ Si les données contenues dans =data.json= ne sont pas plus anciennes que ce que ...@@ -50,6 +42,7 @@ Si les données contenues dans =data.json= ne sont pas plus anciennes que ce que
: docker pull postgres : docker pull postgres
: docker run --name pg -p 5432:5432 -e POSTGRES_PASSWORD=mysecretpassword -d postgres : docker run --name pg -p 5432:5432 -e POSTGRES_PASSWORD=mysecretpassword -d postgres
** Lancer un docker pour influxdb
** Configuration ** Configuration
Un fichier de Configuration pour les tests : Un fichier de Configuration pour les tests :
...@@ -76,8 +69,6 @@ influxdb: ...@@ -76,8 +69,6 @@ influxdb:
user: user user: user
password: secret password: secret
database: sandbox database: sandbox
tags:
- host: resif8.u-ga.fr
metadata: # Information about the gathered data. Used to tag the timeserie values metadata: # Information about the gathered data. Used to tag the timeserie values
permanent_networks: # List all permanent networks here. Otherwise, they will be considered as temporary permanent_networks: # List all permanent networks here. Otherwise, they will be considered as temporary
- CL - CL
...@@ -94,5 +85,4 @@ metadata: # Information about the gathered data. Used to tag the timeserie va ...@@ -94,5 +85,4 @@ metadata: # Information about the gathered data. Used to tag the timeserie va
#+END_EXAMPLE #+END_EXAMPLE
** Tester le programme complet : ** Tester le programme complet :
: python resif_data_reporter.py --config config.yml : python resif_data_reporter.py --config config.yml
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment