Update documentation for the InfluxDB export module

This commit is contained in:
Nicolargo 2014-12-29 22:20:27 +01:00
parent f042b46042
commit 6d8b24148c
2 changed files with 33 additions and 7 deletions

View File

@ -40,6 +40,7 @@ Optional dependencies:
- ``batinfo`` (for battery monitoring support) [Linux-only]
- ``pysnmp`` (for SNMP support)
- ``zeroconf`` and ``netifaces`` (for the auto discoverer mode)
- ``influxdb`` (for the InfluxDB export module)
Installation
============
@ -202,6 +203,11 @@ You can also detect and display all Glances servers available on your network or
And RTFM, always.
Gateway to others services
==========================
Glances can export stats to: CSV file and/or InfluxDB server.
Documentation
=============

View File

@ -150,8 +150,10 @@ Command-Line Options
--enable-history enable the history mode
--path-history PATH_HISTORY
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
-c CLIENT, --client CLIENT
connect to a Glances server by IPv4/IPv6 address or
hostname
@ -665,19 +667,37 @@ Each alert message displays the following information:
4. {min,avg,max} values or number of running processes for monitored
processes list alerts
Other Outputs
=============
Gateway to others services
==========================
*CSV*
It is possible to export statistics to CSV file.
.. code-block:: console
$ glances --output-csv /tmp/glances.csv
$ glances --export-csv /tmp/glances.csv
CSV files have two lines per stats:
CSV file description:
- Stats description (first line)
- Stats (others lines)
- Stats description
- Stats (comma separated)
*InfluxDB*
You can alos 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:
.. code-block:: console
$ glances --export-influxdb
APIs Documentations
===================