openstack/ceilometer
Code Issues Proposed changes

Statement about complex object handling in the Dynamic pollster documentation

Browse Source 
Change-Id: Iae1b317db25a8c3b6e9f8400c572cc653367d4c9
This commit is contained in:
Rafael Weingärtner 2020-08-27 10:44:55 -03:00
parent 648ce9b668
commit 549df53f9c
1 changed files with 19 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
doc/source/admin/telemetry-dynamic-pollster.rst
View File

@ -26,6 +26,13 @@ The dynamic pollsters system configuration (for OpenStack APIs)
Each YAML file in the dynamic pollster feature can use the following Each YAML file in the dynamic pollster feature can use the following
attributes to define a dynamic pollster: attributes to define a dynamic pollster:
.. warning::
Caution: Ceilometer does not accept complex value data structure for
``value`` and ``metadata`` configurations. Therefore, if you are extracting
a complex data structure (Object, list, map, or others), you can take
advantage of the ``Operations on extracted attributes`` feature to transform
the object into a simple value (string or number)
* ``name``: mandatory field. It specifies the name/key of the dynamic * ``name``: mandatory field. It specifies the name/key of the dynamic
pollster. For instance, a pollster for magnum can use the name pollster. For instance, a pollster for magnum can use the name
``dynamic.magnum.cluster``; ``dynamic.magnum.cluster``;
@ -41,11 +48,11 @@ attributes to define a dynamic pollster:
JSON response from the URL of the component being polled. We also accept JSON response from the URL of the component being polled. We also accept
nested values dictionaries. To use a nested value one can simply use nested values dictionaries. To use a nested value one can simply use
``attribute1.attribute2.<asMuchAsNeeded>.lastattribute``. It is also ``attribute1.attribute2.<asMuchAsNeeded>.lastattribute``. It is also
possible to reference the sample itself using ``.``; the self reference possible to reference the sample itself using ``"." (dot)``; the self
of the sample is interesting in cases when the attribute might not exist. reference of the sample is interesting in cases when the attribute might
Therefore, together with the operations one can first check if it exist not exist. Therefore, together with the operations options, one can first
before retrieving it (e.g. check if it exist before retrieving it (example:
`` . | value['some_field'] if 'some_field' in value else ''``). ``". | value['some_field'] if 'some_field' in value else ''"``).
In our magnum example, we can use ``status`` as the value attribute; In our magnum example, we can use ``status`` as the value attribute;
* ``endpoint_type``: mandatory field; defines the endpoint type that is * ``endpoint_type``: mandatory field; defines the endpoint type that is
@ -158,25 +165,25 @@ attributes to define a dynamic pollster:
directly. We also accept nested values dictionaries. To use a nested value directly. We also accept nested values dictionaries. To use a nested value
one can simply use ``attribute1.attribute2.<asMuchAsNeeded>.lastattribute`` one can simply use ``attribute1.attribute2.<asMuchAsNeeded>.lastattribute``
* ``user_id_attribute``: optional parameter. The default value is ``user_id``. * ``user_id_attribute``: optional parameter. The default value is ``user_id``.
The name of the attribute in the entries that are processed from The name of the attribute in the entries that are processed from
``response_entries_key`` elements that will be mapped to ``user_id`` ``response_entries_key`` elements that will be mapped to ``user_id``
attribute that is sent to Gnocchi. attribute that is sent to Gnocchi.
* ``project_id_attribute``: optional parameter. The default value is * ``project_id_attribute``: optional parameter. The default value is
``project_id``. The name of the attribute in the entries that are ``project_id``. The name of the attribute in the entries that are
processed from ``response_entries_key`` elements that will be mapped to processed from ``response_entries_key`` elements that will be mapped to
``project_id`` attribute that is sent to Gnocchi. ``project_id`` attribute that is sent to Gnocchi.
* ``resource_id_attribute``: optional parameter. The default value is ``id``. * ``resource_id_attribute``: optional parameter. The default value is ``id``.
The name of the attribute in the entries that are processed from The name of the attribute in the entries that are processed from
``response_entries_key`` elements that will be mapped to ``id`` attribute ``response_entries_key`` elements that will be mapped to ``id`` attribute
that is sent to Gnocchi. that is sent to Gnocchi.
* ``headers``: optional parameter. It is a map (similar to the * ``headers``: optional parameter. It is a map (similar to the
metadata_mapping) of key and value that can be used to customize the header metadata_mapping) of key and value that can be used to customize the header
of the request that is executed against the URL. This configuration works of the request that is executed against the URL. This configuration works
for both OpenStack and non-OpenStack dynamic pollster configuration. for both OpenStack and non-OpenStack dynamic pollster configuration.
.. code-block:: yaml .. code-block:: yaml