summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRafael Weingärtner <rafael@apache.org>2020-03-26 15:13:51 -0300
committerRafael Weingärtner <rafael@apache.org>2020-07-22 08:13:51 -0300
commit39a534b3f8e745476738bfba98a0f984f730d5e6 (patch)
tree88e7d1dc0cb92612524d0e475bfcb31238ce6165 /doc
parent51119ddc1c7a98674ac9216cbfb890b1a2dab6a2 (diff)
downloadceilometer-39a534b3f8e745476738bfba98a0f984f730d5e6.tar.gz
Add support to the use of headers in the dynamic pollsters
Depends-On: https://review.opendev.org/#/c/709807/ Change-Id: I3ec151b8807d0dd3e529bb449d22fa68c8c810ee
Diffstat (limited to 'doc')
-rw-r--r--doc/source/admin/telemetry-dynamic-pollster.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/source/admin/telemetry-dynamic-pollster.rst b/doc/source/admin/telemetry-dynamic-pollster.rst
index 6ed1faa2..62e6dc3e 100644
--- a/doc/source/admin/telemetry-dynamic-pollster.rst
+++ b/doc/source/admin/telemetry-dynamic-pollster.rst
@@ -171,6 +171,16 @@ attributes to define a dynamic pollster:
``response_entries_key`` elements that will be mapped to ``id`` attribute
that is sent to Gnocchi.
+* ``headers``: optional parameter. It is a map (similar to the
+ 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
+ for both OpenStack and non-OpenStack dynamic pollster configuration.
+
+ .. code-block:: yaml
+
+ headers:
+ "x-openstack-nova-api-version": "2.46"
+
The complete YAML configuration to gather data from Magnum (that has been used
as an example) is the following: