diff options
| author | Albin Vass <albin.vass@zenseact.com> | 2022-03-31 15:56:48 +0200 |
|---|---|---|
| committer | Albin Vass <albin.vass@zenseact.com> | 2022-03-31 15:56:55 +0200 |
| commit | 4af0a5e7a4105c2b01bf207dc3e738872036989c (patch) | |
| tree | 3072c2c5e8a71db419bb1ac4c2a051d651f517b5 | |
| parent | 08348143f5c438547b3b4b73f6af7ff7e753e013 (diff) | |
| download | zuul-4af0a5e7a4105c2b01bf207dc3e738872036989c.tar.gz | |
Document prometheus_port, prometheus_addr for all components
Change-Id: I76310e7264f3251e6e436ddea20b6b80e158a341
| -rw-r--r-- | doc/source/configuration.rst | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/source/configuration.rst b/doc/source/configuration.rst index 917596c3e..797dd9a56 100644 --- a/doc/source/configuration.rst +++ b/doc/source/configuration.rst @@ -355,6 +355,16 @@ The following section of ``zuul.conf`` is used by the merger: Path to PID lock file for the merger process. + .. attr:: prometheus_port + + Set a TCP port to start the prometheus metrics client. + + .. attr:: prometheus_addr + :default: 0.0.0.0 + + The IPv4 addr to listen for prometheus metrics poll. + To use IPv6, python>3.8 is required `issue24209 <https://bugs.python.org/issue24209>`_. + .. _executor: Executor @@ -710,6 +720,16 @@ The following sections of ``zuul.conf`` are used by the executor: Abort all running jobs and exit as soon as possible. + .. attr:: prometheus_port + + Set a TCP port to start the prometheus metrics client. + + .. attr:: prometheus_addr + :default: 0.0.0.0 + + The IPv4 addr to listen for prometheus metrics poll. + To use IPv6, python>3.8 is required `issue24209 <https://bugs.python.org/issue24209>`_. + .. attr:: keystore @@ -730,6 +750,16 @@ The following sections of ``zuul.conf`` are used by the executor: Value to pass to `git config user.name <https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup>`_. + .. attr:: prometheus_port + + Set a TCP port to start the prometheus metrics client. + + .. attr:: prometheus_addr + :default: 0.0.0.0 + + The IPv4 addr to listen for prometheus metrics poll. + To use IPv6, python>3.8 is required `issue24209 <https://bugs.python.org/issue24209>`_. + .. attr:: ansible_callback "<name>" To whitelist ansible callback ``<name>``. Any attributes found is this section |