Merge pull request #11 from hairyhenderson/support-github-token-from-file

Support reading GITHUB_TOKEN from a file

Author: Rucknar

README.md

@@ -1,13 +1,14 @@
 # Prometheus GitHub Exporter
 
-Exposes basic metrics for your repositories from the GitHub API, to a Prometheus compatible endpoint. 
+Exposes basic metrics for your repositories from the GitHub API, to a Prometheus compatible endpoint.
 
 ## Configuration
 
 This exporter is setup to take input from environment variables:
 * `BIND_PORT` The port you wish to run the container on, defaults to `9171`
-* `GITHUB_TOKEN` If supplied, enables the user to supply a github authentication token that allows the API to be quried more often. Optional, but reccomended.
-* `ORGS` If supplied, the exporter will enumerate all repositories for that orginisation.
+* `GITHUB_TOKEN` If supplied, enables the user to supply a github authentication token that allows the API to be queried more often. Optional, but recommended.
+* `GITHUB_TOKEN_FILE` If supplied _instead of_ `GITHUB_TOKEN`, enables the user to supply a path to a file containing a github authentication token that allows the API to be queried more often. Optional, but recommended.
+* `ORGS` If supplied, the exporter will enumerate all repositories for that organization.
 * `REPOS` If supplied, The images you wish to monitor, expected in the format "user/repo1, user/repo2". Can be across different Github users/orgs.
 
 ## Install and deploy

github_exporter.py

@@ -58,16 +58,25 @@ def _collect_org_metrics(self, gauges, metrics):
       for repo in response_json:
         self._add_metrics(gauges, metrics, repo)
 
+  def _get_github_token(self):
+    if os.getenv('GITHUB_TOKEN'):
+      return os.getenv('GITHUB_TOKEN')
+    elif os.getenv('GITHUB_TOKEN_FILE'):
+      return open(os.getenv('GITHUB_TOKEN_FILE'), 'r').read().rstrip()
+    else:
+      return None
+
   def _get_json(self, url: str):
     """
     using github core api
     rate limit 5000 per hours
     """
     print("Getting JSON Payload for " + url)
-    if os.getenv('GITHUB_TOKEN'):
-      payload = {"access_token":os.environ["GITHUB_TOKEN"]}
+    gh_token = self._get_github_token()
+    if gh_token:
+      payload = {"access_token": gh_token}
       r = requests.get(url,params=payload)
-    else: 
+    else:
       r = requests.get(url)
     result = json.loads(r.content.decode('UTF-8'))
     if result is None:
@@ -91,9 +100,10 @@ def _pagination(self, response: requests.Response, result):
 
   def _check_api_limit(self):
     rate_limit_url = "https://api.github.com/rate_limit"
-    if os.getenv('GITHUB_TOKEN'):
-      print("Authentication token detected: " + os.getenv('GITHUB_TOKEN'))
-      payload = {"access_token":os.environ["GITHUB_TOKEN"]}
+    gh_token = self._get_github_token()
+    if gh_token:
+      print("Authentication token detected: " + gh_token)
+      payload = {"access_token": gh_token}
       R = requests.get(rate_limit_url,params=payload)
     else:
       R = requests.get(rate_limit_url)
@@ -119,6 +129,6 @@ def sigterm_handler(_signo, _stack_frame):
     exit(1)
   start_http_server(int(os.getenv('BIND_PORT')))
   REGISTRY.register(GitHubCollector())
-  
+
   signal.signal(signal.SIGTERM, sigterm_handler)
-  while True: time.sleep(1)
+  while True: time.sleep(1)