glances/docs
Gergő Nagy 761036985a 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>
2016-03-25 11:06:25 +01:00
..
_static Use Sphinx for doc 2016-03-06 19:16:37 +01:00
_templates Use Sphinx for doc 2016-03-06 19:16:37 +01:00
aoa Use Sphinx for doc 2016-03-06 19:16:37 +01:00
gw exports: riemann export implemented and documented 2016-03-25 11:06:25 +01:00
man exports: riemann export implemented and documented 2016-03-25 11:06:25 +01:00
api.rst Use Sphinx for doc 2016-03-06 19:16:37 +01:00
cmds.rst exports: riemann export implemented and documented 2016-03-25 11:06:25 +01:00
conf.py Fix Sphinx doc/man generation 2016-03-12 15:43:43 +01:00
config.rst Use Sphinx for doc 2016-03-06 19:16:37 +01:00
glances.rst Use Sphinx for man page 2016-03-06 19:16:37 +01:00
index.rst Use Sphinx for doc 2016-03-06 19:16:37 +01:00
make.bat Use Sphinx for doc 2016-03-06 19:16:37 +01:00
Makefile Fix version issue with Sphinx (hopefully) 2016-03-12 11:51:42 +01:00
quickstart.rst Use Sphinx for doc 2016-03-06 19:16:37 +01:00
README.txt Fix Sphinx doc/man generation 2016-03-12 15:43:43 +01:00
support.rst Use Sphinx for doc 2016-03-06 19:16:37 +01:00

Building the docs
=================

First install Sphinx:

    pip install sphinx

or update it if already installed:

    pip install --upgrade sphinx

Go to the docs folder:

    cd docs

Then build the HTML documentation:

    make html

and the man page:

    LC_ALL=C make man