All apps · 0 apps

nut-influxdbv2-exporter

Overview

Docker wrapper for a Python script to query NUT - Network UPS Tools via a Python script and then send the results to InfluxDBv2 for storage.

Readme

View on GitHub

nut-influxdbv2

Docker image to pulls data from a NUT server and push it to an InfluxDB bucket. Based on work of mihai-cindea and dbsqp.

Docker Image

The docker image is available on https://hub.docker.com/r/jwillmer/nut-influxdbv2

Environment variables with default values

Only setting INFLUXDB2_TOKEN is required if the default values are sufficient and your UPS outputs ups.realpower.nominal.

Variable Name	Default Value	Required	Note
INFLUXDB2_HOST	localhost
INFLUXDB2_PORT	8086
INFLUXDB2_ORG	Home
INFLUXDB2_TOKEN		true
INFLUXDB2_BUCKET	DEV
INFLUXDB2_SSL	false		Default assumes HTTP connection
INFLUXDB2_SSL_VERIFY	false		Default will validate HTTPS certificates and throw an error if invalid
INFLUXDB2_MEASUREMENT	ups_status		Measurment name in InfluxDB


NUT_HOST	127.0.0.1
NUT_PORT	3493
NUT_PASSWORD
NUT_USERNAME
WATTS		true	Only required if UPS does not output ups.realpower.nominal
UPS_NAME	UPS		Defined name of the UPS in NUT
INTERVAL	21		How often the UPS gets queried in seconds

Source Code

The source code is available on https://github.com/jwillmer/nut-influxdbv2

Unraid

This image is referenced in the Unraid community store. The support thread can be found at forums.unraid.net/topic/130458-support-nut-influxdbv2-exporter and the template for the image can be found in the template repository. Regular users don't have to care about the template, the reference is only interesting to developers.

Grafana

A good dashboard for the collected data can be found with the dashboard id 7233. grafana dasboard 7233

Install nut-influxdbv2-exporter on Unraid in a few clicks.

Find nut-influxdbv2-exporter in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.

Open the Apps tab on your Unraid server Search Community Apps for nut-influxdbv2-exporter Review the template variables and paths Click Install

Explore Unraid OS

Related apps

Explore more like this

Explore all

Utilities apps

Links

Projectgithub.com Supportforums.unraid.net Docker Hubhub.docker.com Templateraw.githubusercontent.com

Details

Repository

jwillmer/nut-influxdbv2

Registry

https://hub.docker.com/r/jwillmer/nut-influxdbv2

Last Updated2023-04-27

First Seen2022-11-04

Runtime arguments

Network: bridge
Shell: sh
Privileged: false

Template configuration

INFLUXDB2_HOSTVariable

IP address of influxdb

Default: localhost

INFLUXDB2_PORTVariable

Default: 8086

INFLUXDB2_ORGVariable

The organization name

Default: Home

INFLUXDB2_TOKENVariable

INFLUXDB2_BUCKETVariable

The bucket name

INFLUXDB2_MEASUREMENTVariable

Measurment name that is used in InfluxDB

Default: ups_status

INFLUXDB2_SSLVariable

Default: false

INFLUXDB2_SSL_VERIFYVariable

Default: false

NUT_HOSTVariable

Default: 127.0.0.1

NUT_PORTVariable

Default: 3493

NUT_PASSWORDVariable

Password for NUT

NUT_USERNAMEVariable

Username for NUT

WATTSVariable

If your UPS doesn't have the nominal power metric (ups.realpower.nominal) then specify the rated watts so that the load percentage can be used to calculate the current watts

INTERVALVariable

Interval of NUT query

Default: 21

UPS_NAMEVariable

UPS name that is queried by the NUT client

Default: unraid

VERBOSEVariable

Verbose logging

Default: false

Library

Curated

Categories