diff options
| author | James E. Blair <jim@acmegating.com> | 2022-07-12 10:25:59 -0700 |
|---|---|---|
| committer | James E. Blair <jim@acmegating.com> | 2022-07-12 10:25:59 -0700 |
| commit | 458ba317fdc2ea9a66ef058b248646473819b32e (patch) | |
| tree | 71a04ea96102a321c2d616fc1ea04b40eeaf091d /doc | |
| parent | dcc4c21aef0abf694db1325092fb0ab3486402f2 (diff) | |
| download | zuul-458ba317fdc2ea9a66ef058b248646473819b32e.tar.gz | |
Add pipeline-based merge op metrics
So that operators can see in aggregate how long merge, files-changes,
and repo-state merge operations take in certain pipelines, add
metrics for the merge operations themselves (these exclude the
overhead of pipeline processing and job dispatching).
Change-Id: I8a707b8453c7c9559d22c627292741972c47c7d7
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/monitoring.rst | 34 |
1 files changed, 32 insertions, 2 deletions
diff --git a/doc/source/monitoring.rst b/doc/source/monitoring.rst index 0c2cb4351..1cb61ee01 100644 --- a/doc/source/monitoring.rst +++ b/doc/source/monitoring.rst @@ -110,7 +110,27 @@ These metrics are emitted by the Zuul :ref:`scheduler`: operation(s). This will always include a request to a Zuul merger to speculatively merge the change, but it may also include a second request submitted in parallel to identify - the files altered by the change. + the files altered by the change. Includes + :stat:`zuul.tenant.<tenant>.pipeline.<pipeline>.merger_merge_op_time` + and + :stat:`zuul.tenant.<tenant>.pipeline.<pipeline>.merger_files_changes_op_time`. + + .. stat:: merger_merge_op_time + :type: timer + + The amount of time the merger spent performing a merge + operation. This does not include any of the round-trip time + from the scheduler to the merger, or any other merge + operations. + + .. stat:: merger_files_changes_op_time + :type: timer + + The amount of time the merger spent performing a files-changes + operation to detect changed files (this is sometimes + performed if the source does not provide this information). + This does not include any of the round-trip time from the + scheduler to the merger, or any other merge operations. .. stat:: layout_generation_time :type: timer @@ -128,7 +148,17 @@ These metrics are emitted by the Zuul :ref:`scheduler`: The amount of time waiting for a secondary Zuul merger operation to collect additional information about the repo - state of required projects. + state of required projects. Includes + :stat:`zuul.tenant.<tenant>.pipeline.<pipeline>.merger_repo_state_op_time`. + + .. stat:: merger_repo_state_op_time + :type: timer + + The amount of time the merger spent performing a repo state + operation to collect additional information about the repo + state of required projects. This does not include any of the + round-trip time from the scheduler to the merger, or any + other merge operations. .. stat:: node_request_time :type: timer |