https://github.com/skuzzle/gh-prom-exporter

Export your favorite GitHub repositories to Prometheus - SAAS or on-premise
https://github.com/skuzzle/gh-prom-exporter

github java prometheus-exporter spring-boot

Last synced: 9 days ago
JSON representation

Export your favorite GitHub repositories to Prometheus - SAAS or on-premise

• Host: GitHub
• URL: https://github.com/skuzzle/gh-prom-exporter
• Owner: skuzzle
• License: mit
• Created: 2021-11-15T10:59:05.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T11:01:14.000Z (almost 2 years ago)
• Last Synced: 2024-10-08T13:09:11.947Z (28 days ago)
• Topics: github, java, prometheus-exporter, spring-boot
• Language: Java
• Homepage: https://gh.skuzzle.de
• Size: 369 KB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


[![Coverage Status](https://coveralls.io/repos/github/skuzzle/gh-prom-exporter/badge.svg?branch=master)](https://coveralls.io/github/skuzzle/gh-prom-exporter?branch=master)

[![Twitter Follow](https://img.shields.io/twitter/follow/skuzzleOSS.svg?style=social)](https://twitter.com/skuzzleOSS)

# gh-prom-exporter

Export your favorite GitHub repositories to Prometheus

* Use it _as a service_: See https://gh.skuzzle.de for instructions

* Deploy it _on-premise_: `docker pull ghcr.io/skuzzle/gh-prom-exporter/gh-prom-exporter:0.0.19`

## On-Premise deployment with docker

This application can easily be run as a docker container in whatever environment you like:

```

docker run -p 8080:8080 \

    -e WEB_ALLOWANONYMOUSSCRAPE=true \

    ghcr.io/skuzzle/gh-prom-exporter/gh-prom-exporter:0.0.19

```

With _anonymous scraping_ allowed, you can now easily view the scrape results directly in the browser by navigating to

`http://localhost:8080/YOUR-GITHUB-USERNAME/YOUR-REPOSITORY`.

The scraped repository can just as easily be added as static scrape target to your prometheus' scrape configs. You can

also scrape multiple repositories of the same owner at once: 

```

scrape_configs:

- job_name: CHANGE_ME

  scrape_interval: 2m

  metrics_path: /YOUR-GITHUB-USERNAME/YOUR-REPOSITORY1,YOUR-REPOSITORY2

  static_configs:

    - targets: ['your.docker.host:8080']

```

In case you want to enforce authenticated scrapes only, use this configuration instead:

```

docker run -p 8080:8080 \

    ghcr.io/skuzzle/gh-prom-exporter/gh-prom-exporter:0.0.19

```

Scraping now requires a GitHub access token, otherwise the service will respond with 401/Unauthorized. 

```

scrape_configs:

- job_name: CHANGE_ME

  scrape_interval: 2m

  basic_auth: 

    username: YOUR-GITHUB-USERNAME

    password: YOUR-GITHUB-ACCESS-TOKEN

  metrics_path: /YOUR-GITHUB-USERNAME/YOUR-REPOSITORY

  static_configs:

    - targets: ['your.docker.host:8080']

```