openstack/aodh
Code Issues Proposed changes

Document user-defined metadata for swift samples

Browse Source 
Add a brief documentation on how to configure and use
user-defined metadata for swift samples based on
'metadata_headers' property in swift middleware.

Change-Id: I365db3fda74a6e6ef0e8bcfbad917bcdac8e02ee
This commit is contained in:
Roman Bogorodskiy 2013-11-18 07:14:13 +00:00
parent 4a638fab63
commit b741a57237
2 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/install/manual.rst
View File

@ -64,6 +64,13 @@ Installing the Collector
And adding ``ceilometer`` in the ``pipeline`` of that same file, right And adding ``ceilometer`` in the ``pipeline`` of that same file, right
before ``proxy-server``. before ``proxy-server``.
Additionally, if you want to store extra metadata from headers, you need
to set ``metadata_headers`` so it would look like::
[filter:ceilometer]
use = egg:ceilometer#swift
metadata_headers = X-FOO, X-BAR
4. Install MongoDB. 4. Install MongoDB.
Follow the instructions to install the MongoDB_ package for your Follow the instructions to install the MongoDB_ package for your

16
doc/source/measurements.rst
View File

@ -198,7 +198,7 @@ If you plan on adding meters, please follow the convention bellow:
3. If you have any hesitation, come and ask in #openstack-metering 3. If you have any hesitation, come and ask in #openstack-metering
User-defined sample metadata (nova only) User-defined sample metadata for Nova
========================================= =========================================
Users are allowed to add additional metadata to samples of nova meter. Users are allowed to add additional metadata to samples of nova meter.
@ -210,3 +210,17 @@ To do so, users should add nova user metadata prefixed with 'metering.':
Note: The name of the metadata shouldn't exceed 256 characters otherwise it will be cut off. 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. Also, if it has '.', this will be replaced by a '_' in ceilometer.
User-defined sample metadata for Swift
==========================================
It's possible to add additional metadata to sample of Swift meter as well.
You might specify headers whose values will be stored in resource_metadata as
'resource_metadata.http_header_$name', where $name is a name of the header with
'-' replaced by '_'.
This is done using 'metadata_headers' option in middleware configuration,
refer to :ref:`installing_manually` for details.
For example, this could be used to distinguish external and internal users. You'd
have to implement a custom Swift middleware that sets a proper header and just add
it to metadata_headers.