Fix total runner limit (#11)

The Github API has pagination limited to 30 results per page, added pagination support to return the full runners list.

Thanks @PaulLesur

Author: tchelovilar

deploy/helm-chart/prometheus-org-runner-exporter/Chart.yaml

@@ -4,9 +4,9 @@ description: A Helm chart for Kubernetes
 
 type: application
 
-version: 0.1.6
+version: 0.1.7
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
-appVersion: 0.1.6
+appVersion: 0.1.7

deploy/helm-chart/prometheus-org-runner-exporter/values.yaml

@@ -3,7 +3,7 @@
 image:
   repository: tchelovilar/github-org-runner-exporter
   pullPolicy: IfNotPresent
-  tag: "0.1.6"
+  tag: "0.1.7"
 
 
 nameOverride: ""

runner_exporter/runner_exporter.py

@@ -155,36 +155,72 @@ def export_runner_busy(self, runner: dict, agg_labels: str):
         ).set(idle)
 
 
+class githubApi:
+    def __init__(self, github_token, github_owner, logger) -> None:
+        self.metric_runner_api_ratelimit = Gauge(
+            "github_runner_api_remain_rate_limit",
+            "Github Api remaining requests rate limit (per hour)",
+            ["org"],
+        )
+
+        self.headers = {"Authorization": f"token {github_token}"}
+        self.github_owner = github_owner
+
+        self.logger = logger
+
+    def list_runners(self) -> list:
+        runners_list = []
+
+        per_page = 100
+        url = f"https://api.github.com/orgs/{self.github_owner}/actions/runners?per_page={per_page}"
+
+        while True:
+            try:
+                self.logger.debug(f"Sending the api request for {url}")
+                result = requests.get(url, headers=self.headers)
+
+                if result.headers:
+                    remaining_requests = result.headers.get("X-RateLimit-Remaining")
+                    logger.debug(f"Remaining requests: {remaining_requests}")
+                    self.metric_runner_api_ratelimit.labels(self.github_owner).set(
+                        int(remaining_requests)
+                    )
+
+                if not result.ok:
+                    logger.error(
+                        f"Api request returned error: {result.reason} {result.text}"
+                    )
+                    return []
+
+                api_result = result.json()
+                runners_list += api_result["runners"]
+
+                if "next" in result.links.keys():
+                    url = result.links["next"]["url"]
+                else:
+                    break
+            except Exception as error:
+                logger.error(f"Exception: {error}")
+                return []
+
+        return runners_list
+
+
 def main():
 
     # Start prometheus metrics
     logger.info("Starting metrics server")
     start_http_server(8000)
 
-    metric_runner_api_ratelimit = Gauge(
-        "github_runner_api_remain_rate_limit",
-        "Github Api remaining requests rate limit (per hour)",
-        ["org"],
-    )
-
     runner_exports = runnerExports()
 
+    github = githubApi(PRIVATE_GITHUB_TOKEN, OWNER, logger)
+
     while True:
-        headers = {"Authorization": f"token {PRIVATE_GITHUB_TOKEN}"}
-        url = f"https://api.github.com/orgs/{OWNER}/actions/runners"
-        logger.debug(f"Sending the api request for /orgs/{OWNER}/actions/runners")
-        result = requests.get(url, headers=headers)
-
-        if result.headers:
-            value = result.headers.get("X-RateLimit-Remaining")
-            logger.debug(f"Remaining requests: {value}")
-            metric_runner_api_ratelimit.labels(OWNER).set(int(value))
-
-        if result.ok:
-            runner_list = result.json()
-            runner_exports.export_metrics(runner_list["runners"])
-        else:
-            logger.error(f"Api request returned error: {result.reason} {result.text}")
+        runners_list = github.list_runners()
+
+        if runners_list:
+            runner_exports.export_metrics(runners_list)
 
         sleep(REFRESH_INTERVAL)