summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNicolargo <nicolas@nicolargo.com>2014-12-31 11:24:46 +0100
committerNicolargo <nicolas@nicolargo.com>2014-12-31 11:24:46 +0100
commit263bcda63f146f35390f44460ecdab49717eb8a4 (patch)
treef5c8b193a1b80555cee0fe3c567d60167fddf4d5
parentc90fde2f1281f4140e9715e7ec8a991c781ac681 (diff)
Update doc for Statsd export module
-rw-r--r--docs/glances-doc.rst30
1 files changed, 29 insertions, 1 deletions
diff --git a/docs/glances-doc.rst b/docs/glances-doc.rst
index c13e4e54..9a056682 100644
--- a/docs/glances-doc.rst
+++ b/docs/glances-doc.rst
@@ -154,6 +154,8 @@ Command-Line Options
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
hostname
@@ -684,7 +686,7 @@ CSV file description:
*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:
+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
@@ -699,6 +701,32 @@ 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:
+
+.. code-block:: console
+
+ $ 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,
+ ...
+
+
APIs Documentations
===================