APC UPS

Plugin: go.d.plugin Module: snmp

Overview

Monitor APC UPS (ups) with Netdata over SNMP. Netdata recognizes the device automatically by its sysObjectID (recognized across 15 device identifiers) and collects the metrics this profile declares — on top of the generic SNMP baseline — with no manual OID configuration.

Netdata's SNMP collector matches the device to the apc-ups.yaml profile via sysObjectID/sysDescr, then polls the OIDs it declares.

This integration is supported on all platforms.

This integration supports multiple instances configured side-by-side.

Default Behavior

Auto-Detection

Auto-detected as APC UPS via sysObjectID/sysDescr.

Limits

The default configuration for this integration does not impose any limits.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Setup

You can configure the snmp collector in two ways:

Method	Best for	How to
UI	Fast setup without editing files	Go to Nodes → Configure this node → Collectors → Jobs, search for snmp, then click + to add a job.
File	If you prefer configuring via file, or need to automate deployments (e.g., with Ansible)	Edit go.d/snmp.conf and add a job.

important

UI configuration requires paid Netdata Cloud plan.

Prerequisites

SNMP access

SNMP must be enabled on the device and reachable from the Netdata Agent acting as the site's SNMP hub.

Configuration

Options

Configure the SNMP collector with the device hostname and SNMP credentials. See the SNMP collector reference for all options.

via UI

Configure the snmp collector from the Netdata web interface:

1. Go to Nodes.
2. Select the node where you want the snmp data-collection job to run and click the ⚙ (Configure this node). That node will run the data collection.
3. The Collectors → Jobs view opens by default.
4. In the Search box, type snmp (or scroll the list) to locate the snmp collector.
5. Click the + next to the snmp collector to add a new job.
6. Fill in the job fields, then click Test to verify the configuration and Submit to save.
   • Test runs the job with the provided settings and shows whether data can be collected.
   • If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.

via File

The configuration file name for this integration is go.d/snmp.conf.

The file format is YAML. Generally, the structure is:

update_every: 1
autodetection_retry: 0
jobs:
  - name: some_name1
  - name: some_name2

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/snmp.conf

Examples

There are no configuration examples.

Alerts

There are no alerts configured by default for this integration.

Metrics

On top of the generic SNMP baseline (the Generic SNMP Device integration — interfaces, system, IP/TCP/UDP, host resources), this APC UPS profile adds the metrics below. Each is collected only where the device exposes the matching OID — inclusion means the profile requests it; availability depends on the device model and software.

43 metrics in 10 groups; each row is a chart context usable in alerts.

Group	Metrics
Hardware / Battery	5
Hardware / OutletGroup	1
Hardware / Sensor	1
Network / TCP	12
Network / UDP	6
PowerFlow / Input	5
PowerFlow / Output	8
System / Battery	3
System / Test	1
System / Uptime	1

Hardware / Battery

Metric (chart context)	Unit	Scope	Description
snmp.device_prof_upsAdvBatteryNumOfBadBattPacks	{pack}	device	The number of external battery packs connected to the UPS that are defective
snmp.device_prof_upsAdvBatteryNumOfBattPacks	{pack}	device	The number of external battery packs connected to the UPS
snmp.device_prof_upsAdvBatteryReplaceIndicator	{status}	device	Indicates whether the UPS batteries need replacing
snmp.device_prof_upsAdvBatteryTemperature	Cel	device	The current internal UPS temperature
snmp.device_prof_upsHighPrecExtdBatteryTemperature	Cel	device	The current internal UPS temperature

Hardware / OutletGroup

Metric (chart context)	Unit	Scope	Description
snmp.device_prof_upsOutletGroupStatusGroupState	{status}	per outlet_group_name	Outlet group state

Hardware / Sensor

Metric (chart context)	Unit	Scope	Description
snmp.device_prof_uioSensorStatusTemperatureDegC	Cel	device	The sensor's current temperature reading

Network / TCP

