Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commitdcc5931

Browse files
feat: add new engine metrics (#1169)
* feat: add new engine metrics* docs: document `METRICS_PROMETHEUS_SCRAPE_TIMEOUT` env var* Update enable-engine-pod-metrics.mdContent edits---------Co-authored-by: NimRegev <nima.regev@codefresh.io>
1 parent64a56f4 commitdcc5931

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

‎_docs/kb/articles/enable-engine-pod-metrics.md‎

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,67 +14,87 @@ support-reviewed: 2023-04-18 LG
1414

1515
##Overview
1616

17-
If you want toscrape the metrics from the Codefresh Runner to your existing Prometheus\Grafana stack youwill need toenable the metrics in therunner engine pod.
17+
Toscrape the metrics from the Codefresh Runner to your existing Prometheus/Grafana stack, youmustenable the metrics in theRunner's engine pod.
1818

1919
##Details
2020

2121
###How to enable
2222

23-
You will need to add the`METRICS_PROMETHEUS_ENABLED: 'true'` environment variable for the engine pod.
23+
1. In the Codefresh Runner Helm chart values file, go to`runtime.engine.env.`
24+
1. Add the`METRICS_PROMETHEUS_ENABLED` environment variable for the engine pod.
2425

25-
To make such a change, you need to change Codefresh Runner Helm chart values. Full path to the entity in question is`runtime.engine.env.METRICS_PROMETHEUS_ENABLED`.
26+
#####Scrape timeout
27+
During normal shutdown, the engine performs a final scrape of metrics before the terminating the engine pod.
28+
The timeout is controlled by the`METRICS_PROMETHEUS_SCRAPE_TIMEOUT` engine variable. If you want to include the most recent metrics, we recommend setting this variable to 4 times your scrape interval.
2629

27-
Complete documentation on this and other environment variables available in the engine can be found on[Artifact Hub](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime?modal=values&path=runtime.engine.env).
30+
#####Documentation
31+
Complete documentation on all the environment variables available in the engine, including their default values, is on[Artifact Hub](https://artifacthub.io/packages/helm/codefresh-runner/cf-runtime?modal=values&path=runtime.engine.env){:target="\_blank"}.
2832

2933

3034
###Available metrics
3135

3236
Each of the metrics below has the following additional labels:`account_name`,`docker_node_address`,`pipeline_id`,`repo_branch`,`workflow`
3337

38+
*`codefresh_engine_deprecated_images_pulled_total`[since engine:1.177.1]
39+
<br>Total number of deprecated Schema 1 images pulls
40+
<br>Type: Counter
41+
<br>Labels:`image_name`
42+
3443
*`codefresh_engine_docker_daemon_requests_retries_delay_seconds_total`
3544
<br>Total delay in seconds for retry requests to Docker daemon
3645
<br>Type: Counter
37-
<br>Labels:`error`
46+
<br>Labels:`error`,`operation`[since engine:1.177.0]
47+
3848
*`codefresh_engine_docker_daemon_requests_retries_total`
3949
<br>Total number of retry requests to Docker daemon
4050
<br>Type: Counter
41-
<br>Labels:`error`
51+
<br>Labels:`error`,`operation`[since engine:1.177.0]
52+
4253
*`codefresh_workflow_composition_duration_seconds`
4354
<br>Composition duration in seconds
4455
<br>Type: Gauge
4556
<br>Labels:`composition_name`,`phase`
57+
4658
*`codefresh_workflow_composition_phase_status`
4759
<br>Composition phase status: 1 for current status, 0 otherwise
4860
<br>Type: Gauge
4961
<br>Labels:`composition_name`,`phase`,`status`
62+
5063
*`codefresh_workflow_composition_status`
5164
<br>Composition status: 1 for current status, 0 otherwise
5265
<br>Type: Gauge
5366
<br>Labels:`composition_name`,`status`
67+
5468
*`codefresh_workflow_duration_seconds`
5569
<br>Workflow duration in seconds
5670
<br>Type: Gauge
5771
<br>Labels:`phase`
72+
5873
*`codefresh_workflow_internal_images_reused`
5974
<br>1 if internal images were reused from cache by workflow, 0 otherwise
6075
<br>Type: Gauge
6176
<br>Labels: —
77+
6278
*`codefresh_workflow_phase_status`
6379
<br>Workflow phase status: 1 for current status, 0 otherwise
6480
<br>Type: Gauge
6581
<br>Labels:`phase`,`status`
82+
6683
*`codefresh_workflow_status`
6784
<br>Workflow status: 1 for current status, 0 otherwise
6885
<br>Type: Gauge
6986
<br>Labels:`status`
87+
7088
*`codefresh_workflow_step_duration_seconds`
7189
<br>Workflow step duration in seconds
7290
<br>Type: Gauge
7391
<br>Labels:`phase`,`step_name`,`step_type`
92+
7493
*`codefresh_workflow_step_status`
7594
<br>Workflow step status: 1 for current status, 0 otherwise
7695
<br>Type: Gauge
7796
<br>Labels:`phase`,`status`,`step_name`,`step_type`
97+
7898
*`codefresh_workflow_volume_reused`
7999
<br>1 if the volume was reused by workflow, 0 otherwise
80100
<br>Type: Gauge

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp