Skip to content

Add job_queue_duration_seconds metric #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Okabe-Junya merged 2 commits into from
Apr 28, 2026
+20 −1
Merged

Add job_queue_duration_seconds metric #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
14b7335
feat(listener): add job_queue_duration_seconds metric
Okabe-Junya Apr 24, 2026
f00c194
Merge branch 'mercari-master' into Okabe-Junya/feature/add-job-queue-…
azrsh Apr 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions cmd/ghalistener/metrics/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ const (
MetricIdleRunners = "gha_idle_runners"
MetricStartedJobsTotal = "gha_started_jobs_total"
MetricCompletedJobsTotal = "gha_completed_jobs_total"
MetricJobQueueDurationSeconds = "gha_job_queue_duration_seconds"
MetricJobStartupDurationSeconds = "gha_job_startup_duration_seconds"
MetricJobExecutionDurationSeconds = "gha_job_execution_duration_seconds"
)
Expand All @@ -71,6 +72,7 @@ var metricsHelp = metricsHelpRegistry{
MetricIdleRunners: "Number of registered runners not running a job.",
},
histograms: map[string]string{
MetricJobQueueDurationSeconds: "Time spent waiting for workflow jobs to get assigned to the scale set after queueing (in seconds).",
MetricJobStartupDurationSeconds: "Time spent waiting for workflow job to get started on the runner owned by the scale set (in seconds).",
MetricJobExecutionDurationSeconds: "Time spent executing workflow jobs by the scale set (in seconds).",
},
Expand Down Expand Up @@ -259,6 +261,16 @@ var defaultMetrics = v1alpha1.MetricsConfig{
},
},
Histograms: map[string]*v1alpha1.HistogramMetric{
MetricJobQueueDurationSeconds: {
Labels: []string{
labelKeyEnterprise,
labelKeyOrganization,
labelKeyRepository,
labelKeyJobName,
labelKeyEventName,
},
Buckets: defaultRuntimeBuckets,
},
MetricJobStartupDurationSeconds: {
Labels: []string{
labelKeyEnterprise,
Expand Down Expand Up @@ -481,6 +493,9 @@ func (e *exporter) PublishJobStarted(msg *actions.JobStarted) {
l := e.startedJobLabels(msg)
e.incCounter(MetricStartedJobsTotal, l)

queueDuration := msg.ScaleSetAssignTime.Unix() - msg.QueueTime.Unix()
e.observeHistogram(MetricJobQueueDurationSeconds, l, float64(queueDuration))
Comment on lines +496 to +497
Copy link
Copy Markdown

@azrsh azrsh Apr 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hope it doesn't include the concurrency wait 👍

Copy link
Copy Markdown
Member Author

@Okabe-Junya Okabe-Junya Apr 27, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's merge/release rc version, and try to test in our sandbox environment :)


startupDuration := msg.RunnerAssignTime.Unix() - msg.ScaleSetAssignTime.Unix()
e.observeHistogram(MetricJobStartupDurationSeconds, l, float64(startupDuration))
}
Expand Down
6 changes: 5 additions & 1 deletion cmd/ghalistener/metrics/metrics_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ func TestInstallMetrics(t *testing.T) {
Buckets: []float64{0.1, 1},
},
// histogram metric should be registered with default runtime buckets
MetricJobQueueDurationSeconds: {
Labels: []string{labelKeyRepository},
},
// histogram metric should be registered with default runtime buckets
MetricJobStartupDurationSeconds: {
Labels: []string{labelKeyRepository},
},
Expand All @@ -77,7 +81,7 @@ func TestInstallMetrics(t *testing.T) {
got := installMetrics(metricsConfig, reg, logr.Discard())
assert.Len(t, got.counters, 1)
assert.Len(t, got.gauges, 1)
assert.Len(t, got.histograms, 2)
assert.Len(t, got.histograms, 3)

assert.Equal(t, got.counters[MetricStartedJobsTotal].config, metricsConfig.Counters[MetricStartedJobsTotal])
assert.Equal(t, got.gauges[MetricAssignedJobs].config, metricsConfig.Gauges[MetricAssignedJobs])
Expand Down