Poll Actions Runner API for gauge metrics on runner pools

[janakerman]

Perhaps it would make sense to add support for metrics on self-hosted runners using the Github Actions API? It would be possible to export gauge metrics showing the numbers of online/offline & busy/idle runners for a runner group within an organisation/enterprise.

Adding more functionality based on polling comes with the increased potential of hitting API rate limits. The minimum Github App limits (5000 per hour) this works out at about ~80 requests per minute which is probably sufficient for most use cases. If it became an issue we could

• Providing configurable polling frequency
• Conditional HTTP requests (If-None-Match)
• Exporting Github rate limit usage (maybe useful anyway!)

Docs:

• https://docs.github.com/en/rest/actions/self-hosted-runners
• https://docs.github.com/en/rest/actions/self-hosted-runner-groups

[cpanato]

sounds a great idea!

[apoorva-marisomaradhya]

Hello @cpanato ! Any update on this issue? I am looking to get metrics for self-hosted github runners and this exporter doesn't seem to provide metrics for self-hosted yet.

[cpanato]

@apoorva-marisomaradhya sorry for the delay, is something you would like to contribute?

[peterhalasz]

Hi!
I would love to add metrics for self-hosted runners, that would come in handy for sure.
I can put up a PR for it in the next few days.