From 4f1d9996654387abd1d90b7b61123d40e2356429 Mon Sep 17 00:00:00 2001 From: Emma Foley Date: Mon, 16 Jan 2017 13:48:41 +0000 Subject: [PATCH] COLLECTD_CUSTOMIZE_UNITS -> COLLECTD_CUSTOM_UNITS - 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 --- devstack/settings | 2 +- doc/source/devstackGSG.rst | 4 ++-- doc/source/usage.rst | 6 ++++-- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/devstack/settings b/devstack/settings index 2c1bae2..c4ff3cb 100644 --- a/devstack/settings +++ b/devstack/settings @@ -28,4 +28,4 @@ if [ -z $COLLECTD_CONF_DIR ]; then fi #Custom units feature -COLLECTD_CEILOMETER_UNITS=${COLLECTD_CUSTOMIZE_UNITS:-none} +COLLECTD_CEILOMETER_UNITS=${COLLECTD_CUSTOM_UNITS:-none} diff --git a/doc/source/devstackGSG.rst b/doc/source/devstackGSG.rst index 1ced33f..ed96eac 100644 --- a/doc/source/devstackGSG.rst +++ b/doc/source/devstackGSG.rst @@ -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 your local.conf file. -| COLLECTD_CEILOMETER_UNITS=" " +| COLLECTD_CUSTOM_UNITS=" " 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. -| COLLECTD_CEILOMETER_UNITS=" , " +| COLLECTD_CUSTOM_UNITS=" , " diff --git a/doc/source/usage.rst b/doc/source/usage.rst index ef463e4..e3c1b5b 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -61,11 +61,13 @@ COLLECTD_LOG_LEVEL Default: info -COLLECTD_CEILOMETER_UNITS +COLLECTD_CUSTOM_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. + 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=" , " + Example: COLLECTD_CUSTOM_UNITS=" , " Authenticating using Identity Server API v3