https://github.com/tedder/miner_exporter
helium miner prometheus client exporter
https://github.com/tedder/miner_exporter
Last synced: over 1 year ago
JSON representation
helium miner prometheus client exporter
- Host: GitHub
- URL: https://github.com/tedder/miner_exporter
- Owner: tedder
- License: mit
- Created: 2021-04-05T14:29:03.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-11-30T16:45:45.000Z (over 4 years ago)
- Last Synced: 2025-04-11T18:12:30.860Z (over 1 year ago)
- Language: Python
- Size: 174 KB
- Stars: 19
- Watchers: 7
- Forks: 18
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# miner\_exporter
Prometheus exporter for the [Helium miner (validator)](https://github.com/helium/miner). Using prometheus\_client, this code exposes metrics from the helium miner to a prometheus compatible server.
This is only the exporter, which still requires a **prometheus server** for data and **grafana** for the dashboard. Prometheus and Grafana servers can run on an external machine, the same machine as the miner, or possibly using a cloud service. The [helium\_miner\_grafana\_dashboard](https://github.com/tedder/helium_miner_grafana_dashboard) can be imported to Grafana.
Note [port 9825 is the 'reserved' port for this specific exporter](https://github.com/prometheus/prometheus/wiki/Default-port-allocations). Feel free to use whatever you like, of course, but you won't be able to [dial 9VAL on your phone](https://en.wikipedia.org/wiki/E.161).
## Running via Docker
Using the docker file, you can run this with Docker or docker-compose! Both of these expose Prometheus on 9825, feel free to choose your own port. The images are hosted on both [GHCR](https://github.com/users/tedder/packages/container/package/miner_exporter) and [Dockerhub](https://hub.docker.com/r/tedder42/miner_exporter).
### Docker client
```
docker run -p 9825:9825 --name miner_exporter -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/tedder/miner_exporter:latest
```
### Docker-Compose
Using your existing docker-compose file, add the section for the exporter (below). When you're done, run `docker-compose up -d` as usual. That's it!
```
version: "3"
services:
validator:
image: quay.io/team-helium/validator:latest-val-amd64
container_name: validator
...
miner_exporter:
image: ghcr.io/tedder/miner_exporter:latest
container_name: miner_exporter
volumes:
- /var/run/docker.sock:/var/run/docker.sock
ports:
- "9825:9825"
```
## Running locally
On the miner machine:
install python3
```
pip install prometheus_client psutil docker
```
Details on the libraries:
* [client\_python](https://github.com/prometheus/client_python)
* [psutil](https://github.com/giampaolo/psutil)
* [docker](https://pypi.org/project/docker/)
## Configuration
The following have valid defaults, but you can change them:
```
UPDATE_PERIOD # seconds between scrapes, int
VALIDATOR_CONTAINER_NAME # eg 'validator', string
API_BASE_URL # URL for api access, string. For testnet, set to "https://testnet-api.helium.wtf/v1"
ENABLE_RPC # opt in to using the RPC API with a truthy value (defaults to falsey value until `exec` calls are fully replaced).
```