diff options
| author | Rafael Weingärtner <rafael@apache.org> | 2019-10-29 15:52:18 -0300 |
|---|---|---|
| committer | Rafael Weingärtner <rafael@apache.org> | 2019-10-30 10:57:02 -0300 |
| commit | 5281479f7a1f975d6ae3363e9a9e601d3d26ae8b (patch) | |
| tree | 721a2dbf30f1e3b1f164d2d1fc2f47e4b3419209 /doc | |
| parent | de1bd408492fd5efe7647d55c437c5454593096f (diff) | |
| download | ceilometer-5281479f7a1f975d6ae3363e9a9e601d3d26ae8b.tar.gz | |
Dynamic pollsters to support nested dictionary values
The goal of this PR is to allow operators to use nested
keys when defining an attribute to be used as value or
as the response key where the entries to be processed
are found.
Depends-On: https://review.opendev.org/#/c/691659/
Change-Id: I7df4a5e630ccb646291be967b2289552cc69829c
Signed-off-by: Rafael Weingärtner <rafael@apache.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/admin/telemetry-dynamic-pollster.rst | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/source/admin/telemetry-dynamic-pollster.rst b/doc/source/admin/telemetry-dynamic-pollster.rst index e4e42a29..fa4d6d8f 100644 --- a/doc/source/admin/telemetry-dynamic-pollster.rst +++ b/doc/source/admin/telemetry-dynamic-pollster.rst @@ -47,7 +47,9 @@ attributes to define a dynamic pollster: the unit or some other meaningful String value; * ``value_attribute``: mandatory attribute; defines the attribute in the - JSON response from the URL of the component being polled. In our magnum + 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 + ``attribute1.attribute2.<asMuchAsNeeded>.lastattribute``. In our magnum example, we can use ``status`` as the value attribute; * ``endpoint_type``: mandatory field; defines the endpoint type that is @@ -155,7 +157,8 @@ attributes to define a dynamic pollster: contains a list, instead of an object where one of its attributes is a list of entries, we use the list directly. Therefore, this option will be ignored when the API is returning the list/array of entries to be processed - directly. + directly. We also accept nested values dictionaries. To use a nested value + one can simply use ``attribute1.attribute2.<asMuchAsNeeded>.lastattribute`` The complete YAML configuration to gather data from Magnum (that has been used |