diff options
| author | Zuul <zuul@review.opendev.org> | 2022-07-29 19:06:54 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2022-07-29 19:06:54 +0000 |
| commit | 22d0603b7a7e53de70f695ee954a0795d62da2fb (patch) | |
| tree | 2ca28584dc760d105f82987f0032814d50f3d92f | |
| parent | 3c95746185469364dcf8cbecf74c444295247e09 (diff) | |
| parent | dcc4c21aef0abf694db1325092fb0ab3486402f2 (diff) | |
| download | zuul-22d0603b7a7e53de70f695ee954a0795d62da2fb.tar.gz | |
Merge "Add dev docs for metrics"
| -rw-r--r-- | doc/source/developer/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/developer/metrics.rst | 74 |
2 files changed, 75 insertions, 0 deletions
diff --git a/doc/source/developer/index.rst b/doc/source/developer/index.rst index 52266a175..b45c75640 100644 --- a/doc/source/developer/index.rst +++ b/doc/source/developer/index.rst @@ -14,6 +14,7 @@ Zuul, though advanced users may find it interesting. drivers triggers testing + metrics docs ansible javascript diff --git a/doc/source/developer/metrics.rst b/doc/source/developer/metrics.rst new file mode 100644 index 000000000..913a591ba --- /dev/null +++ b/doc/source/developer/metrics.rst @@ -0,0 +1,74 @@ +:title: Metrics + +Metrics +======= + +Event Overview +-------------- + +The following table illustrates the event and pipeline processing +sequence as it relates to some of the metrics described in +:ref:`statsd`. This is intended as general guidance only and is not +an exhaustive list. + ++----------------------------------------+------+------+------+--------------------------------------+ +| Event | Metrics | Attribute | ++========================================+======+======+======+======================================+ +| Event generated by source | | | | event.timestamp | ++----------------------------------------+------+ + +--------------------------------------+ +| Enqueued into driver queue | | | | | ++----------------------------------------+------+ + +--------------------------------------+ +| Enqueued into tenant trigger queue | | | | event.arrived_at_scheduler_timestamp | ++----------------------------------------+ + [8] + +--------------------------------------+ +| Forwarded to matching pipelines | [1] | | | | ++----------------------------------------+ + + +--------------------------------------+ +| Changes enqueued ahead | | | | | ++----------------------------------------+ + + +--------------------------------------+ +| Change enqueued | | | | item.enqueue_time | ++----------------------------------------+------+------+ +--------------------------------------+ +| Changes enqueued behind | | | | | ++----------------------------------------+------+------+ +--------------------------------------+ +| Set item configuration | | | | build_set.configured_time | ++----------------------------------------+------+------+ +--------------------------------------+ +| Request files changed (if needed) | | | | | ++----------------------------------------+ +------+ +--------------------------------------+ +| Request merge | [2] | | | | ++----------------------------------------+ +------+ +--------------------------------------+ +| Wait for merge (and files if needed) | | | [9] | | ++----------------------------------------+------+------+ +--------------------------------------+ +| Generate dynamic layout (if needed) | [3] | | | | ++----------------------------------------+------+------+ +--------------------------------------+ +| Freeze job graph | [4] | | | | ++----------------------------------------+------+------+ +--------------------------------------+ +| Request global repo state (if needed) | | | | build_set.repo_state_request_time | ++----------------------------------------+ [5] +------+ +--------------------------------------+ +| Wait for global repo state (if needed) | | | | | ++----------------------------------------+------+------+ +--------------------------------------+ +| Deduplicate jobs | | | | | ++----------------------------------------+------+------+ +--------------------------------------+ +| Acquire semaphore (non-resources-first)| | | | | ++----------------------------------------+------+------+ +--------------------------------------+ +| Request nodes | | | | request.created_time | ++----------------------------------------+ [6] +------+ +--------------------------------------+ +| Wait for nodes | | | | | ++----------------------------------------+------+------+ +--------------------------------------+ +| Acquire semaphore (resources-first) | | | | | ++----------------------------------------+------+------+ +--------------------------------------+ +| Enqueue build request | | | | build.execute_time | ++----------------------------------------+ [7] +------+ +--------------------------------------+ +| Executor starts job | | | | build.start_time | ++----------------------------------------+------+------+------+--------------------------------------+ + +====== ============================= +Metric Name +====== ============================= +1 event_enqueue_processing_time +2 merge_request_time +3 layout_generation_time +4 job_freeze_time +5 repo_state_time +6 node_request_time +7 job_wait_time +8 event_enqueue_time +9 event_job_time +====== ============================= |