https://github.com/pperzyna/bobcat_exporter
This is the Prometheus exporter for Bobcat Miner
https://github.com/pperzyna/bobcat_exporter
helium-network prometheus-exporter
Last synced: about 1 month ago
JSON representation
This is the Prometheus exporter for Bobcat Miner
- Host: GitHub
- URL: https://github.com/pperzyna/bobcat_exporter
- Owner: pperzyna
- License: apache-2.0
- Created: 2021-09-06T08:04:05.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-20T04:57:46.000Z (about 2 years ago)
- Last Synced: 2025-04-01T20:52:05.184Z (about 2 months ago)
- Topics: helium-network, prometheus-exporter
- Language: Go
- Homepage: https://pperzyna.com
- Size: 33.2 KB
- Stars: 3
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Bobcat Miner 300 Exporter
Prometheus exporter for [Bobcat Miner 300](https://www.bobcatminer.com/) - the [Helium](https://www.helium.com/) Miner.
It uses statistics from following endpoints:
- /temp.json
- /status.json
## Quick Start
This package is available as container:
1. Run Bobcat Exporter, where `http://XXXXXXX` is your Bobcat Miner address.
```bash
docker run -e BOBCAT_EXPORTER_MINER_URI="http://XXXXXXX" ghcr.io/pperzyna/bobcat_exporter
```
### Flags
- **`bobcat.uri`**
Address of Bobcat Miner.
Default is `http://localhost`.
- **`bobcat.timeout`**
Timeout request to Bobcat Miner.
Default is `5s`.
- **`web.listen-address`**
Address to listen on for web interface and telemetry.
Default is `:9857`.
- **`web.telemetry-path`**
Path under which to expose metrics.
Default is `/metrics`.
- **`log.level`**
Set logging level: one of `debug`, `info`, `warn`, `error`, `fatal`
Default is `info`.
- **`log.format`**
Set the log output target and format.
e.g. `logger:syslog?appname=bob&local=7` or `logger:stdout?json=true`
Defaults to `logger:stderr`.
### Environment Variables
The following environment variables configure the exporter:
- **`BOBCAT_EXPORTER_MINER_URI`**
Address of Bobcat Miner.
Default is `http://localhost`.
- **`BOBCAT_EXPORTER_MINER_TIMEOUT`**
Timeout reqeust to Bobcat Miner.
Default is `30s`.
- **`BOBCAT_EXPORTER_WEB_LISTEN_ADDRESS`**
Address to listen on for web interface and telemetry.
Default is `:9857`.
- **`BOBCAT_EXPORTER_WEB_TELEMETRY_PATH`**
Path under which to expose metrics.
Default is `/metrics`.
Settings set by environment variables starting with `BOBCAT_` will be overwritten by the corresponding CLI flag if given.
## Development
The default way to build is:
```bash
go get github.com/pperzyna/bobcat_exporter
cd ${GOPATH-$HOME/go}/src/github.com/pperzyna/bobcat_exporter/
go build -o bobcat_exporter
export BOBCAT_EXPORTER_MINER_URI="http://localhost"
./bobcat_exporter
```
See [CONTRIBUTING](CONTRIBUTING.md)