Project: Netdata (Observability and Analysis / Observability)
File: ups_nut.md

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/upsd/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/collectors/go.d.plugin/modules/upsd/metadata.yaml" sidebar_label: "UPS (NUT)" learn_status: "Published" learnrelpath: "Collecting Metrics/UPS" most_popular: False message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE" endmeta--> <img src="https://netdata.cloud/img/plug-circle-bolt.svg" width="150"/> Plugin: go.d.plugin Module: upsd <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> 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. This integration doesn't support auto-detection. The default configuration for this integration does not impose any limits on data collection. The default configuration for this integration is not expected to impose a significant performance impact on the system. Metrics grouped by scope. The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels. 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.upsloadusage | load_usage | Watts | | upsd.upsstatus | online, onbattery, lowbattery, highbattery, replacebattery, charging, discharging, bypass, calibration, offline, overloaded, triminputvoltage, boostinputvoltage, forced_shutdown, other | status | | upsd.ups_temperature | temperature | Celsius | | upsd.upsbatterycharge | charge | percentage | | upsd.upsbatteryestimated_runtime | runtime | seconds | | upsd.upsbatteryvoltage | voltage | Volts | | upsd.upsbatteryvoltagenominal | nominalvoltage | Volts | | upsd.upsinputvoltage | voltage | Volts | | upsd.upsinputvoltagenominal | nominalvoltage | Volts | | upsd.upsinputcurrent | current | Ampere | | upsd.upsinputcurrentnominal | nominalcurrent | Ampere | | upsd.upsinputfrequency | frequency | Hz | | upsd.upsinputfrequencynominal | nominalfrequency | Hz | | upsd.upsoutputvoltage | voltage | Volts | |

| nominalvoltage | Volts | | upsd.upsoutputcurrent | current | Ampere | | upsd.upsoutputcurrentnominal | nominalcurrent | Ampere | | upsd.upsoutputfrequency | frequency | Hz | | upsd.upsoutputfrequencynominal | nominalfrequency | Hz | The following alerts are available: | Alert name | On metric | Description | |:|:-|:| | | upsd.upsload | UPS ${label:upsname} average load over the last 10 minutes | | | upsd.upsbatterycharge | UPS ${label:ups_name} average battery charge over the last minute | | | upsd.upsload | UPS ${label:upsname} number of seconds since the last successful data collection | No action required. 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 . ```bash cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata sudo ./edit-config go.d/upsd.conf ``` The following options can be defined globally: updateevery, autodetectionretry. <details><summary>Config options</summary> | 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 | </details> A basic example configuration. <details><summary>Config</summary> ```yaml jobs: name: local address: 127.0.0.1:3493 ``` </details> Note: When you define multiple jobs, their names must be unique. Collecting metrics from local and remote instances. <details><summary>Config</summary> ```yaml jobs: name: local address: 127.0.0.1:3493 name: remote address: 203.0.113.0:3493 ``` </details> 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.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. ```bash cd /usr/libexec/netdata/plugins.d/ ``` Switch to the `netdata` user. ```bash sudo -u netdata -s ``` Run the `go.d.plugin` to debug the collector: ```bash ./go.d.plugin -d -m upsd ```