Browse Source

Merge "Document missing executor stats"

tags/3.5.0
Zuul 5 months ago
parent
commit
863705c334
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

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

Loading…
Cancel
Save