7.5 KiB
- title
-
Monitoring
Monitoring
Statsd reporting
Zuul comes with support for the statsd protocol, when enabled and configured (see below), the Zuul scheduler will emit raw metrics to a statsd receiver which let you in turn generate nice graphics.
Configuration
Statsd support uses the statsd
python module. Note that
support is optional and Zuul will start without the statsd python module
present.
Configuration is in the statsd
section of zuul.conf
.
Metrics
These metrics are emitted by the Zuul scheduler
:
zuul.event.<driver>.<type>
Zuul will report counters for each type of event it receives from each of its configured drivers.
zuul.tenant.<tenant>.pipeline
Holds metrics specific to jobs. This hierarchy includes:
<pipeline name>
A set of metrics for each pipeline named as defined in the Zuul config.
all_jobs
Number of jobs triggered by the pipeline.
current_changes
The number of items currently being processed by this pipeline.
project
This hierarchy holds more specific metrics for each project participating in the pipeline.
<canonical_hostname>
The canonical hostname for the triggering project. Embedded
.
characters will be translated to _
.
<project>
The name of the triggering project. Embedded /
or
.
characters will be translated to _
.
<branch>
The name of the triggering branch. Embedded /
or
.
characters will be translated to _
.
job
Subtree detailing per-project job statistics:
<jobname>
The triggered job name.
<result>
A counter for each type of result (e.g., SUCCESS
or
FAILURE
, ERROR
, etc.) for the job. If the
result is SUCCESS
or FAILURE
, Zuul will
additionally report the duration of the build as a timer.
current_changes
The number of items of this project currently being processed by this pipeline.
resident_time
A timer metric reporting how long each item for this project has been in the pipeline.
total_changes
The number of changes for this project processed by the pipeline since Zuul started.
resident_time
A timer metric reporting how long each item has been in the pipeline.
total_changes
The number of changes processed by the pipeline since Zuul started.
wait_time
How long each item spent in the pipeline before its first job started.
zuul.executor.<executor>
Holds metrics emitted by individual executors. The
<executor>
component of the key will be replaced with
the hostname of the executor.
builds
Incremented each time the executor starts a build.
starting_builds
The number of builds starting on this executor. These are builds which have not yet begun their first pre-playbook.
running_builds
The number of builds currently running on this executor. This includes starting builds.
load_average
The one-minute load average of this executor, multiplied by 100.
pct_available_ram
The available RAM (including buffers and cache) on this executor, as a percentage multiplied by 100.
zuul.nodepool
Holds metrics related to Zuul requests from Nodepool.
requested
Incremented each time a node request is submitted to Nodepool.
label.<label>
Incremented each time a request for a specific label is submitted to Nodepool.
size.<size>
Incremented each time a request of a specific size is submitted to
Nodepool. For example, a request for 3 nodes would use the key
zuul.nodepool.requested.size.3
.
canceled
The counter is incremented each time a node request is canceled by Zuul. The timer records the elapsed time from request to cancelation.
label.<label>
The same, for a specific label.
size.<size>
The same, for a specific request size.
fulfilled
The counter is incremented each time a node request is fulfilled by Nodepool. The timer records the elapsed time from request to fulfillment.
label.<label>
The same, for a specific label.
size.<size>
The same, for a specific request size.
failed
The counter is incremented each time Nodepool fails to fulfill a node request. The timer records the elapsed time from request to failure.
label.<label>
The same, for a specific label.
size.<size>
The same, for a specific request size.
current_requests
The number of outstanding nodepool requests from Zuul.
zuul.mergers
Holds metrics related to Zuul mergers.
online
The number of Zuul merger processes online.
jobs_running
The number of merge jobs running.
jobs_queued
The number of merge jobs queued.
zuul.executors
Holds metrics related to Zuul executors.
online
The number of Zuul executor processes online.
accepting
The number of Zuul executor processes accepting new jobs.
jobs_running
The number of executor jobs running.
jobs_queued
The number of executor jobs queued.
As an example, given a job named myjob in mytenant triggered by a change to myproject on the master branch in the gate pipeline which took 40 seconds to build, the Zuul scheduler will emit the following statsd events:
zuul.tenant.mytenant.pipeline.gate.project.example_com.myproject.master.job.myjob.SUCCESS
+1zuul.tenant.mytenant.pipeline.gate.project.example_com.myproject.master.job.myjob.SUCCESS
40 secondszuul.tenant.mytenant.pipeline.gate.all_jobs
+1