radoslaw kuschel ccdb19bb28 Added missing documentation
- Adding documentation for config options
- Adding contact information to README.rst

Change-Id: I966bc07071b13e93cbc3274a9ef91280117d8dba
Partial-Bug: #1568178
2016-07-22 14:50:35 +01:00

43 lines
1.1 KiB
ReStructuredText

========
Usage
========
To use collectd-ceilometer-plugin in collectd::
Python plugin must be enabled in collectd
collectd must be started
(ex: systemctl start collectd)
local.conf settings
-------------------
COLLECTD_CONF_DIR
(directory) Specify a directory where collectd conf files reside.
This is required if you use a distro other than Ubuntu or Fedora, or if
the config file is in a non default location.
Default: /etc/collectd/collectd.conf.d (Ubuntu) /etc/collect.d (Fedora)
COLLECTD_INSTALL
(True|False) Indicates whether to install collectd from package manager.
Set this to False if you are running a custom collectd build or do not
want to upgrade installed version.
Default: True
COLLECTD_BATCH_SIZE
Set the amount of samples to be buffered before sending.
Default: 1 i.e. no batching/buffering.
COLLECTD_DIR
Specify collectd directory, this is required if collectd was installed
manually.
Default: /opt/collectd
CEILOMETER_TIMEOUT
Sets the ceilometer's request timeout. The value is passed in milliseconds.
Default: 1000 i.e. 1 sec.