From 71e417263dce7d4221a9478a4a5c593dda47dd24 Mon Sep 17 00:00:00 2001 From: Mehdi Abaakouk Date: Wed, 24 Jul 2013 12:26:53 +0200 Subject: [PATCH] Add documentation on nova user defined metadata This change add explaination about the special 'metering.' nova metadata. DocImpact Change-Id: Ia87da80fb63eb7a7559e5a5a41182ba51653c520 --- doc/source/measurements.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/doc/source/measurements.rst b/doc/source/measurements.rst index 9a45a012e..6dc964b95 100644 --- a/doc/source/measurements.rst +++ b/doc/source/measurements.rst @@ -187,3 +187,17 @@ If you plan on adding meters, please follow the convention bellow: For example do not use .image but image:, where type is your variable name. 3. If you have any hesitation, come and ask in #openstack-metering + + +User-defined sample metadata (nova only) +========================================= + +Users are allowed to add additional metadata to samples of nova meter. +These additional metadata are stored in 'resource_metadata.user_metadata.*' of the sample +To do so, users should add nova user metadata prefixed with 'metering.': + +:: + $ nova boot --meta metering.custom_metadata=a_value my_vm + +Note: The name of the metadata shouldn't exceed 256 characters otherwise it will be cut off. +Also, if it has '.', this will be replaced by a '_' in ceilometer.