openstack/aodh
Code Issues Proposed changes

Add documentation on nova user defined metadata

Browse Source 
This change add explaination about the special 'metering.'
nova metadata.

DocImpact

Change-Id: Ia87da80fb63eb7a7559e5a5a41182ba51653c520
This commit is contained in:
Mehdi Abaakouk 2013-07-24 12:26:53 +02:00
parent 48e4250845
commit 71e417263d
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/measurements.rst
View File

@ -187,3 +187,17 @@ If you plan on adding meters, please follow the convention bellow:
For example do not use <type>.image but image:<type>, 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.