This class collects data from NUT, a UPS interface for linux.


  • nut/upsc to be installed, configured and running.


Setting Default Description Type
bin /bin/upsc The path to the upsc binary str
byte_unit byte Default numeric output(s) str
enabled False Enable collecting these metrics bool
measure_collector_time False Collect the collector run time in ms bool
metrics_blacklist None Regex to match metrics to block. Mutually exclusive with metrics_whitelist NoneType
metrics_whitelist None Regex to match metrics to transmit. Mutually exclusive with metrics_blacklist NoneType
sudo_cmd /usr/bin/sudo Path to sudo str
ups_name cyberpower The name of the ups to collect data for str
use_sudo False Use sudo? bool

Example Output 100.0 10.0 20.0 300.0 960.0 12.0 4.9 30.0 2.0 0.34 0.0 0.0 120.0 121.0 120.0 20.0 30.0 46.0 501.0 330.0 -60.0 0.0 764.0