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

<!--startmeta customediturl: "https://github.com/netdata/netdata/edit/master/src/collectors/charts.d.plugin/apcupsd/README.md" meta_yaml: "https://github.com/netdata/netdata/edit/master/src/collectors/charts.d.plugin/apcupsd/metadata.yaml" sidebar_label: "APC UPS" 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/apc.svg" width="150"/> Plugin: charts.d.plugin Module: apcupsd <img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" /> Monitor APC UPS performance with Netdata for optimal uninterruptible power supply operations. Enhance your power supply reliability with real-time APC UPS metrics. The collector uses the `apcaccess` tool to contact the `apcupsd` daemon and get the APC UPS statistics. This collector is supported on all platforms. This collector only supports collecting metrics from a single instance of this integration. By default, with no configuration provided, the collector will try to contact 127.0.0.1:3551 with using the `apcaccess` utility. 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. Metrics related to UPS. Each UPS provides its own set of the following metrics. This scope has no labels. Metrics: | Metric | Dimensions | Unit | |:|:-|:-| | apcupsd.charge | charge | percentage | | apcupsd.battery.voltage | voltage, nominal | Volts | | apcupsd.input.voltage | voltage, min, max | Volts | | apcupsd.output.voltage | absolute, nominal | Volts | | apcupsd.input.frequency | frequency | Hz | | apcupsd.load | load | percentage | | apcupsd.load_usage | load | Watts | | apcupsd.temperature | temp | Celsius | | apcupsd.time | time | Minutes | | apcupsd.online | online | boolean | | apcupsd.selftest | OK, NO, BT, NG | status | | apcupsd.status | ONLINE, ONBATT, OVERLOAD, LOWBATT, REPLACEBATT, NOBATT, SLAVE, SLAVEDOWN, COMMLOST, CAL, TRIM, BOOST, SHUTTING_DOWN | status | The following alerts are available: | Alert name | On metric | Description | |:|:-|:| | | apcupsd.charge | average UPS charge over the last minute | | | apcupsd.load | average UPS load over the last 10 minutes | | | apcupsd.load | number of seconds since the last successful data collection | | | apcupsd.selftest | self-test failed due to insufficient battery capacity or due to overload. | | |

| APC UPS has switched to battery power because the input power has failed | | | apcupsd.status | APC UPS is overloaded and cannot supply enough power to the load | | | apcupsd.status | APC UPS battery is low and needs to be recharged | | | apcupsd.status | APC UPS battery has reached the end of its lifespan and needs to be replaced | | | apcupsd.status | APC UPS has no battery | | | apcupsd.status | APC UPS communication link is lost | If , make sure `netdata-plugin-chartsd` is installed. Make sure the `apcaccess` and `apcupsd` are installed and running. The configuration file name for this integration is `charts.d/apcupsd.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 charts.d/apcupsd.conf ``` The config file is sourced by the charts.d plugin. It's a standard bash file. The following collapsed table contains all the options that can be configured for the apcupsd collector. <details><summary>Config options</summary> | Name | Description | Default | Required | |:-|:--|:-|:--:| | apcupsd_sources | This is an array of apcupsd sources. You can have multiple entries there. Please refer to the example below on how to set it. | 127.0.0.1:3551 | no | | apcupsd_timeout | How long to wait for apcupsd to respond. | 3 | no | | apcupsdupdateevery | The data collection frequency. If unset, will inherit the netdata update frequency. | 1 | no | | apcupsd_priority | The charts priority on the dashboard. | 90000 | no | | apcupsd_retries | The number of retries to do in case of failure before disabling the collector. | 10 | no | </details> Specify a multiple apcupsd sources along with a custom update interval ```yaml declare -A apcupsd_sources=( ["local"]="127.0.0.1:3551", ["remote"]="1.2.3.4:3551" ) apcupsdupdateevery=5 ``` To troubleshoot issues with the `apcupsd` collector, run the `charts.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 `charts.d.plugin` to debug the collector: ```bash ./charts.d.plugin debug 1 apcupsd ```