summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.openstack.org>2019-01-09 15:41:05 +0000
committerGerrit Code Review <review@openstack.org>2019-01-09 15:41:05 +0000
commit863705c334389348ba36808fc2dc888ac3e3697c (patch)
treed5f06475057e22c5085b33cb85ea5e026bc55e5c
parent074ee6b7a7a95afcbf9a250da271633dcede3685 (diff)
parent1f6e001c06508f6e100d1d0e89a431c037bf9673 (diff)
Merge "Document missing executor stats"
-rw-r--r--doc/source/admin/monitoring.rst52
1 files changed, 31 insertions, 21 deletions
diff --git a/doc/source/admin/monitoring.rst b/doc/source/admin/monitoring.rst
index 6680b0f..ccde1c7 100644
--- a/doc/source/admin/monitoring.rst
+++ b/doc/source/admin/monitoring.rst
@@ -168,37 +168,47 @@ These metrics are emitted by the Zuul :ref:`scheduler`:
168 The number of builds currently running on this executor. This 168 The number of builds currently running on this executor. This
169 includes starting builds. 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. 186 .. stat:: <result>
178 This can be an *internal* phase (such as ``setup`` or ``cleanup``) as 187 :type: counter
179 well as *job* phases such as ``pre``, ``run`` or ``post``.
180 188
181 .. stat:: <result> 189 A counter for each type of result.
182 :type: counter 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. 194 Example of possible counters for each phase are: ``RESULT_NORMAL``,
185 These results do not, by themselves, determine the status of a build 195 ``RESULT_TIMED_OUT``, ``RESULT_UNREACHABLE``, ``RESULT_ABORTED``.
186 but are indicators of the exit status provided by Ansible for the
187 execution of a particular phase.
188 196
189 Example of possible counters for each phase are: ``RESULT_NORMAL``, 197 .. stat:: load_average
190 ``RESULT_TIMED_OUT``, ``RESULT_UNREACHABLE``, ``RESULT_ABORTED``. 198 :type: gauge
199
200 The one-minute load average of this executor, multiplied by 100.
191 201
192 .. stat:: load_average 202 .. stat:: pause
193 :type: gauge 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 207 .. stat:: pct_used_ram
198 :type: gauge 208 :type: gauge
199 209
200 The used RAM (excluding buffers and cache) on this executor, as 210 The used RAM (excluding buffers and cache) on this executor, as
201 a percentage multiplied by 100. 211 a percentage multiplied by 100.
202 212
203.. stat:: zuul.nodepool.requests 213.. stat:: zuul.nodepool.requests
204 214