summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTobias Henkel <tobias.henkel@bmw.de>2018-12-20 22:13:06 +0100
committerTobias Henkel <tobias.henkel@bmw.de>2018-12-20 22:13:06 +0100
commit1f6e001c06508f6e100d1d0e89a431c037bf9673 (patch)
tree13ee4c4989b8c0646e789322e7e32ec0007cd66a
parentea3e777469a67fb3c55041df22f46f79a4f91f7c (diff)
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
Notes
Notes (review): Code-Review+2: Joshua Hesketh <josh@nitrotech.org> Code-Review+2: Monty Taylor <mordred@inaugust.com> Workflow+1: Monty Taylor <mordred@inaugust.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Wed, 09 Jan 2019 15:41:05 +0000 Reviewed-on: https://review.openstack.org/626749 Project: openstack-infra/zuul Branch: refs/heads/master
-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 bd47f7b..37b00ae 100644
--- a/doc/source/admin/monitoring.rst
+++ b/doc/source/admin/monitoring.rst
@@ -156,37 +156,47 @@ These metrics are emitted by the Zuul :ref:`scheduler`:
156 The number of builds currently running on this executor. This 156 The number of builds currently running on this executor. This
157 includes starting builds. 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. 174 .. stat:: <result>
166 This can be an *internal* phase (such as ``setup`` or ``cleanup``) as 175 :type: counter
167 well as *job* phases such as ``pre``, ``run`` or ``post``.
168 176
169 .. stat:: <result> 177 A counter for each type of result.
170 :type: counter 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. 182 Example of possible counters for each phase are: ``RESULT_NORMAL``,
173 These results do not, by themselves, determine the status of a build 183 ``RESULT_TIMED_OUT``, ``RESULT_UNREACHABLE``, ``RESULT_ABORTED``.
174 but are indicators of the exit status provided by Ansible for the
175 execution of a particular phase.
176 184
177 Example of possible counters for each phase are: ``RESULT_NORMAL``, 185 .. stat:: load_average
178 ``RESULT_TIMED_OUT``, ``RESULT_UNREACHABLE``, ``RESULT_ABORTED``. 186 :type: gauge
187
188 The one-minute load average of this executor, multiplied by 100.
179 189
180 .. stat:: load_average 190 .. stat:: pause
181 :type: gauge 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 195 .. stat:: pct_used_ram
186 :type: gauge 196 :type: gauge
187 197
188 The used RAM (excluding buffers and cache) on this executor, as 198 The used RAM (excluding buffers and cache) on this executor, as
189 a percentage multiplied by 100. 199 a percentage multiplied by 100.
190 200
191.. stat:: zuul.nodepool.requests 201.. stat:: zuul.nodepool.requests
192 202