https://github.com/promhippie/github_exporter

Prometheus exporter for GitHub
https://github.com/promhippie/github_exporter

github metrics prometheus prometheus-exporter

Last synced: 17 days ago
JSON representation

Prometheus exporter for GitHub

• Host: GitHub
• URL: https://github.com/promhippie/github_exporter
• Owner: promhippie
• License: apache-2.0
• Created: 2017-04-29T09:35:49.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T18:46:13.000Z (about 1 month ago)
• Last Synced: 2024-10-29T22:18:20.132Z (about 1 month ago)
• Topics: github, metrics, prometheus, prometheus-exporter
• Language: Go
• Homepage: https://promhippie.github.io/github_exporter/
• Size: 2.14 MB
• Stars: 109
• Watchers: 5
• Forks: 20
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ccamel - promhippie/github_exporter - Prometheus exporter for GitHub (Go)

README

        
# GitHub Exporter

[![Current Tag](https://img.shields.io/github/v/tag/promhippie/github_exporter?sort=semver)](https://github.com/promhippie/github_exporter) [![General Build](https://github.com/promhippie/github_exporter/actions/workflows/general.yml/badge.svg)](https://github.com/promhippie/github_exporter/actions/workflows/general.yml) [![Join the Matrix chat at https://matrix.to/#/#webhippie:matrix.org](https://img.shields.io/badge/matrix-%23webhippie-7bc9a4.svg)](https://matrix.to/#/#webhippie:matrix.org) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/af9b80ac46294ac9a52d823e991eb4e9)](https://app.codacy.com/gh/promhippie/github_exporter/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![Go Doc](https://godoc.org/github.com/promhippie/github_exporter?status.svg)](http://godoc.org/github.com/promhippie/github_exporter) [![Go Report](http://goreportcard.com/badge/github.com/promhippie/github_exporter)](http://goreportcard.com/report/github.com/promhippie/github_exporter)

An exporter for [Prometheus][prometheus] that collects metrics from

[GitHub][github].

## Install

You can download prebuilt binaries from our [GitHub releases][releases], or you

can use our containers published on [Docker Hub][dockerhub] and [Quay][quayio].

If you need further guidance how to install this take a look at our

[documentation][docs].

## Development

Make sure you have a working Go environment, for further reference or a guide

take a look at the [install instructions][golang]. This project requires

Go >= v1.17, at least that's the version we are using.

```console

git clone https://github.com/promhippie/github_exporter.git

cd github_exporter

make generate build

./bin/github_exporter -h

```

## Security

If you find a security issue please contact

[[email protected]](mailto:[email protected]) first.

## Contributing

Fork -> Patch -> Push -> Pull Request

## Authors

-   [Thomas Boerger](https://github.com/tboerger)

## License

Apache-2.0

## Copyright

```console

Copyright (c) 2018 Thomas Boerger 

```

[prometheus]: https://prometheus.io

[github]: https://github.com

[releases]: https://github.com/promhippie/github_exporter/releases

[dockerhub]: https://hub.docker.com/r/promhippie/github-exporter/tags/

[quayio]: https://quay.io/repository/promhippie/github-exporter?tab=tags

[docs]: https://promhippie.github.io/github_exporter/#getting-started

[golang]: http://golang.org/doc/install.html