summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJames E. Blair <jim@acmegating.com>2022-02-28 10:51:37 -0800
committerJames E. Blair <jim@acmegating.com>2022-02-28 10:51:37 -0800
commit88b076e8e37fbce5507d597a5c5f6a852bb98015 (patch)
treeb4929bb7f78b13301849b1427517cc4ef5ec86ee /doc
parent72e623415732ad917739edcf935ce88747da790b (diff)
downloadzuul-88b076e8e37fbce5507d597a5c5f6a852bb98015.tar.gz
Add more pipeline processing stats
This adds the number of zk objects, nodes, and bytes read and written during each pipeline processing run. This can help Zuul developers ascertain where to optimize performance. Change-Id: Ic2592faeb08d6c2a72b99000864c41ada665cd3b
Diffstat (limited to 'doc')
-rw-r--r--doc/source/monitoring.rst36
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/source/monitoring.rst b/doc/source/monitoring.rst
index 3c0b2a1ff..10e358e49 100644
--- a/doc/source/monitoring.rst
+++ b/doc/source/monitoring.rst
@@ -235,6 +235,24 @@ These metrics are emitted by the Zuul :ref:`scheduler`:
The time spent reading data from ZooKeeper during a single
pipeline processing run.
+ .. stat:: read_znodes
+ :type: gauge
+
+ The number of ZNodes read from ZooKeeper during a single
+ pipeline processing run.
+
+ .. stat:: read_objects
+ :type: gauge
+
+ The number of Zuul data model objects read from ZooKeeper
+ during a single pipeline processing run.
+
+ .. stat:: read_bytes
+ :type: gauge
+
+ The amount of data read from ZooKeeper during a single
+ pipeline processing run.
+
.. stat:: refresh
:type: timer
@@ -273,6 +291,24 @@ These metrics are emitted by the Zuul :ref:`scheduler`:
The time spent writing data to ZooKeeper during a single
pipeline processing run.
+ .. stat:: write_znodes
+ :type: gauge
+
+ The number of ZNodes written to ZooKeeper during a single
+ pipeline processing run.
+
+ .. stat:: write_objects
+ :type: gauge
+
+ The number of Zuul data model objects written to ZooKeeper
+ during a single pipeline processing run.
+
+ .. stat:: write_bytes
+ :type: gauge
+
+ The amount of data written to ZooKeeper during a single
+ pipeline processing run.
+
.. stat:: zuul.executor.<executor>
Holds metrics emitted by individual executors. The ``<executor>``