diff options
author | nicolargo <nicolargo@nicolargo-boulot.(none)> | 2011-12-20 16:52:56 +0100 |
---|---|---|
committer | nicolargo <nicolargo@nicolargo-boulot.(none)> | 2011-12-20 16:52:56 +0100 |
commit | b2d4c39da38d9b730e2fd9d20f1e47b461d57dac (patch) | |
tree | e48faa9259f3483c9144e952b602931cd93ac840 | |
parent | 03c07679fe2ff68a6a844be21b1a195b1a132d6d (diff) |
Add a french version of the README
-rw-r--r-- | README-fr | 246 | ||||
-rw-r--r--[l---------] | README.md | 218 |
2 files changed, 463 insertions, 1 deletions
diff --git a/README-fr b/README-fr new file mode 100644 index 00000000..5e2a50db --- /dev/null +++ b/README-fr @@ -0,0 +1,246 @@ +Glances -- Votre système en un coups d'oeil +=========================================== + +## Description + +Glances est un logiciel libre (licence LGPL) permettant de surveiller votre +système d'exploitation GNU/Linux ou BSD à partir d'une interface texte. + +Glances utilise la librairie libstatgrab pour récupérer les informations de +votre système. Il est développé en Python. + +![screenshot](https://github.com/nicolargo/glances/raw/master/screenshot.png) + +## Installation + +### Depuis le gestionnaire de paquet de votre système + +Des paquets existent pour plusieurs distributions: Arch, Fedora/Redhat... +Le processus de packaging est actuellement en cours sur d'autres distribs, je +vous conseille donc de rechercher Glances sur votre gestionnaire de package +avant de faire une installation depuis les sources. + +### Depuis les sources + +Le projet Glances est hébergé sur GitHUB: https://github.com/nicolargo/glances + +Pour l'installer, il suffit de suivre les instructions suivantes depuis un +terminal. + +Récupération de la dernière version (1.3.2): + + $ wget https://github.com/downloads/nicolargo/glances/glances-1.3.2.tar.gz + +Procédez ensuite à l'installation: + + $ tar zxvf glances-1.3.2.tar.gz + $ cd glances-1.3.2 + $ ./configure + $ make + $ sudo make install + +Glances a besoin des dépendances suivantes: + +* Python 2.6+ (non testé avec Python 3+) +* libstatgrab 0.16+ +* python-statgrab 0.5+ (ne marchera PAS avec python-statgrab 0.4) + +Notes specifiques pour une installation sous Debian 6. +Debian Squeeze met à disposition la version 0.4 de python-statgrab. +Il faut donc installer la version 0.5 à la main: + + $ sudo apt-get install libstatgrab-dev pkg-config python-dev make + $ wget http://ftp.uk.i-scream.org/sites/ftp.i-scream.org/pub/i-scream/pystatgrab/pystatgrab-0.5.tar.gz + $ tar zxvf pystatgrab-0.5.tar.gz + $ cd pystatgrab-0.5/ + $ ./setup.py build + $ sudo ./setup.py install + +Notes specifiques pour une installation sous Ubuntu 10.04 et 10.10. +Ces versions d'Ubuntu mettent à disposition la version 0.4 de python-statgrab. +Il faut donc installer la version 0.5 à la main: + + $ sudo apt-get update + $ sudo apt-get install pkg-config build-essential autoconf automake python libstatgrab-dev python-all-dev + $ sudo apt-get remove python-statgrab + $ wget http://ftp.uk.i-scream.org/sites/ftp.i-scream.org/pub/i-scream/pystatgrab/pystatgrab-0.5.tar.gz + $ tar zxvf pystatgrab-0.5.tar.gz + $ cd pystatgrab-0.5/ + $ ./setup.py build + $ sudo ./setup.py install + +## Lancement de Glances + +Il suffit de saisir la commande suivante dans une console ou un terminal: + + $ glances.py + +Note: sur certaines distributions, il faut saisir glances en lieu et place +de glances.py. + +## Guide d'utilisation + +Par défaut, l'affichage des statistiques est rafraichi toute les secondes. +Il est possible de changer cette valeur en utilisant l'option -t. +Par exemple pour fixer un taux de rafraichissement à 5 secondes: + + $ glances.py -t 5 + +Les statistiques jugées importantes sont affichées en couleur: + +* VERT: la statistique est "OK" +* BLEU: la statistique est "CAREFUL" (à surveiller) +* VIOLET: la statistique est "WARNING" (en alerte) +* ROUGE: la statistique est "CRITICAL" (critique) + +Quand Glances est lancé, il est possible d'utiliser les touches suivantes: + +* 'a' pour trier la liste des processus de manière automatique: + + Si la CPU totale > 70% alors le tri se fait pas consommation CPU + + si la mémoire total > 70% alors le tri se fait pas consommation MEMOIRE + +* 'c' pour forcer le tri par consommation CPU +* 'm' pour forcer le tri par consommation MEMOIRE +* 'q' sortir de Glances (il est également possible d'utiliser CTRL-C) + +Passons ensuite à la description de la fenêtre de Glances: + +### En-tête + +![screenshot](https://github.com/nicolargo/glances/raw/master/doc/header.png) + +L'en-tête montre la version de Glances, le nom de la machine (FQND) ainsi +qu'une information sur le système d'exploitation (nom, version). + +### CPU + +![screenshot](https://github.com/nicolargo/glances/raw/master/doc/cpu.png) + +L'état de la CPU est affiché par un pourcentage de l'utilisation globale. + +Si user|kernel|nice CPU est < 50%, alors le status est "OK". + +Si user|kernel|nice CPU est > 50%, alors le status est "CAREFUL". + +Si user|kernel|nice CPU est > 70%, alors le status est "WARNING". + +Si user|kernel|nice CPU est > 90%, alors le status est "CRITICAL". + +### Charge (Load) + +![screenshot](https://github.com/nicolargo/glances/raw/master/doc/load.png) + +Il est assez difficile de donner une définition claire de la charge d'une +machine (load average). Sur le blog Nosheep, Zach en donne la définition +suivante: " C'est la somme moyenne du nombre de processus en attente dans +la queue d'execution plus le nombre de processus actuellement en train +d'être executés sur une période de temps de 1, 5 et 15 minutes." + +Glances permet d'afficher les alertes en tenant compte du nombre de coeurs de +votre processeur. Par exemple, le seuil WARNING sera de 2 pour un processeur +Bi-Core alors qu'il sera de 4 sur un Quad-Core. + +Si la charge moyenne est < O.7*Core, alors le status est "OK". + +Si la charge moyenne est > O.7*Core, alors le status est "CAREFUL". + +Si la charge moyenne est > 1*Core, alors le status est "WARNING". + +Si la charge moyenne est > 5*Core, alors le status est "CRITICAL". + +### Mémoire + +![screenshot](https://github.com/nicolargo/glances/raw/master/doc/mem.png) + +Glances affiche 3 types d'informations pour la mémoire: RAM, SWAP et réelle. + +La mémoire réelle occupée est calculée ainsi = used - cache. + +La mémoire réelle libre est calculée ainsi = free + cache. + +Les alertes utilisent les seuils suivants: + +Si la mémoire est < 50%, alors le status "OK". + +Si la mémoire est > 50%, alors le status "CAREFUL". + +Si la mémoire est > 70%, alors le status "WARNING". + +Si la mémoire est > 90%, alors le status "CRITICAL". + +### Débits des interfaces réseau + +![screenshot](https://github.com/nicolargo/glances/raw/master/doc/network.png) + +Glances affiche les débits des interfaces réseau en adaptant dynamiquement +l'unité à utiliser (bits par seconde). + +Les alertes ne sont affichées que pour les interfaces dont les informations +sur la vitesse maximale sont disponibles (cela dépend des distributions): + +Si le débit < 50%, alors le status est "OK". + +Si le débit > 50%, alors le status est "CAREFUL". + +Si le débit > 70%, alors le status est "WARNING". + +Si le débit > 90%, alors le status est "CRITICAL". + +Par exemple, sur une interface Ethernet Fast Ethernet (100 Mbps), le status +passera à WARNING si le débit dépasse les 70 Mbps. + +### Entrées/Sorties disque + +![screenshot](https://github.com/nicolargo/glances/raw/master/doc/diskio.png) + +Glances permet d'afficher les débits en lecture et écriture sur les disques +en adaptant dynamiquement l'unité à utiliser (octets par seconde). + +Il n'y a pas d'alerte remontée pour ce type d'information. + +### Espace sur les systèmes de fichiers + +![screenshot](https://github.com/nicolargo/glances/raw/master/doc/fs.png) + +Glances affiche par système de fichiers l'espace disque total et utilisé. +L'unité est automatiquement adaptée (octets par seconde). + +Les alertes sont remontées sur l'espace disque utilisé: + +Si l'espace disque utilisé est < 50%, alors le status est "OK". + +Si l'espace disque utilisé est > 50%, alors le status est "CAREFUL". + +Si l'espace disque utilisé est > 70%, alors le status est "WARNING". + +Si l'espace disque utilisé est > 90%, alors le status est "CRITICAL". + +### Les processus + +![screenshot](https://github.com/nicolargo/glances/raw/master/doc/processlist.png) + +Glances affiche un résumé sur l'état des processus ainsi qu'une liste +détaillée. + +Le nombre des processus affichés est adapté à la taille de la fenêtre. + +### Pied de page + +![screenshot](https://github.com/nicolargo/glances/raw/master/doc/footer.png) + +Glances y affiche la légende (rappel des codes des couleurs) ainsi que la +date et l'heure courante. + +## A faire... + +J'ai besoin de contributeurs pour faire évoluer Glances. + +Notamment: + +* Packaging pour Debian, Ubuntu, BSD et toutes autres distributions +* Controle de la présence des librairie dans le fichier configure.ac +* Inclure les stats de FS directement dans python-statgrab +* Ajout d'une fenêtre d'aide +* Optimisation du code diff --git a/README.md b/README.md index 100b9382..cb4f4c6f 120000..100644 --- a/README.md +++ b/README.md @@ -1 +1,217 @@ -README
\ No newline at end of file +Glances -- Eye on your system +============================= + +## Description + +Glances is a CLI curses based monitoring tool for GNU/Linux or BSD OS. + +Glances uses the libstatgrab library to get information from your system. +It is developed in Python and uses the python-statgrab lib. + +![screenshot](https://github.com/nicolargo/glances/raw/master/screenshot.png) + +## Installation + +### From package manager + +Packages exist for Arch, Fedora, Redhat ... + +### From source + +Get the latest version: + + $ wget https://github.com/downloads/nicolargo/glances/glances-1.3.2.tar.gz + +Glances use a standard GNU style installer: + + $ tar zxvf glances-1.3.2.tar.gz + $ cd glances-1.3.2 + $ ./configure + $ make + $ sudo make install + +Pre-requisites: + +* Python 2.6+ (not tested with Python 3+) +* python-statgrab 0.5+ (did NOT work with python-statgrab 0.4) + +Notes: For Debian. +The Debian Squeeze repos only include the python-statgrab 0.4. +You had to install the version 0.5 using the following commands: + + $ sudo apt-get install libstatgrab-dev pkg-config python-dev make + $ wget http://ftp.uk.i-scream.org/sites/ftp.i-scream.org/pub/i-scream/pystatgrab/pystatgrab-0.5.tar.gz + $ tar zxvf pystatgrab-0.5.tar.gz + $ cd pystatgrab-0.5/ + $ ./setup.py build + $ sudo ./setup.py install + +Notes: For Ubuntu 10.04 and 10.10. +The instruction to install the version 0.5 are here: +https://github.com/nicolargo/glances/issues/5#issuecomment-3033194 + +## Running + +Easy: + + $ glances.py + +## User guide + +By default, stats are refreshed every second, to change this setting, you can +use the -t option. For exemple to set the refrech rate to 5 seconds: + + $ glances.py -t 5 + +Importants stats are colored: + +* GREEN: stat counter is "OK" +* BLUE: stat counter is "CAREFUL" +* MAGENTA: stat counter is "WARNING" +* RED: stat counter is "CRITICAL" + +When Glances is running, you can press: + +* 'a' to set the automatic mode. The processes are sorted automatically + + If CPU > 70%, sort by process "CPU consumption" + + If MEM > 70%, sort by process "memory size" + +* 'c' to sort the processes list by CPU consumption +* 'm' to sort the processes list by process size +* 'q' Exit + +### Header + +![screenshot](https://github.com/nicolargo/glances/raw/master/doc/header.png) + +The header shows the Glances version, the host name and the operating +system name, version and architecture. + +### CPU + +![screenshot](https://github.com/nicolargo/glances/raw/master/doc/cpu.png) + +The CPU states are shown as a percentage and for the configured refresh +time. + +If user|kernel|nice CPU is < 50%, then status is set to "OK". + +If user|kernel|nice CPU is > 50%, then status is set to "CAREFUL". + +If user|kernel|nice CPU is > 70%, then status is set to "WARNING". + +If user|kernel|nice CPU is > 90%, then status is set to "CRITICAL". + +### Load + +![screenshot](https://github.com/nicolargo/glances/raw/master/doc/load.png) + +On the Nosheep blog, Zach defines the average load: "In short it is the +average sum of the number of processes waiting in the run-queue plus the +number currently executing over 1, 5, and 15 minute time periods." + +Glances gets the number of CPU cores to adapt the alerts. With Glances, +alerts on average load are only set on 5 and 15 mins. + +If average load is < O.7*Core, then status is set to "OK". + +If average load is > O.7*Core, then status is set to "CAREFUL". + +If average load is > 1*Core, then status is set to "WARNING". + +If average load is > 5*Core, then status is set to "CRITICAL". + +### Memory + +![screenshot](https://github.com/nicolargo/glances/raw/master/doc/mem.png) + +Glances uses tree columns: memory (RAM), swap and "real". + +Real used memory is: used - cache. + +Real free memory is: free + cache. + +With Glances, alerts are only set for on used swap and real memory. + +If memory is < 50%, then status is set to "OK". + +If memory is > 50%, then status is set to "CAREFUL". + +If memory is > 70%, then status is set to "WARNING". + +If memory is > 90%, then status is set to "CRITICAL". + +### Network bit rate + +![screenshot](https://github.com/nicolargo/glances/raw/master/doc/network.png) + +Glances display the network interface bit rate. The unit is adapted +dynamicaly (bits per second, Kbits per second, Mbits per second...). + +Alerts are set only if the network interface maximum speed is available. + +If bitrate is < 50%, then status is set to "OK". + +If bitrate is > 50%, then status is set to "CAREFUL". + +If bitrate is > 70%, then status is set to "WARNING". + +If bitrate is > 90%, then status is set to "CRITICAL". + +For exemple, on a 100 Mbps Ethernet interface, the warning status is set +if the bit rate is higher than 70 Mbps. + +### Disk I/O + +![screenshot](https://github.com/nicolargo/glances/raw/master/doc/diskio.png) + +Glances display the disk I/O throughput. The unit is adapted dynamicaly +(bytes per second, Kbytes per second, Mbytes per second...). + +There is no alert on this information. + +### Filesystem + +![screenshot](https://github.com/nicolargo/glances/raw/master/doc/fs.png) + +Glances display the total and used filesytem disk space. The unit is +adapted dynamicaly (bytes per second, Kbytes per second, Mbytes per +second...). + +Alerts are set for used disk space: + +If disk used is < 50%, then status is set to "OK". + +If disk used is > 50%, then status is set to "CAREFUL". + +If disk used is > 70%, then status is set to "WARNING". + +If disk used is > 90%, then status is set to "CRITICAL". + +### Processes + +![screenshot](https://github.com/nicolargo/glances/raw/master/doc/processlist.png) + +Glances displays a summary and a list of processes. + +By default (or if you hit the 'a' key) the process list is automaticaly +sorted by CPU of memory consumption. + +The number of processes in the list is adapted to the screen size. + +### Footer + +![screenshot](https://github.com/nicolargo/glances/raw/master/doc/footer.png) + +Glances displays a caption and the current time/date. + +## Todo + +You are welcome to contribute to this software. + +* Packaging for Debian, Ubuntu, BSD... +* Check the needed Python library in the configure.ac +* Add file system stats when the python-statgrab is corrected +* Add a user guide window |