x/collectd-openstack-plugins
Code Issues Proposed changes

COLLECTD_CUSTOMIZE_UNITS -> COLLECTD_CUSTOM_UNITS

Browse Source 
- Change the config variable name.
  - The config variable no longer references ceilometer.
  - It is now clearer that the config variable is for all plugins
  - The variable is a noun instead of a verb, so it's clearer that
    this is something to define, instead of a boolean.

- Update docs
  - Added a clarification on the format of the custom unit definition.
  - Corrected incorrect reference to COLLECTD_CEILOMETER_UNITS in
    devstackGSG.rst and usage.rst

Closes-Bug: #1656877
Change-Id: Ie688397242d57cf0fee6629fafb89afd8899a599
This commit is contained in:
Emma Foley 2017-01-16 13:48:41 +00:00
parent 1e64bdeb1e
commit 4f1d999665
3 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
devstack/settings
View File

@ -28,4 +28,4 @@ if [ -z $COLLECTD_CONF_DIR ]; then
fi fi
#Custom units feature #Custom units feature
COLLECTD_CEILOMETER_UNITS=${COLLECTD_CUSTOMIZE_UNITS:-none} COLLECTD_CEILOMETER_UNITS=${COLLECTD_CUSTOM_UNITS:-none}

4
doc/source/devstackGSG.rst
View File

@ -71,9 +71,9 @@ To enable this feature execute the following instructions:
* To include your new units, add the following line with your chosen units to * To include your new units, add the following line with your chosen units to
your local.conf file. your local.conf file.
| COLLECTD_CEILOMETER_UNITS="<meter> <unit>" | COLLECTD_CUSTOM_UNITS="<meter> <unit>"
If you would like to add more than one new unit include them in the same line If you would like to add more than one new unit include them in the same line
and seperate each meter and its unit with a comma, as shown below. and seperate each meter and its unit with a comma, as shown below.
| COLLECTD_CEILOMETER_UNITS="<meter> <unit>,<meter> <unit>" | COLLECTD_CUSTOM_UNITS="<meter> <unit>,<meter> <unit>"

6
doc/source/usage.rst
View File

@ -61,11 +61,13 @@ COLLECTD_LOG_LEVEL
Default: info Default: info
COLLECTD_CEILOMETER_UNITS COLLECTD_CUSTOM_UNITS
(meter=unit) a comma seperated list of pairs, defining meters and their units. (meter=unit) a comma seperated list of pairs, defining meters and their units.
Allows existing units to be changed and new units to be set for new meters. Allows existing units to be changed and new units to be set for new meters.
The "meter" is generally in the form of "plugin.type", where plugin and
plugin type are attributes of the collectd data.
Example: COLLECTD_CEILOMETER_UNITS="<meter> <unit>,<meter> <unit>" Example: COLLECTD_CUSTOM_UNITS="<meter> <unit>,<meter> <unit>"
Authenticating using Identity Server API v3 Authenticating using Identity Server API v3