Skip to content

mendelgusmao/bitaxe-telegraf-plugin

Repository files navigation

Downloads Build Coverage

About bitaxe-telegraf-plugin

This Telegraf input plugin gathers data from crypto miners running Bitaxe firmware.

Installation

To install the plugin you have to download a suitable release archive and extract it or build it from source by cloning the repository and issueing a simple

make

To build the plugin, Go version 1.23 or higher is required. The resulting plugin binary will be written to ./build/bin. Copy the either extracted or built plugin binary to a location of your choice (e.g. /usr/local/bin/telegraf/).

Configuration

This is an external plugin which has to be integrated via Telegraf's execd plugin.

To use it you have to create a plugin specific config file (e.g. /etc/telegraf/bitaxe.conf) with following template content:

[[inputs.bitaxe]]
  # devices is an array of the devices' hostnames or IP addresses 
  devices = ["192.168.1.1", "crypto-miner"]

  ## Amount of time allowed to complete the HTTP request
  # timeout = "5s"

The most important setting is the devices line. It defines the miners' IP addresses or hostnames to query. At least one address has to be defined.

To enable the plugin within your Telegraf instance, add the following section to your telegraf.conf

[[inputs.execd]]
  command = ["/usr/local/bin/telegraf/bitaxe-telegraf-plugin", "-config", "/etc/telegraf/bitaxe.conf", "-poll_interval", "60s"]
  signal = "none"

License

This project is subject to the the MIT License. See LICENSE information for details.

About

A Telegraf plugin to gather data from Bitaxe-compatible crypto miners

Resources

License

Stars

Watchers

Forks

Packages

No packages published