zuul
/
zuul
Code Issues Proposed changes

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
This commit is contained in:
Tobias Henkel 2018-12-20 22:13:06 +01:00
parent ea3e777469
commit 1f6e001c06
No known key found for this signature in database
GPG Key ID: 03750DEC158E5FA2
1 changed files with 31 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
doc/source/admin/monitoring.rst
View File

@ -156,37 +156,47 @@ These metrics are emitted by the Zuul :ref:`scheduler`:
The number of builds currently running on this executor. This The number of builds currently running on this executor. This
includes starting builds. includes starting builds.
.. stat:: phase .. stat:: paused_builds
:type: gauge
Subtree detailing per-phase execution statistics: The number of currently paused builds on this executor.
.. stat:: <phase> .. stat:: phase
``<phase>`` represents a phase in the execution of a job. Subtree detailing per-phase execution statistics:
This can be an *internal* phase (such as ``setup`` or ``cleanup``) as
well as *job* phases such as ``pre``, ``run`` or ``post``.
.. stat:: <result> .. stat:: <phase>
:type: counter
A counter for each type of result. ``<phase>`` represents a phase in the execution of a job.
These results do not, by themselves, determine the status of a build This can be an *internal* phase (such as ``setup`` or ``cleanup``) as
but are indicators of the exit status provided by Ansible for the well as *job* phases such as ``pre``, ``run`` or ``post``.
execution of a particular phase.
Example of possible counters for each phase are: ``RESULT_NORMAL``, .. stat:: <result>
``RESULT_TIMED_OUT``, ``RESULT_UNREACHABLE``, ``RESULT_ABORTED``. :type: counter
.. stat:: load_average A counter for each type of result.
:type: gauge These results do not, by themselves, determine the status of a build
but are indicators of the exit status provided by Ansible for the
execution of a particular phase.
The one-minute load average of this executor, multiplied by 100. Example of possible counters for each phase are: ``RESULT_NORMAL``,
``RESULT_TIMED_OUT``, ``RESULT_UNREACHABLE``, ``RESULT_ABORTED``.
.. stat:: pct_used_ram .. stat:: load_average
:type: gauge :type: gauge
The used RAM (excluding buffers and cache) on this executor, as The one-minute load average of this executor, multiplied by 100.
a percentage multiplied by 100.
.. stat:: pause
:type: gauge
Indicates if the executor is paused. 1 means paused else 0.
.. stat:: pct_used_ram
:type: gauge
The used RAM (excluding buffers and cache) on this executor, as
a percentage multiplied by 100.
.. stat:: zuul.nodepool.requests .. stat:: zuul.nodepool.requests