https://github.com/tedder/helium_hotspot_exporter
Prometheus exporter for the Helium hotspots
https://github.com/tedder/helium_hotspot_exporter
Last synced: 10 months ago
JSON representation
Prometheus exporter for the Helium hotspots
- Host: GitHub
- URL: https://github.com/tedder/helium_hotspot_exporter
- Owner: tedder
- License: mit
- Created: 2021-05-20T19:22:36.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2022-05-02T20:16:54.000Z (about 4 years ago)
- Last Synced: 2025-04-11T18:12:32.412Z (over 1 year ago)
- Language: Python
- Size: 16.6 KB
- Stars: 4
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# helium\_hotspot\_exporter
Prometheus exporter for [Helium hotspots](https://helium.com/). Using prometheus\_client, this code exposes metrics from the helium API to a prometheus compatible server.
This is only the exporter, which still requires a **prometheus server** for data and **grafana** for the dashboard.
**We need help making a dashboard**. For now, import by ID [14470](https://grafana.com/grafana/dashboards/14470) to see some of the values (though it isn't organized).
Note [port 9829 is the 'reserved' port for this specific exporter](https://github.com/prometheus/prometheus/wiki/Default-port-allocations).
## Run options
The list of hotspots you'd like to monitor can be specified several ways: by name, by address, or by account (owner) address. They all expect comma-separated values (or zero/one without a comma). Here are examples:
```
HOTSPOT_NAMES="angry-purple-tiger,bald cat lace"
HOTSPOT_ADDRESSES=aabbccdd112233XXYY...,bbccddee223344YYZZ...
ACCOUNT_ADDRESSES=Zzyzx0123...
```
Note hotspot names must be lowercased and hypenated before they hit the API. This code will normalize case and spaces. Names are also not guaranteed unique, the code will attempt to log an error if it isn't found or it isn't unique.
## Running via Docker
Using the docker file, you can run this with Docker or docker-compose! Both of these will expose Prometheus on port 9829. The images are hosted on both [GHCR](https://github.com/users/tedder/packages/container/package/helium_hotspot_exporter) and [Dockerhub](https://hub.docker.com/r/tedder42/helium_hotspot_exporter).
### Docker client
```
docker run -p 9829:9829 -e HOTSPOT_NAMES=angry-purple-tiger --name hotspot_exporter ghcr.io/tedder/helium_hotspot_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:
hotspot_exporter:
image: ghcr.io/tedder/helium_hotspot_exporter:latest
container_name: hotspot_exporter
ports:
- "9829:9829"
env:
HOTSPOT_NAMES: "angry-purple-tiger"
HOTSPOT_ADDRESSES: "aabbccdd112233XXYY...,bbccddee223344YYZZ..."
ACCOUNT_ADDRESSES: "Zzyzx0123..."
```