Browse Source

Document missing executor stats

The stats zuul.executor.<name>.pause and
zuul.executor.<name>.paused_builds are undocumented. While at it fix
the indentation of this section.

Change-Id: I5d5bdc1fe748ec2c545c8b7e8ec2674d50208f9f
tags/3.5.0
Tobias Henkel 6 months ago
parent
commit
1f6e001c06
No account linked to committer's email address
1 changed files with 31 additions and 21 deletions
  1. 31
    21
      doc/source/admin/monitoring.rst

+ 31
- 21
doc/source/admin/monitoring.rst View File

@@ -156,37 +156,47 @@ These metrics are emitted by the Zuul :ref:`scheduler`:
156 156
       The number of builds currently running on this executor.  This
157 157
       includes starting builds.
158 158
 
159
-  .. stat:: phase
159
+   .. stat:: paused_builds
160
+      :type: gauge
161
+
162
+      The number of currently paused builds on this executor.
163
+
164
+   .. stat:: phase
165
+
166
+      Subtree detailing per-phase execution statistics:
160 167
 
161
-     Subtree detailing per-phase execution statistics:
168
+      .. stat:: <phase>
162 169
 
163
-     .. stat:: <phase>
170
+         ``<phase>`` represents a phase in the execution of a job.
171
+         This can be an *internal* phase (such as ``setup`` or ``cleanup``) as
172
+         well as *job* phases such as ``pre``, ``run`` or ``post``.
164 173
 
165
-        ``<phase>`` represents a phase in the execution of a job.
166
-        This can be an *internal* phase (such as ``setup`` or ``cleanup``) as
167
-        well as *job* phases such as ``pre``, ``run`` or ``post``.
174
+         .. stat:: <result>
175
+            :type: counter
168 176
 
169
-        .. stat:: <result>
170
-           :type: counter
177
+            A counter for each type of result.
178
+            These results do not, by themselves, determine the status of a build
179
+            but are indicators of the exit status provided by Ansible for the
180
+            execution of a particular phase.
171 181
 
172
-           A counter for each type of result.
173
-           These results do not, by themselves, determine the status of a build
174
-           but are indicators of the exit status provided by Ansible for the
175
-           execution of a particular phase.
182
+            Example of possible counters for each phase are: ``RESULT_NORMAL``,
183
+            ``RESULT_TIMED_OUT``, ``RESULT_UNREACHABLE``, ``RESULT_ABORTED``.
176 184
 
177
-           Example of possible counters for each phase are: ``RESULT_NORMAL``,
178
-           ``RESULT_TIMED_OUT``, ``RESULT_UNREACHABLE``, ``RESULT_ABORTED``.
185
+   .. stat:: load_average
186
+      :type: gauge
187
+
188
+      The one-minute load average of this executor, multiplied by 100.
179 189
 
180
-  .. stat:: load_average
181
-     :type: gauge
190
+   .. stat:: pause
191
+      :type: gauge
182 192
 
183
-     The one-minute load average of this executor, multiplied by 100.
193
+      Indicates if the executor is paused. 1 means paused else 0.
184 194
 
185
-  .. stat:: pct_used_ram
186
-     :type: gauge
195
+   .. stat:: pct_used_ram
196
+      :type: gauge
187 197
 
188
-     The used RAM (excluding buffers and cache) on this executor, as
189
-     a percentage multiplied by 100.
198
+      The used RAM (excluding buffers and cache) on this executor, as
199
+      a percentage multiplied by 100.
190 200
 
191 201
 .. stat:: zuul.nodepool.requests
192 202
 

Loading…
Cancel
Save