actions / actions/actions-runner-controller
Add Prometheus Metric for number of jobs waiting for self-hosted runners
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 6.5k
- Forks
- 1.5k
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 27
Description
What would you like added?
Add a Prometheus metric github_workflow_jobs_in_queue to track the number of jobs waiting for self-hosted runners. This metric will help to monitor and analyse the performance of the infrastructure to add pods in time.
Why is this needed?
This metric is needed to provide better visibility of the infrastructure how fast it reacts on job requests.
Also, if the queue is high, then it means that jobs are not started timely, or the system cannot deal in time with the number of requests. This is recognised by the users.
Having a large queue give the administrator a clear indicator of jobs not assigned to pods in time.
Additional context
none
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Begin by locating the repository's Prometheus instrumentation and the self-hosted-runner job request handling. The work is done when a github_workflow_jobs_in_queue metric reports the number of jobs waiting for self-hosted runners and its behavior is verified through the repository's relevant checks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, go, kubernetes, prometheus
- Domain
- devops, infrastructure, observability
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100