Skip to content

Commit

Permalink
Update the vPoller Helpers documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dnaeon committed Sep 9, 2014
1 parent ca6b0d4 commit 0acafc2
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/helpers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,32 @@ supported ``vPoller Helpers`` along with a short description:
| vpoller.helpers.csvhelper | Helper which returns result in CSV format |
+---------------------------+--------------------------------------------------------+

The ``vPoller Helpers`` are simply Python modules and are
loaded by the ``vPoller Workers`` upon startup.

Enabling helpers
================

In order to enable helpers in your ``vPoller Workers`` you need to
specify in the ``vpoller.conf`` file the helper modules, which you
wish to be loaded and available to clients.

Here is a sample ``vpoller.conf`` file which includes the ``helpers``
configuration option for loading the ``zabbix`` helper
module in your ``vPoller Worker``:

.. code-block:: ini
[proxy]
frontend = tcp://*:10123
backend = tcp://*:10124
mgmt = tcp://*:9999
[worker]
db = /var/lib/vconnector/vconnector.db
proxy = tcp://localhost:10124
mgmt = tcp://*:10000
helpers = vpoller.helpers.zabbix
vPoller Zabbix Helper
=====================

Expand Down

0 comments on commit 0acafc2

Please sign in to comment.