summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRafael Weingärtner <rafael@apache.org>2020-05-29 12:05:31 -0300
committerRafael Weingärtner <rafael@apache.org>2020-05-29 12:11:17 -0300
commit1a4ab34df565fa00dc72edfd263afc56276f7621 (patch)
tree1c748de24d11e875cf71002e19b6a9ede24f4f80 /doc
parent2dcd15a46661026cf2f88de66f834b46151f59f1 (diff)
downloadceilometer-1a4ab34df565fa00dc72edfd263afc56276f7621.tar.gz
Enable OpenStack pollster to configure Ids(project, user, and resource)
This pull request enables OpenStack pollsters to configure Ids(project, user, and resource) as the non-openstack pollster. This is useful as some of the OpenStack APIs use other keys to represent values such as project_id and user_id. Change-Id: Id5ae1720ad714675722bc857a142d7bd667fe7ed
Diffstat (limited to 'doc')
-rw-r--r--doc/source/admin/telemetry-dynamic-pollster.rst30
1 files changed, 16 insertions, 14 deletions
diff --git a/doc/source/admin/telemetry-dynamic-pollster.rst b/doc/source/admin/telemetry-dynamic-pollster.rst
index f7569fa0..fb174201 100644
--- a/doc/source/admin/telemetry-dynamic-pollster.rst
+++ b/doc/source/admin/telemetry-dynamic-pollster.rst
@@ -151,6 +151,20 @@ attributes to define a dynamic pollster:
directly. We also accept nested values dictionaries. To use a nested value
one can simply use ``attribute1.attribute2.<asMuchAsNeeded>.lastattribute``
+* ``user_id_attribute``: optional parameter. The default value is ``user_id``.
+ The name of the attribute in the entries that are processed from
+ ``response_entries_key`` elements that will be mapped to ``user_id``
+ attribute that is sent to Gnocchi.
+
+* ``project_id_attribute``: optional parameter. The default value is
+ ``project_id``. The name of the attribute in the entries that are
+ processed from ``response_entries_key`` elements that will be mapped to
+ ``project_id`` attribute that is sent to Gnocchi.
+
+* ``resource_id_attribute``: optional parameter. The default value is ``id``.
+ The name of the attribute in the entries that are processed from
+ ``response_entries_key`` elements that will be mapped to ``id`` attribute
+ that is sent to Gnocchi.
The complete YAML configuration to gather data from Magnum (that has been used
as an example) is the following:
@@ -244,8 +258,8 @@ the Dynamic pollster system. The attribute that is not supported is
the ``endpoint_type``. The dynamic pollster system for non-OpenStack APIs
is activated automatically when one uses the configurations ``module``.
-The extra parameters that are available when using the Non-OpenStack
-dynamic pollster sub-subsystem are the following:
+The extra parameters (in addition to the original ones) that are available
+when using the Non-OpenStack dynamic pollster sub-subsystem are the following:
* ``module``: required parameter. It is the python module name that Ceilometer
has to load to use the authentication object when executing requests against
@@ -268,18 +282,6 @@ dynamic pollster sub-subsystem are the following:
from which, Ceilometer can retrieve the comma separated values of the
``authentication_parameters``.
-* ``user_id_attribute``: optional parameter. The name of the attribute in the
- entries that are processed from ``response_entries_key`` elements that
- will be mapped to ``user_id`` attribute that is sent to Gnocchi.
-
-* ``project_id_attribute``: optional parameter. The name of the attribute in
- the entries that are processed from ``response_entries_key`` elements that
- will be mapped to ``project_id`` attribute that is sent to Gnocchi.
-
-* ``resource_id_attribute``: optional parameter. The name of the attribute
- in the entries that are processed from ``response_entries_key`` elements that
- will be mapped to ``id`` attribute that is sent to Gnocchi.
-
As follows we present an example on how to convert the hard-coded pollster
for `radosgw.api.request` metric to the dynamic pollster model: