summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorZuul <zuul@review.opendev.org>2021-06-14 08:24:21 +0000
committerGerrit Code Review <review@openstack.org>2021-06-14 08:24:21 +0000
commite396932505e5fd1589c8fea90e35d1b22de0ed67 (patch)
tree5d704ddf4ad9dbdb03ad1a9ee9dee2edd8a6126d /doc
parent1e7a98c802e12d26a67cef23d94cfbbfba80db29 (diff)
parent30ada660f0d5e4bcbddb2b13aa6af834ab295444 (diff)
downloadceilometer-e396932505e5fd1589c8fea90e35d1b22de0ed67.tar.gz
Merge "Introduce `timeout` in dynamic pollsters sub-system"
Diffstat (limited to 'doc')
-rw-r--r--doc/source/admin/telemetry-dynamic-pollster.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/source/admin/telemetry-dynamic-pollster.rst b/doc/source/admin/telemetry-dynamic-pollster.rst
index 12999c6c..9a321cb6 100644
--- a/doc/source/admin/telemetry-dynamic-pollster.rst
+++ b/doc/source/admin/telemetry-dynamic-pollster.rst
@@ -190,6 +190,14 @@ attributes to define a dynamic pollster:
headers:
"x-openstack-nova-api-version": "2.46"
+* ``timeout``: optional parameter. Defines the request timeout for the
+ requests executed by the dynamic pollsters to gather data. The default
+ timeout value is 30 seconds. If it is set to `None`, this means that the
+ request never times out on the client side. Therefore, one might have
+ problems if the server never closes the connection. The pollsters are
+ executed serially, one after the other. Therefore, if the request hangs,
+ all pollsters (including the non-dynamic ones) will stop executing.
+
The complete YAML configuration to gather data from Magnum (that has been used
as an example) is the following: