public_git/actions-runner-controller
1
0
Fork 0
mirror of https://github.com/actions-runner-controller/actions-runner-controller.git synced 2026-09-30 07:08:10 +02:00
Code Issues Projects Releases Wiki Activity

Document which listenerMetrics example labels are not exposed by default (#4633)

Browse Source
This commit is contained in:
KR Ravindra
2026-09-21 12:43:25 +02:00
committed by GitHub
parent 68e4cfeea5
commit 5b04894313
3 changed files with 218 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
charts/gha-runner-scale-set-experimental/values.yaml
+36 -6
View File
@@ -323,15 +323,33 @@ listener:
## metrics configuration for the listener.
## In order to avoid helm merging these fields, we left the metrics commented out.
## When configuring metrics, please uncomment the metrics object below.
## You can modify the configuration to remove the label or specify custom buckets for histogram.
## You can modify the configuration to add or remove labels or specify custom buckets for histograms.
##
## If the buckets field is not specified, the default buckets will be applied. Default buckets are
## provided here for documentation purposes
## The example below lists every metric and every label the listener can export, together with the
## default buckets. It is not identical to the built-in defaults used when listener.metrics is not set: the
## labels marked "not exposed by default" ("job_workflow_ref", "job_workflow_name" and
## "job_workflow_target") are opt-in, so remove them to keep the default label set. If the buckets
## field is not specified, the default buckets will be applied.
##
## "job_workflow_ref" and "job_workflow_target" contain the git ref the workflow ran from (for example
## refs/heads/<branch> or refs/pull/<number>/merge), so every branch and pull request creates a new
## time series per job. On histograms this is multiplied by the number of buckets. Only keep these
## labels when your metrics backend can handle the resulting cardinality.
# metrics:
# counters:
# gha_started_jobs_total:
# labels:
# ["repository", "organization", "enterprise", "job_name", "event_name", "job_workflow_ref", "job_workflow_name", "job_workflow_target"]
# [
# "repository",
# "organization",
# "enterprise",
# "job_name",
# "event_name",
# # not exposed by default:
# "job_workflow_ref",
# "job_workflow_name",
# "job_workflow_target",
# ]
# gha_completed_jobs_total:
# labels:
# [
@@ -341,6 +359,7 @@ listener:
# "job_name",
# "event_name",
# "job_result",
# # not exposed by default:
# "job_workflow_ref",
# "job_workflow_name",
# "job_workflow_target",
@@ -365,7 +384,17 @@ listener:
# histograms:
# gha_job_startup_duration_seconds:
# labels:
# ["repository", "organization", "enterprise", "job_name", "event_name","job_workflow_ref", "job_workflow_name", "job_workflow_target"]
# [
# "repository",
# "organization",
# "enterprise",
# "job_name",
# "event_name",
# # not exposed by default:
# "job_workflow_ref",
# "job_workflow_name",
# "job_workflow_target",
# ]
# buckets:
# [
# 0.01,
@@ -423,9 +452,10 @@ listener:
# "job_name",
# "event_name",
# "job_result",
# # not exposed by default:
# "job_workflow_ref",
# "job_workflow_name",
# "job_workflow_target"
# "job_workflow_target",
# ]
# buckets:
# [
charts/gha-runner-scale-set/values.yaml
+36 -6
View File
@@ -155,15 +155,33 @@ listenerConfig:
## listenerMetrics are configurable metrics applied to the listener.
## In order to avoid helm merging these fields, we left the metrics commented out.
## When configuring metrics, please uncomment the listenerMetrics object below.
## You can modify the configuration to remove the label or specify custom buckets for histogram.
## You can modify the configuration to add or remove labels or specify custom buckets for histograms.
##
## If the buckets field is not specified, the default buckets will be applied. Default buckets are
## provided here for documentation purposes
## The example below lists every metric and every label the listener can export, together with the
## default buckets. It is not identical to the built-in defaults used when listenerMetrics is not set: the
## labels marked "not exposed by default" ("job_workflow_ref", "job_workflow_name" and
## "job_workflow_target") are opt-in, so remove them to keep the default label set. If the buckets
## field is not specified, the default buckets will be applied.
##
## "job_workflow_ref" and "job_workflow_target" contain the git ref the workflow ran from (for example
## refs/heads/<branch> or refs/pull/<number>/merge), so every branch and pull request creates a new
## time series per job. On histograms this is multiplied by the number of buckets. Only keep these
## labels when your metrics backend can handle the resulting cardinality.
# listenerMetrics:
# counters:
# gha_started_jobs_total:
# labels:
# ["repository", "organization", "enterprise", "job_name", "event_name", "job_workflow_ref", "job_workflow_name", "job_workflow_target"]
# [
# "repository",
# "organization",
# "enterprise",
# "job_name",
# "event_name",
# # not exposed by default:
# "job_workflow_ref",
# "job_workflow_name",
# "job_workflow_target",
# ]
# gha_completed_jobs_total:
# labels:
# [
@@ -173,6 +191,7 @@ listenerConfig:
# "job_name",
# "event_name",
# "job_result",
# # not exposed by default:
# "job_workflow_ref",
# "job_workflow_name",
# "job_workflow_target",
@@ -197,7 +216,17 @@ listenerConfig:
# histograms:
# gha_job_startup_duration_seconds:
# labels:
# ["repository", "organization", "enterprise", "job_name", "event_name","job_workflow_ref", "job_workflow_name", "job_workflow_target"]
# [
# "repository",
# "organization",
# "enterprise",
# "job_name",
# "event_name",
# # not exposed by default:
# "job_workflow_ref",
# "job_workflow_name",
# "job_workflow_target",
# ]
# buckets:
# [
# 0.01,
@@ -255,9 +284,10 @@ listenerConfig:
# "job_name",
# "event_name",
# "job_result",
# # not exposed by default:
# "job_workflow_ref",
# "job_workflow_name",
# "job_workflow_target"
# "job_workflow_target",
# ]
# buckets:
# [