summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJames E. Blair <jim@acmegating.com>2022-03-02 13:48:36 -0800
committerJames E. Blair <jim@acmegating.com>2022-03-03 07:32:06 -0800
commitbff3f8e4dfa3864bf7627b1402fd5d6c6f857c50 (patch)
treead38ba977cf3f7d0dc511d9f8bc111cfc351762c /doc
parentc5f60e90046eebc3c943bbebea760ba358a5abd7 (diff)
downloadzuul-bff3f8e4dfa3864bf7627b1402fd5d6c6f857c50.tar.gz
Add a tenant reconfiguration metric
This allows operators to see when tenant reconfiguration events are processed, and how long they halt pipeline processing. Change-Id: I30102b2d51ae98ade194722a7720ddec7eed4dad
Diffstat (limited to 'doc')
-rw-r--r--doc/source/monitoring.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/source/monitoring.rst b/doc/source/monitoring.rst
index 57f4a2534..1565d0496 100644
--- a/doc/source/monitoring.rst
+++ b/doc/source/monitoring.rst
@@ -70,6 +70,18 @@ These metrics are emitted by the Zuul :ref:`scheduler`:
The size of the tenant's management event queue.
+.. stat:: zuul.tenant.<tenant>.reconfiguration_time
+ :type: timer
+
+ A timer metric reporting the time taken to reconfigure a tenant.
+ This is performed by one scheduler after a tenant reconfiguration
+ event is received. During this time, all processing of that
+ tenant's pipelines are halted. This measures that time.
+
+ Once the first scheduler completes a tenant reconfiguration, other
+ schedulers may update their layout in the background without
+ interrupting processing. That is not reported in this metric.
+
.. stat:: zuul.tenant.<tenant>.trigger_events
:type: gauge