https://github.com/infinityworks/docker-hub-exporter
Prometheus exporter for the Docker Hub
https://github.com/infinityworks/docker-hub-exporter
docker dockerhub exporter monitoring prometheus prometheus-exporter
Last synced: 6 months ago
JSON representation
Prometheus exporter for the Docker Hub
- Host: GitHub
- URL: https://github.com/infinityworks/docker-hub-exporter
- Owner: infinityworks
- License: mit
- Archived: true
- Created: 2016-09-08T08:25:56.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-09-20T07:50:41.000Z (about 3 years ago)
- Last Synced: 2024-11-05T22:41:17.305Z (11 months ago)
- Topics: docker, dockerhub, exporter, monitoring, prometheus, prometheus-exporter
- Language: Go
- Size: 27.3 KB
- Stars: 78
- Watchers: 6
- Forks: 28
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Prometheus Docker Hub Exporter
Exposes metrics of container pulls and stars from the Docker Hub API, to a Prometheus compatible endpoint. The exporter is capable of pulling down stats for individual images, or for orgs or users from DockerHub. This is based on the un-documented V2 Docker Hub API.
```
!!! This repository is now deprecated, feel free to fork !!!
```
## Configuration
The image is setup to take parameters from environment variables or flags:
The available environment variables are:
* `BIND_PORT` The port you wish to run the container on, defaults to 9170
* `ORGS` The docker hub organizations you wish to monitor, expected in the format "org1, org2" (Also works for users)
* `IMAGES` The images you wish to monitor, expected in the format "user/image1, user/image2". Can be across different dockerhub users.
Below is a list of the available flags. You can also find this list by using the `--help` flag.
* `images` Images you wish to monitor: expected format 'user/image1,user/image2'
* `listen-address` Address on which to expose metrics and web interface. (default ":9170")
* `organisations` Organisations/Users you wish to monitor: expected format 'org1,org2'
* `telemetry-path` Path under which to expose metrics. (default "/metrics")
## Install and deploy
Run manually from Docker Hub:
```
docker run -d --restart=always -p 9170:9170 infinityworks/docker-hub-exporter -listen-address=:9170 -images="infinityworks/ranch-eye,infinityworks/prom-conf" -organisations="super6awspoc"
```
Build a docker image:
```
docker build -t .
docker run -d --restart=always -p 9170:9170 -listen-address=:9170 -images="infinityworks/ranch-eye,infinityworks/prom-conf" -organisations="super6awspoc"
```
## Known Issues
Currently there is a known issue with this build where if you provide a image or list of images belonging to an organisation
that has also been passed into the application then Prometheus will error during metrics gathering reporting that the metric was already collected with the same name and labels.
## Metrics
Metrics will be made available on port 8080 by default
An example of these metrics can be found in the `METRICS.md` markdown file in the root of this repository
## Metadata
[](http://microbadger.com/images/infinityworks/docker-hub-exporter "Get your own image badge on microbadger.com") [](http://microbadger.com/images/infinityworks/docker-hub-exporter "Get your own version badge on microbadger.com")