miner-exporter

Prometheus exporters for various crypto miners. The following miners are currently supported:

• ANTMINER
• AVALON
• BITAXE

Each miner-exporter instance is designed to monitor a single miner. If possible install it directly on the miner, but since that can be a bit complicated it is also alright to run the exporters on a single Raspberry Pi or similar.

Examples

Miners: Overview (overview.json)

Miners: BTC (details01.json)

Miners: LTC & Doge (details02.json)

Metrics

Metric	Type	Description
miner_uptime_total	counter	Time since last boot in seconds
miner_accepted_total	counter	Total number of shares accepted
miner_rejected_total	counter	Total number of shares rejected
miner_found_total	counter	Total number of blocks found
miner_hashrate	gauge	Current miner hashrate in TH/s
miner_temperature	gauge	Current miner temperature in C
miner_fan_rpm	gauge	Current miner fan RPM
miner_pool_alive	gauge	Current pool liveness
miner_pool_active	gauge	If pool is currently active
miner_pool_accepted_total	counter	Total numer of shares accepted for the pool
miner_pool_rejected_total	counter	Total number of shares rejected for the pool

Labels

LABEL	COMMENT	SECTION
miner	Miner ID from ENV
type	Miner Type from ENV
board	Board number	TEMPERATURE
temperature_type	CHIP, PCB	TEMPERATURE
fan	Fan number	FAN
pool	Pool number	POOL
pool_priority	Pool priority	POOL
pool_uri	Pool URI	POOL
pool_user	Pool user	POOL

Environment

Miners are configured via the following environment variables.

NAME	REQUIRED	DEFAULT	COMMENT
MINER_ID	Y	-	Example: miner01
MINER_TYPE	Y	-	ANTMINER, AVALON, BITAXE
MINER_URI	Y	-	Example: tcp://10.10.10.1:4028
MINER_AUTH	-	NONE	NONE, BASIC, DIGEST
MINER_USERNAME	-	-
MINER_PASSWORD	-	-
CONNECT_TIMEOUT	-	1s
READ_TIMEOUT	-	4s
READ_BUFFER_SIZE	-	8192
LISTEN_ADDR	-	0.0.0.0
LISTEN_PORT	-	8080
LOG_LEVEL	-	INFO	DEBUG, INFO, WARN, ERROR
LOG_FORMAT	-	TEXT	TEXT, JSONL

Running

Java

# Example 1: BITAXE
export MINER_ID=miner01
export MINER_TYPE=BITAXE
export MINER_URI=http://10.10.10.1

java -Xms128m -Xms256m -server -jar miner-exporter.jar

# Example 2: AVALON
export MINER_ID=miner02
export MINER_TYPE=AVALON
export MINER_URI=tcp://10.10.10.2:4028

java -Xms128m -Xms256m -server -jar miner-exporter.jar

# Example 3: ANTMINER
export MINER_ID=miner03
export MINER_TYPE=ANTMINER
export MINER_URI=http://10.10.10.3
export MINER_AUTH=DIGEST
export MINER_USERNAME=username
export MINER_PASSWORD=password

java -Xms128m -Xms256m -server -jar miner-exporter.jar

Systemd (JAR)

[Unit]
Description=Prometheus Miner Exporter
Documentation=https://github.com/tarmolehtpuu/miner-exporter

[Service]
Type=simple
Restart=on-failure
User=prometheus
Group=prometheus
EnvironmentFile=/etc/default/miner-exporter-miner01
SuccessExitStatus=143
ExecStart=/usr/bin/java -Xms128m -Xmx256m -server \
    -jar /opt/miner-exporter/miner-exporter.jar
ExecStop=/bin/kill -15 $MAINPID
StandardOutput=append:/var/log/prometheus/miner01.log
StandardError=append:/var/log/prometheus/miner01.log
TimeoutStopSec=20s
SendSIGKILL=no

[Install]
WantedBy=multi-user.target

Systemd (Native)

[Unit]
Description=Prometheus Miner Exporter
Documentation=https://github.com/tarmolehtpuu/miner-exporter

[Service]
Type=simple
Restart=on-failure
User=prometheus
Group=prometheus
EnvironmentFile=/etc/default/miner-exporter-miner02
ExecStart=/usr/local/bin/miner-exporter
StandardOutput=append:/var/log/prometheus/miner02.log
StandardError=append:/var/log/prometheus/miner02.log
TimeoutStopSec=20s
SendSIGKILL=no

[Install]
WantedBy=multi-user.target

Docker

Docker images are published for the following os/arch combinations:

• linux/amd64
• linux/arm64

# Example 1: BITAXE
docker run \
  -p 8080:8080 \
  -e MINER_ID=miner01 \
  -e MINER_TYPE=BITAXE \
  -e MINER_URI=http://10.10.10.1 \
  ghcr.io/tarmolehtpuu/miner-exporter:0.1.9

# Example 2: AVALON
docker run \
  -p 8080:8080 \
  -e MINER_ID=miner02 \
  -e MINER_TYPE=AVALON \
  -e MINER_URI=tcp://10.10.10.2:4028 \
  ghcr.io/tarmolehtpuu/miner-exporter:0.1.9

# Example 3: ANTMINER
docker run \
  -p 8080:8080 \
  -e MINER_ID=miner03 \
  -e MINER_TYPE=ANTMINER \
  -e MINER_URI=http://10.10.10.3 \
  -e MINER_AUTH=DIGEST \
  -e MINER_USERNAME=username \
  -e MINER_PASSWORD=password \
  ghcr.io/tarmolehtpuu/miner-exporter:0.1.9

Prometheus

Add one static config for all the miner-exporters. If running all of them on localhost then run them on separate ports so configuring Prometheus is less of a hassle.

- job_name: miner-exporter
  static_configs:
    - targets:
        - localhost:9041
        - localhost:9042
        - localhost:9043
        - localhost:9044
        - ...