Skip to content

This is the Prometheus exporter for Bobcat Miner

License

Notifications You must be signed in to change notification settings

pperzyna/bobcat_exporter

Repository files navigation

Bobcat Miner 300 Exporter

Prometheus exporter for Bobcat Miner 300 - the Helium 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.
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:

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 <flags>

See CONTRIBUTING