Metric (chart context)	Unit	Scope	Description
snmp.device_prof_tcpActiveOpens	{transition}/s	device	TCP connections transitioning from CLOSED to SYN-SENT
snmp.device_prof_tcpAttemptFails	{failure}/s	device	Failed TCP connection attempts
snmp.device_prof_tcpCurrEstab	{connection}	device	Current TCP connections in ESTABLISHED or CLOSE-WAIT state
snmp.device_prof_tcpEstabResets	{reset}/s	device	TCP connections reset from ESTABLISHED/CLOSE-WAIT
snmp.device_prof_tcpHCInSegs	{packet}/s	device	TCP segments received
snmp.device_prof_tcpHCOutSegs	{packet}/s	device	TCP segments sent
snmp.device_prof_tcpInErrs	{error}/s	device	TCP segments received with errors
snmp.device_prof_tcpInSegs	{packet}/s	device	TCP segments received
snmp.device_prof_tcpOutRsts	{reset}/s	device	TCP segments sent with RST flag
snmp.device_prof_tcpOutSegs	{packet}/s	device	TCP segments sent
snmp.device_prof_tcpPassiveOpens	{transition}/s	device	TCP connections transitioning from LISTEN to SYN-RCVD
snmp.device_prof_tcpRetransSegs	{retransmit}/s	device	TCP segments retransmitted

Network / UDP

Metric (chart context)	Unit	Scope	Description
snmp.device_prof_udpHCInDatagrams	{packet}/s	device	UDP datagrams received
snmp.device_prof_udpHCOutDatagrams	{packet}/s	device	UDP datagrams sent
snmp.device_prof_udpInDatagrams	{packet}/s	device	UDP datagrams received
snmp.device_prof_udpInErrors	{error}/s	device	UDP datagrams received but couldn't be delivered (not due to missing app)
snmp.device_prof_udpNoPorts	{error}/s	device	UDP datagrams received with no app on the destination port
snmp.device_prof_udpOutDatagrams	{packet}/s	device	UDP datagrams sent

PowerFlow / Input

Metric (chart context)	Unit	Scope	Description
snmp.device_prof_upsAdvInputFrequency	Hz	device	The current input frequency to the UPS system
snmp.device_prof_upsAdvInputLineFailCause	{status}	device	The reason for the occurrence of the last transfer to UPS battery power
snmp.device_prof_upsAdvInputLineVoltage	V	device	The current utility line voltage (AC)
snmp.device_prof_upsHighPrecInputFrequency	Hz	device	The current input frequency to the UPS system
snmp.device_prof_upsHighPrecInputLineVoltage	V	device	The current utility line voltage (AC)

PowerFlow / Output

Metric (chart context)	Unit	Scope	Description
snmp.device_prof_upsAdvOutputActivePower	W	device	The total output active power of the UPS system
snmp.device_prof_upsAdvOutputApparentPower	VA	device	The total output apparent power of all phases of the UPS system
snmp.device_prof_upsAdvOutputCurrent	A	device	The current drawn by the load on the UPS
snmp.device_prof_upsAdvOutputEnergyUsage	kWh	device	The output energy usage of the UPS
snmp.device_prof_upsAdvOutputFrequency	Hz	device	The current output frequency of the UPS system
snmp.device_prof_upsAdvOutputLoad	%	device	The current UPS load expressed in percent of rated capacity
snmp.device_prof_upsAdvOutputVoltage	V	device	The output voltage of the UPS system (AC)
snmp.device_prof_upsHighPrecOutputCurrent	A	device	The current drawn by the load on the UPS

System / Battery

Metric (chart context)	Unit	Scope	Description
snmp.device_prof_upsAdvBatteryCapacity	%	device	The remaining battery capacity
snmp.device_prof_upsAdvBatteryRunTimeRemaining	s	device	The UPS battery run time remaining before battery exhaustion
snmp.device_prof_upsBasicBatteryTimeOnBattery	s	device	The elapsed time since the UPS has switched to battery power

System / Test

Metric (chart context)	Unit	Scope	Description
snmp.device_prof_upsAdvTestDiagnosticsResults	{status}	device	The results of the last UPS diagnostics test performed

System / Uptime

Metric (chart context)	Unit	Scope	Description
snmp.device_prof_systemUptime	s	device	Time since the system was last rebooted or powered on.