You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _docs/kb/articles/enable-engine-pod-metrics.md
+26-6Lines changed: 26 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,67 +14,87 @@ support-reviewed: 2023-04-18 LG
14
14
15
15
##Overview
16
16
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.
18
18
19
19
##Details
20
20
21
21
###How to enable
22
22
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.
24
25
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.
26
29
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"}.
28
32
29
33
30
34
###Available metrics
31
35
32
36
Each of the metrics below has the following additional labels:`account_name`,`docker_node_address`,`pipeline_id`,`repo_branch`,`workflow`