From c7fad235f30fb8894802da66e4f2c13eb4d04297 Mon Sep 17 00:00:00 2001 From: Nicolargo Date: Sat, 31 Jan 2015 13:45:48 +0100 Subject: Update docs file for the 2.3 version --- AUTHORS | 3 ++ MANIFEST.in | 1 + README.rst | 13 ++++- docs/glances-doc.html | 132 +++++++++++++++++++++++++++++++++++++++++-------- docs/glances-doc.rst | 4 ++ docs/images/docker.png | Bin 60028 -> 69810 bytes docs/images/raid.png | Bin 0 -> 5585 bytes glances/__init__.py | 2 +- man/glances.1 | 2 +- requirements.txt | 2 +- setup.py | 2 +- 11 files changed, 135 insertions(+), 26 deletions(-) create mode 100644 docs/images/raid.png diff --git a/AUTHORS b/AUTHORS index bb405e52..528226a5 100644 --- a/AUTHORS +++ b/AUTHORS @@ -21,6 +21,9 @@ https://github.com/jrenner Maxime Desbrus (aka) desbma https://github.com/desbma +Nicolas Hart (aka) NclsHart for the UI design +https://github.com/nclsHart + ========= Packagers ========= diff --git a/MANIFEST.in b/MANIFEST.in index dae6a3d7..98cb6021 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -4,6 +4,7 @@ include NEWS include README.rst include conf/glances.conf include glances/outputs/bottle/*.tpl +include glances/outputs/static/*.ico include glances/outputs/static/css/*.css include glances/outputs/static/js/*.js include man/glances.1 diff --git a/README.rst b/README.rst index 4db9f2c5..56dc977d 100644 --- a/README.rst +++ b/README.rst @@ -13,8 +13,6 @@ Glances - An eye on your system .. image:: https://pypip.in/d/Glances/badge.png :target: https://pypi.python.org/pypi/Glances/ :alt: Downloads -.. image:: https://badges.gitter.im/Join%20Chat.svg - :target: https://gitter.im/nicolargo/glances?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge Follow Glances on Twitter: `@nicolargo`_ or `@glances_system`_ @@ -233,6 +231,16 @@ Gateway to other services Glances can export stats to: ``CSV`` file, ``InfluxDB`` and ``StatsD`` server. +How to contribute ? +=================== + +If you want to contribute to the Glances project, read this `Wiki`_ page. + +There is also a chat dedicated to the Glances' developpers: + +.. image:: https://badges.gitter.im/Join%20Chat.svg + :target: https://gitter.im/nicolargo/glances?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge + Author ====== @@ -249,3 +257,4 @@ LGPL. See ``COPYING`` for more details. .. _@glances_system: https://twitter.com/glances_system .. _glances-doc: https://github.com/nicolargo/glances/blob/master/docs/glances-doc.rst .. _forum: https://groups.google.com/forum/?hl=en#!forum/glances-users +.. _Wiki: https://github.com/nicolargo/glances/wiki/How-to-contribute-to-Glances-%3F \ No newline at end of file diff --git a/docs/glances-doc.html b/docs/glances-doc.html index a4462130..35f786b0 100644 --- a/docs/glances-doc.html +++ b/docs/glances-doc.html @@ -123,9 +123,9 @@ td.option-group {

Glances

-

This manual describes Glances version 2.2.

-

Copyright © 2012-2014 Nicolas Hennion <nicolas@nicolargo.com>

-

December 2014

+

This manual describes Glances version 2.3.

+

Copyright © 2011-2015 Nicolas Hennion <nicolas@nicolargo.com>

+

January 2015

@@ -235,6 +237,7 @@ device with a web browser, just run the server with the @server is the IP address or hostname of the server.

+

To change the refresh rate of the page, just add the period in seconds between refreshes at the end of the URL, ie. to refresh every 10s, use http://@server:61208/10.

The Glances web interface follows responsive web design principles.

Screenshot from Chrome on Android

images/screenshot-web2.png @@ -308,10 +311,18 @@ http://@server:61208  Set the export path for graph history ---output-csv OUTPUT_CSV +--export-csv CSV_FILE  export stats to a CSV file +--export-influxdb + + export stats to an InfluxDB server + +--export-statsd + + export stats to a Statsd server + -c CLIENT, --client CLIENT  connect to a Glances server by IPv4/IPv6 address or @@ -442,7 +453,7 @@ Filter is a regular expression pattern:

F
Switch between FS used and free space
g
-
Generate hraphs for current history
+
Generate graphs for current history
h
Show/hide the help screen
i
@@ -532,6 +543,28 @@ cp /usr/share/doc/glances/glances.conf $XDG_CONFIG_HOME/glances/

On OS X, you should copy the configuration file to ~/Library/Application Support/glances/.

+

Configuration file description

+

Each plugin and export module can have a section.

+

Example for the CPU plugin:

+
+[cpu]
+user_careful=50
+user_warning=70
+user_critical=90
+iowait_careful=50
+iowait_warning=70
+iowait_critical=90
+system_careful=50
+system_warning=70
+system_critical=90
+steal_careful=50
+steal_warning=70
+steal_critical=90
+
+

By default Steal CPU time alerts aren't logged. If you want to enable log/alert, just add:

+
+steal_log=True
+

Logs and debug mode

@@ -550,6 +583,7 @@ can ben logged using the -d option on the command line.

+

If glances.log is not writable, a new file will be created and returned to the user console.

Anatomy Of The Application

@@ -667,6 +701,8 @@ adapted dynamically.

Note: limit values can be overwritten in the configuration file under the [filesystem] section.

+

If a RAID controller is detected on you system, its status will be displayed:

+images/raid.png

Sensors

@@ -833,30 +869,86 @@ progress processes list alerts
+
+

Docker

+

If you use Docker, Glances can help you to monitor your container. Glances uses the Docker API through the Docker-Py library.

+images/docker.png +
+
+

Actions

+

Glances can trigger actions on events.

+

By action, we mean all shell command line. For example, if you want to execute the foo.py script if the last 5 minutes load are critical then add the action line to the Glances configuration file:

+
+[load]
+critical=5.0
+critical_action=python /path/to/foo.py
+
+

All the stats are available in the command line through the use of the {{mustache}} syntax. Another example to create a log file containing used vs total disk space if a space trigger warning is reached:

+
+[fs]
+warning=70
+warning_action=echo {{mnt_point}} {{used}}/{{size}} > /tmp/fs.alert
+
+

Note: You can use all the stats for the current plugin (see https://github.com/nicolargo/glances/wiki/The-Glances-2.x-API-How-to for the stats list)

+
-
-

Other Outputs

+
+

Gateway to others services

+

CSV

It is possible to export statistics to CSV file.

-$ glances --output-csv /tmp/glances.csv
+$ glances --export-csv /tmp/glances.csv
+
+

CSV file description: +- Stats description (first line) +- Stats (others lines)

+

InfluxDB

+

You can export statistics to an InfluxDB server (time series server). The connection should be defined in the Glances configuration file as following:

+
+[influxdb]
+host=localhost
+port=8086
+user=root
+password=root
+db=glances
+
+

and run Glances with:

+
+$ glances --export-influxdb
+
+

Statsd

+

You can export statistics to a Statsd server (welcome to Graphite !). The connection should be defined in the Glances configuration file as following:

+
+[statsd]
+host=localhost
+port=8125
+prefix=glances
+
+

Note: the prefix option is optionnal ('glances by default')

+

and run Glances with:

+
+$ glances --export-statsd
+
+

Glances will generate stats as:

+
+'glances.cpu.user': 12.5,
+'glances.cpu.total': 14.9,
+'glances.load.cpucore': 4,
+'glances.load.min1': 0.19,
+...
-

CSV files have two lines per stats:

-
    -
  • Stats description
    • -
  • Stats (comma separated)
    • -
-

APIs Documentations

-

Glances includes a XML-RPC server and a RESTFULL-JSON API which and can be used by another client software.

+

APIs Documentations

+

Glances includes a XML-RPC server and a RESTFUL-JSON API which and can be used by another client software.

APIs documentations are available at:

-

Support

+

Support

To post a question about Glances use case, please post it to the offical Q&A forum.

To report a bug or a feature request use the bug tracking system at https://github.com/nicolargo/glances/issues.

diff --git a/docs/glances-doc.rst b/docs/glances-doc.rst index 3c36f7fe..65377b34 100644 --- a/docs/glances-doc.rst +++ b/docs/glances-doc.rst @@ -514,6 +514,10 @@ Alerts are set for used disk space. *Note*: limit values can be overwritten in the configuration file under the ``[filesystem]`` section. +If a RAID controller is detected on you system, its status will be displayed: + +.. image:: images/raid.png + Sensors ------- diff --git a/docs/images/docker.png b/docs/images/docker.png index e8115359..4e64168e 100644 Binary files a/docs/images/docker.png and b/docs/images/docker.png differ diff --git a/docs/images/raid.png b/docs/images/raid.png new file mode 100644 index 00000000..fc9bd12b Binary files /dev/null and b/docs/images/raid.png differ diff --git a/glances/__init__.py b/glances/__init__.py index 55d49380..30636edb 100644 --- a/glances/__init__.py +++ b/glances/__init__.py @@ -20,7 +20,7 @@ """Init the Glances software.""" __appname__ = 'glances' -__version__ = '2.3_RC2' +__version__ = '2.3' __author__ = 'Nicolas Hennion ' __license__ = 'LGPL' diff --git a/man/glances.1 b/man/glances.1 index a606c7c5..3a717659 100644 --- a/man/glances.1 +++ b/man/glances.1 @@ -1,4 +1,4 @@ -.TH glances 1 "December, 2014" "version 2.2" "USER COMMANDS" +.TH glances 1 "January, 2015" "version 2.3" "USER COMMANDS" .SH NAME glances \- A cross-platform curses-based system monitoring tool .SH SYNOPSIS diff --git a/requirements.txt b/requirements.txt index 52546a76..7a795604 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1 @@ -psutil==2.1.3 +psutil==2.2.0 diff --git a/setup.py b/setup.py index 0b35db6e..13c69513 100755 --- a/setup.py +++ b/setup.py @@ -52,7 +52,7 @@ def get_requires(): setup( name='Glances', - version='2.3RC2', + version='2.3R', description="A cross-platform curses-based monitoring tool", long_description=open('README.rst').read(), author='Nicolas Hennion', -- cgit v1.2.3