Prometheus GitHub Exporter
Exposes basic metrics for your repositories from the GitHub API, to a Prometheus compatible endpoint.
This exporter is setup to take input from environment variables. All variables are optional:
ORGSIf supplied, the exporter will enumerate all repositories for that organization. Expected in the format "org1, org2".
REPOSIf supplied, The repos you wish to monitor, expected in the format "user/repo1, user/repo2". Can be across different Github users/orgs.
USERSIf supplied, the exporter will enumerate all repositories for that users. Expected in the format "user1, user2".
GITHUB_TOKENIf supplied, enables the user to supply a github authentication token that allows the API to be queried more often. Optional, but recommended.
GITHUB_TOKEN_FILEIf 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.
API_URLGithub API URL, shouldn't need to change this. Defaults to
LISTEN_PORTThe port you wish to run the container on, the Dockerfile defaults this to
METRICS_PATHthe metrics URL path you wish to use, defaults to
LOG_LEVELThe level of logging the exporter will run with, defaults to
Install and deploy
Run manually from Docker Hub:
docker run -d --restart=always -p 9171:9171 -e REPOS="infinityworks/ranch-eye, infinityworks/prom-conf" infinityworks/github-exporter
Build a docker image:
docker build -t <image-name> . docker run -d --restart=always -p 9171:9171 -e REPOS="infinityworks/ranch-eye, infinityworks/prom-conf" <image-name>
github-exporter: tty: true stdin_open: true expose: - 9171 ports: - 9171:9171 image: infinityworks/github-exporter:latest environment: - REPOS=<REPOS you want to monitor> - GITHUB_TOKEN=<your github api token>
Metrics will be made available on port 9171 by default
An example of these metrics can be found in the
METRICS.md markdown file in the root of this repository
There is a set of blackbox behavioural tests which validate metrics endpoint in the
Run as follows
Version Release Procedure
Once a new pull request has been merged into
master the following script should be executed locally. The script will trigger a new image build in docker hub with the new image having the tag
release-<version>. The version is taken from the
VERSION file and must follow semantic versioning. For more information see semver.org.
Prior to running the following command ensure the number has been increased to desired version in