GitHub Exporter
An exporter for Prometheus that collects metrics from GitHub.
Install
You can download prebuilt binaries from our GitHub releases. Besides that we also prepared repositories for DEB and RPM packages which can be found at Cloudsmith. If you prefer to use containers you could use our images published on GHCR, Docker Hub or Quay. If you need further guidance how to install this take a look at our docs.
Package repository hosting is graciously provided by Cloudsmith. Cloudsmith is the only fully hosted, cloud-native, universal package management solution, that enables your organization to create, store and share packages in any format, to any place, with total confidence.
Development
If you are not familiar with Nix it is up to you to have a working environment for Go (>= 1.26.0) as the setup won't we covered within this guide. Please follow the official install instructions for Go. Beside that we are using go-task to define all commands to build this project.
git clone https://github.com/promhippie/github_exporter.git cd github_exporter task generate build ./bin/github_exporter -h
If you got Nix and Direnv configured you can simply execute the following commands to get al dependencies including go-task and the required runtimes installed. You are also able to directly use the process manager of devenv:
cat << EOF > .envrc use flake . --impure --extra-experimental-features nix-command EOF direnv allow
To start developing on this project you have to execute only a few commands:
task watch
The development server should be running on http://localhost:9504. Generally it supports hot reloading which means the services are automatically restarted/reloaded on code changes.
If you got Nix configured you can simply execute the devenv command to start:
devenv up
Security
If you find a security issue please contact thomas@webhippie.de first.
Contributing
Fork -> Patch -> Push -> Pull Request
Authors
License
Apache-2.0
Copyright
Copyright (c) 2018 Thomas Boerger <thomas@webhippie.de>