nhatfield/hnt_monitor

By nhatfield

•Updated over 4 years ago

HNT Miner Metric Collector

Image

5.6K

Overview Tags

nhatfield/hnt_monitor repository overview

⁠HNT Miner Monitor

(https://github.com/nhatfield/hnt_monitor⁠)

⁠Overview

This repo is used to produce metrics from miner api's and the Helium blockchain. We can use the metrics to diagnose, alert, and prevent poor mining performance. Currently we extract the following metrics:

Hotspot API

activity
block height
reward counts (15 minute, 1 hour, 1 day, 7 days, 30 days)
reward scale
witnessed
witnesses

Bobcat API

block height
cpu temperatures
miner height
height gap
sync status

LongAP

block height
height gap
miner connected
miner height
online status
sync status

Nebra

block height
bluetooth connected
frequency
height gap
lora status
miner connected
miner height
relayed
sync percent
sync status

Sensecap API

antenna gain
block height
cpu temperature
cpu used
dialable
height gap
is healthy
memory total
memory used
nat type
miner connected
miner height
relayed
sd total
sd used
sync status

⁠PreReq's

docker⁠

⁠Quick Start

Run the hnt monitor script standalone

$> docker build -t hnt_monitor -f build/docker/Dockerfile .
$> docker run --rm -it hnt_monitor help     # help menu
$> docker run -d -e HNT_HOTSPOT_MONITOR=true -e HNT_HOTSPOT_ADDRESSES="12345..." -e HNT_PROMETHEUS_PG_HOST=my.prometheus-pushgateway.host hnt_monitor  # Enable hotspot monitoring from helium api

Help Menu

$> docker run -it --rm hnt_monitor help

⁠Variables

Name	Default	Description	Required
`HNT_BLOCKS_URL`	`api.helium.io/v1/blocks`	The helium blocks api url.	`no`
`HNT_BOBCAT_IPS`		If bobcat monitoring enabled, list of ips. Ex: '192.x.x.2 192.x.x.3 192.x.x.etc'	`no`
`HNT_BOBCAT_MONITOR`	`false`	Enable or disable bobcat monitoring. Boolean: `(true or false)`	`no`
`HNT_DEBUG`	`false`	Turn on debug logging. Boolean: `(true or false)`	`no`
`HNT_HELIUM_MONITOR`	`true`	Enable or disable helium monitoring. Boolean: `(true or false)`	`no`
`HNT_HOTSPOT_ADDRESSES`		Hotspot miner addresses to get metrics from. Ex: 'address1 address2 address3 etc'	`no`
`HNT_HOTSPOT_MONITOR`	`false`	Enable hotspot monitoring from helium api. Boolean: `(true or false)`	`no`
`HNT_HOTSPOT_URL`	`api.helium.io/v1/hotspots`	The helium hotspot api url.	`no`
`HNT_LOGFILE`	`stdout`	Send logs to this file	`no`
`HNT_LOGPATH`	`/dev/`	Send logs to this path	`no`
`HNT_LONGAP_ADDRESSES`		If longap monitoring enabled, list of ips. Ex: 'address1 address2 address3'	`no`
`HNT_LONGAP_MONITOR`	`false`	Enable or disable bobcat monitoring. Boolean: `(true or false)`	`no`
`HNT_NEBRA_IPS`		If nebra monitoring enabled, list of ips. Ex: '192.x.x.2 192.x.x.3 192.x.x.etc'	`no`
`HNT_NEBRA_MONITOR`	`false`	Enable or disable nebra monitoring. Boolean: `(true or false)`	`no`
`HNT_PROJECT`	`hnt_monitor`	The name of the metric prefix when sending to prometheus.	`no`
`HNT_PROMETHEUS_PG_HOST`	`localhost`	The prometheus push gateway hostname.	`yes`
`HNT_PROMETHEUS_PG_PORT`	`9091`	The prometheus push gateway port.	`no`
`HNT_SENSECAP_API_KEY`		Api key for sensecap	`no`
`HNT_SENSECAP_MONITOR`	`false`	Enable or disable sensecap monitoring. Boolean: `(true or false)`	`no`
`HNT_SENSECAP_SERIAL_NUMBERS`		If sensecap monitoring enabled, list of Serial numbers of the sensecap miners	`no`
`HNT_TRACE`	`false`	Turn on trace logging. Produces more logs than debug. Boolean: `(true or false)`	`no`

⁠Tips & Donations

Always welcomed, never required =)

HNT: 13Vazr2mTQSbu2wBGAkqpaLvJQEdSv5aMd3qpdXFJSw2pfNpqC4

Tag summary

Recent tags

Content type

Image

Digest

Size

325.8 MB

Last updated

over 4 years ago

docker pull nhatfield/hnt_monitor