nut_influx_connector

Ship energy usage data and other UPS stats from Network-UPS-Tools to InfluxDB.

The following fields are written to an InfluxDB measurement on a periodic basis:

watts
load_percent
battery_charge_percent
battery_charge_low_percent
battery_runtime_s
battery_voltage
battery_voltage_nominal
input_voltage
input_voltage_nominal
output_voltage

Usage

The following syntax will run openweather-influxdb-connector, and the program will keep running until it's killed.

nut_influx_connector \
    -influx-bucket "nut/autogen" \
    -influx-server http://192.168.1.4:8086 \
    -ups deskups \
    -ups-nametag "work_desk" \
    [OPTIONS ...]

Options

-heartbeat-url string: URL to GET every 60s, URL to GET every 60s, if and only if the program has successfully sent NUT statistics to Influx in the past 120s.

-influx-bucket string: InfluxDB bucket. Supply a string in the form database/retention-policy. For the default retention policy, pass just a database name (without the slash character). Required.
-influx-password string: InfluxDB password.
-influx-server string: InfluxDB server, including protocol and port, e.g. http://192.168.1.4:8086. Required.
-influx-timeout int: Timeout for writing to InfluxDB, in seconds. (default 3)
-influx-username string: InfluxDB username.
-measurement-name string: InfluxDB measurement name. (default ups_stats)
-poll-interval int: Polling interval, in seconds. (default 30)
-print-usage: Log energy usage (in watts) to standard error.
-ups string: UPS to read status from, format upsname[@hostname[:port]]. Required.
-ups-nametag string: Value for the ups_name tag in InfluxDB. Required.
-help: Print help and exit.
-version: Print version and exit.

Installation

Debian via Apt repository

Install my Debian repository if you haven't already:

sudo apt install ca-certificates curl gnupg
sudo install -m 0755 -d /etc/apt/keyrings
curl -fsSL https://dist.cdzombak.net/deb.key | sudo gpg --dearmor -o /etc/apt/keyrings/dist-cdzombak-net.gpg
sudo chmod 0644 /etc/apt/keyrings/dist-cdzombak-net.gpg
echo -e "deb [signed-by=/etc/apt/keyrings/dist-cdzombak-net.gpg] https://dist.cdzombak.net/deb/oss any oss\n" | sudo tee -a /etc/apt/sources.list.d/dist-cdzombak-net.list > /dev/null
sudo apt update

Then install nut_influx_connector via apt:

sudo apt install nut_influx_connector

macOS via Homebrew

brew install cdzombak/oss/nut_influx_connector

Manual installation from build artifacts

Pre-built binaries for Linux and macOS on various architectures are downloadable from each GitHub Release. Debian packages for each release are available as well.

Build and install locally

git clone https://github.com/cdzombak/nut_influx_connector.git
cd nut_influx_connector
make build

cp out/nut_influx_connector $INSTALL_DIR

Running on Linux with Systemd

After installing the binary, you can run it as a systemd service.

Optionally, create a user for the service to run as: sudo useradd -r -s /usr/sbin/nologin nut-influx-connector
Install the systemd service nut-influx-connector.service and customize that file as desired (e.g. with the correct CLI options for your deployment):

curl -sSL https://raw.githubusercontent.com/cdzombak/nut_influx_connector/main/nut-influx-connector.service | sudo tee /etc/systemd/system/nut-influx-connector.service
sudo nano /etc/systemd/system/nut-influx-connector.service

Enable and start the service:

sudo systemctl daemon-reload
sudo systemctl enable nut-influx-connector
sudo systemctl start nut-influx-connector

Verify its operation:

sudo systemctl status nut-influx-connector
sudo journalctl -f -u nut-influx-connector.service

Running on macOS with Launchd

Note This is untested; please open an issue if it doesn't work as expected.

After installing the binary via Homebrew, you can run it as a launchd service.

Install the launchd plist com.dzombak.nut-influx-connector.plist and customize that file as desired (e.g. with the correct CLI options for your deployment):

mkdir -p "$HOME"/Library/LaunchAgents
curl -sSL https://raw.githubusercontent.com/cdzombak/nut_influx_connector/main/com.dzombak.nut-influx-connector.plist > "$HOME"/Library/LaunchAgents/com.dzombak.nut-influx-connector.plist
nano "$HOME"/Library/LaunchAgents/com.dzombak.nut-influx-connector.plist

License

MIT; see LICENSE in this repository.

Author

Chris Dzombak (GitHub @cdzombak).

cdzombak / nut_influx_connector