summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorGergő Nagy <gnagy@aiss.hu>2016-03-25 11:06:25 +0100
committerGergő Nagy <gnagy@aiss.hu>2016-03-25 11:06:25 +0100
commit761036985a543b71f6d7ccfea28a74343965c954 (patch)
tree639c3c8d0cc963de9708ae79491c28bfea6719b1 /README.rst
parenta583aeb8195f36483a07cf9c34dcb5cb8f5ab11f (diff)
exports: riemann export implemented and documented
This patch introduces a new export method for sending metrics to __Riemann__ server using _TCP_ protocol. The module can be enabled like all the other exports in __Glances__, specifying the `--export-riemann` option. Sending metrics to Riemann requires [bernhard](https://github.com/banjiewen/bernhard) that is the most popular _Riemann client_ written in python. In the configuration file you can only specify the `host` and `port` that riemann is listening for new connections on. Later new options are planned to be added like __SSL__ support and __UDP__. Documentation and manpages are refreshed according to the modifications in the config options and introducing the usage of Riemann export. Signed-off-by: Gergő Nagy <grigori.grant@gmail.com>
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst25
1 files changed, 24 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 73e39deb..f5fdd494 100644
--- a/README.rst
+++ b/README.rst
@@ -50,6 +50,7 @@ Optional dependencies:
- ``docker-py`` (for the Docker monitoring support) [Linux-only]
- ``matplotlib`` (for graphical/chart support)
- ``pika`` (for the RabbitMQ/ActiveMQ export module)
+- ``bernhard`` (for the Riemann export module)
- ``py-cpuinfo`` (for the Quicklook CPU info module)
- ``scandir`` (for the Folders plugin) [Only for Python < 3.5]
@@ -223,6 +224,28 @@ Puppet
You can install Glances using ``Puppet``: https://github.com/rverchere/puppet-glances
+Known issue on RHEL/CentOS/Fedora installation
+==============================================
+
+For Python 2.6 RedHat-based distros there might be an issue with starting Glances:
+
+```
+Traceback (most recent call last):
+File "/usr/bin/glances", line 5, in <module>
+from pkg_resources import load_entry_point
+File "/usr/lib/python2.6/site-packages/pkg_resources.py", line 2655, in <module>
+workingset.require(_requires)
+File "/usr/lib/python2.6/site-packages/pkg_resources.py", line 648, in require
+needed = self.resolve(parse_requirements(requirements))
+File "/usr/lib/python2.6/site-packages/pkg_resources.py", line 546, in resolve
+raise DistributionNotFound(req)
+pkg_resources.DistributionNotFound: argparse
+```
+
+Try upgrading setuptools, has been proven to solve the problem:
+
+ sudo pip install -U setuptools
+
Usage
=====
@@ -274,7 +297,7 @@ Gateway to other services
=========================
Glances can export stats to: ``CSV`` file, ``InfluxDB``, ``OpenTSDB``,
-``StatsD``, ``ElasticSearch`` and ``RabbitMQ`` server.
+``StatsD``, ``RabbitMQ`` and ``Riemann`` server.
How to contribute ?
===================