actions / actions/actions-runner-controller

Runner Counts Incorrect in metrics in 0.11.0

Open
#4,013 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug gha-runner-scale-set needs triage
Dominant language
Go
Stars
6.5k
Forks
1.5k
Avg merge
2d 2h
Merged PRs (30d)
27

Description

Checks
Controller Version

0.11.0

Deployment Method

Helm

Checks
  • This isn't a question or user support case (For Q&A and community support, go to Discussions).
  • I've read the Changelog before submitting this issue and I'm sure it's not due to any recently-introduced backward-incompatible changes
To Reproduce
1. Enable all listenerMetrics as mentioned in the 0.11.0 [release notes](https://github.com/actions/actions-runner-controller/releases/tag/gha-runner-scale-set-0.11.0) and [related issue](https://github.com/actions/actions-runner-controller/issues/3993)
2. port-forward the metrics container port to local
3. Run some jobs and monitor metrics
Describe the bug

The gha_assigned_jobs, gha_busy_runners, and gha_idle_runners gauges never match the actual values or the values displayed inside of Github (which are correct). This issue started with upgrading to 0.11.0. The 0.10.1 values before the change to how metrics worked were correct.

With no jobs running, the gauges correctly report no assigned jobs, but 5 busy runners and 5 idle runners. The correct counts are actually 0/0/3 (3 idle runners, no busy).

# HELP gha_assigned_jobs Number of jobs assigned to this scale set.
# TYPE gha_assigned_jobs gauge
gha_assigned_jobs{name="cicd-pipelines-x2bqb"} 0
# HELP gha_busy_runners Number of registered runners running a job.
# TYPE gha_busy_runners gauge
gha_busy_runners{name="cicd-pipelines-x2bqb"} 5
# HELP gha_idle_runners Number of registered runners not running a job.
# TYPE gha_idle_runners gauge
gha_idle_runners{name="cicd-pipelines-x2bqb"} 5

Image

Describe the expected behavior

The gha_assigned_jobs, gha_busy_runners, and gha_idle_runners gauges should match the numbers visible in Github.

Additional Context
The listener metrics values in the runner scaling set. They are just the uncommented defaults.


listenerMetrics:
  counters:
    gha_started_jobs_total:
      labels:
        ["repository", "job_name", "event_name"]
    gha_completed_jobs_total:
      labels:
        [
          "repository",
          "job_name",
          "event_name",
          "job_result",
        ]
  gauges:
    gha_assigned_jobs:
      labels: ["name"]
    gha_running_jobs:
      labels: ["name"]
    gha_registered_runners:
      labels: ["name"]
    gha_busy_runners:
      labels: ["name"]
    gha_min_runners:
      labels: ["name"]
    gha_max_runners:
      labels: ["name"]
    gha_desired_runners:
      labels: ["name"]
    gha_idle_runners:
      labels: ["name"]
  histograms:
    gha_job_startup_duration_seconds:
      labels:
        ["repository", "organization", "enterprise", "job_name", "event_name"]
      buckets:
        [
          0.01,
          0.05,
          0.1,
          0.5,
          1.0,
          2.0,
          3.0,
          4.0,
          5.0,
          6.0,
          7.0,
          8.0,
          9.0,
          10.0,
          12.0,
          15.0,
          18.0,
          20.0,
          25.0,
          30.0,
          40.0,
          50.0,
          60.0,
          70.0,
          80.0,
          90.0,
          100.0,
          110.0,
          120.0,
          150.0,
          180.0,
          210.0,
          240.0,
          300.0,
          360.0,
          420.0,
          480.0,
          540.0,
          600.0,
          900.0,
          1200.0,
          1800.0,
          2400.0,
          3000.0,
          3600.0,
        ]
    gha_job_execution_duration_seconds:
      labels:
        [
          "repository",
          "organization",
          "enterprise",
          "job_name",
          "event_name",
          "job_result",
        ]
      buckets:
        [
          0.01,
          0.05,
          0.1,
          0.5,
          1.0,
          2.0,
          3.0,
          4.0,
          5.0,
          6.0,
          7.0,
          8.0,
          9.0,
          10.0,
          12.0,
          15.0,
          18.0,
          20.0,
          25.0,
          30.0,
          40.0,
          50.0,
          60.0,
          70.0,
          80.0,
          90.0,
          100.0,
          110.0,
          120.0,
          150.0,
          180.0,
          210.0,
          240.0,
          300.0,
          360.0,
          420.0,
          480.0,
          540.0,
          600.0,
          900.0,
          1200.0,
          1800.0,
          2400.0,
          3000.0,
          3600.0,
        ]
Controller Logs
Controller logs: https://gist.github.com/AngellusMortis/db74503c1c9717ad4d3dc9975b6b73ab
Runner Pod Logs
Listener logs: https://gist.github.com/AngellusMortis/66227f21bad83088e3edc9b307a8642e

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the listener metrics configuration and the linked controller and listener logs, then compare the gauge behavior in 0.11.0 with the reported 0.10.1 behavior. Reproduce the setup with the listed listenerMetrics defaults and verify that gha_assigned_jobs, gha_busy_runners, and gha_idle_runners match GitHub's runner counts.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, go, helm, kubernetes
Domain
infrastructure, observability-sre
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.