UPS (NUT)
UPS (NUT)
Plugin: go.d.plugin Module: upsd
Overview
This collector monitors Uninterruptible Power Supplies by polling the UPS daemon using the NUT network protocol.
This collector is supported on all platforms.
This collector supports collecting metrics from multiple instances of this integration, including remote instances.
Default Behavior
Auto-Detection
This integration doesn’t support auto-detection.
Limits
The default configuration for this integration does not impose any limits on data collection.
Performance Impact
The default configuration for this integration is not expected to impose a significant performance impact on the system.
Setup
Prerequisites
No action required.
Configuration
File
The configuration file name for this integration is go.d/upsd.conf.
You can edit the configuration file using the edit-config script from the
Netdata config directory.
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/upsd.conf
Options
The following options can be defined globally: update_every, autodetection_retry.
| Name | Description | Default | Required |
|---|---|---|---|
| update_every | Data collection frequency. | 1 | no |
| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
| address | UPS daemon address in IP:PORT format. | 127.0.0.1:3493 | yes |
| timeout | Connection/read/write timeout in seconds. The timeout includes name resolution, if required. | 2 | no |
Examples
Basic
A basic example configuration.
jobs:
- name: local
address: 127.0.0.1:3493
Multi-instance
Note: When you define multiple jobs, their names must be unique.
Collecting metrics from local and remote instances.
jobs:
- name: local
address: 127.0.0.1:3493
- name: remote
address: 203.0.113.0:3493
Metrics
Metrics grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
Per ups
These metrics refer to the UPS unit.
Labels:
| Label | Description |
|---|---|
| ups_name | UPS name. |
| battery_type | Battery type (chemistry). “battery.type” variable value. |
| device_model | Device model. “device.mode” variable value. |
| device_serial | Device serial number. “device.serial” variable value. |
| device_manufacturer | Device manufacturer. “device.mfr” variable value. |
| device_type | Device type (ups, pdu, scd, psu, ats). “device.type” variable value. |
Metrics:
| Metric | Dimensions | Unit |
|---|---|---|
| upsd.ups_load | load | percentage |
| upsd.ups_load_usage | load_usage | Watts |
| upsd.ups_status | on_line, on_battery, low_battery, high_battery, replace_battery, charging, discharging, bypass, calibration, offline, overloaded, trim_input_voltage, boost_input_voltage, forced_shutdown, other | status |
| upsd.ups_temperature | temperature | Celsius |
| upsd.ups_battery_charge | charge | percentage |
| upsd.ups_battery_estimated_runtime | runtime | seconds |
| upsd.ups_battery_voltage | voltage | Volts |
| upsd.ups_battery_voltage_nominal | nominal_voltage | Volts |
| upsd.ups_input_voltage | voltage | Volts |
| upsd.ups_input_voltage_nominal | nominal_voltage | Volts |
| upsd.ups_input_current | current | Ampere |
| upsd.ups_input_current_nominal | nominal_current | Ampere |
| upsd.ups_input_frequency | frequency | Hz |
| upsd.ups_input_frequency_nominal | nominal_frequency | Hz |
| upsd.ups_output_voltage | voltage | Volts |
| upsd.ups_output_voltage_nominal | nominal_voltage | Volts |
| upsd.ups_output_current | current | Ampere |
| upsd.ups_output_current_nominal | nominal_current | Ampere |
| upsd.ups_output_frequency | frequency | Hz |
| upsd.ups_output_frequency_nominal | nominal_frequency | Hz |
Alerts
The following alerts are available:
| Alert name | On metric | Description |
|---|---|---|
| upsd_10min_ups_load | upsd.ups_load | UPS ${label:ups_name} average load over the last 10 minutes |
| upsd_ups_battery_charge | upsd.ups_battery_charge | UPS ${label:ups_name} average battery charge over the last minute |
| upsd_ups_last_collected_secs | upsd.ups_load | UPS ${label:ups_name} number of seconds since the last successful data collection |
Troubleshooting
Debug Mode
To troubleshoot issues with the upsd collector, run the go.d.plugin with the debug option enabled. The output
should give you clues as to why the collector isn’t working.
-
Navigate to the
plugins.ddirectory, usually at/usr/libexec/netdata/plugins.d/. If that’s not the case on your system, opennetdata.confand look for thepluginssetting under[directories].cd /usr/libexec/netdata/plugins.d/ -
Switch to the
netdatauser.sudo -u netdata -s -
Run the
go.d.pluginto debug the collector:./go.d.plugin -d -m upsd
Getting Logs
If you’re encountering problems with the upsd collector, follow these steps to retrieve logs and identify potential issues:
- Run the command specific to your system (systemd, non-systemd, or Docker container).
- Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
System with systemd
Use the following command to view logs generated since the last Netdata service restart:
journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep upsd
System without systemd
Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector’s name:
grep upsd /var/log/netdata/collector.log
Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.
Docker Container
If your Netdata runs in a Docker container named “netdata” (replace if different), use this command:
docker logs netdata 2>&1 | grep upsd