| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-apcupsd |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: apcupsd |
| 7 | monitored_instance: |
| 8 | name: APC UPS |
| 9 | link: https://www.apc.com |
| 10 | icon_filename: apc.svg |
| 11 | categories: |
| 12 | - data-collection.hardware-and-sensors |
| 13 | keywords: |
| 14 | - ups |
| 15 | - apcupsd |
| 16 | - apc |
| 17 | related_resources: |
| 18 | integrations: |
| 19 | list: [] |
| 20 | info_provided_to_referring_integrations: |
| 21 | description: "" |
| 22 | overview: |
| 23 | data_collection: |
| 24 | metrics_description: | |
| 25 | This collector monitors Uninterruptible Power Supplies by polling the Apcupsd daemon. |
| 26 | method_description: "" |
| 27 | supported_platforms: |
| 28 | include: [] |
| 29 | exclude: [] |
| 30 | multi_instance: true |
| 31 | additional_permissions: |
| 32 | description: "" |
| 33 | default_behavior: |
| 34 | auto_detection: |
| 35 | description: | |
| 36 | By default, it detects Apcupsd instances running on localhost that are listening on port 3551. |
| 37 | On startup, it tries to collect metrics from: |
| 38 | |
| 39 | - 127.0.0.1:3551 |
| 40 | limits: |
| 41 | description: "" |
| 42 | performance_impact: |
| 43 | description: "" |
| 44 | setup: |
| 45 | prerequisites: |
| 46 | list: [] |
| 47 | configuration: |
| 48 | file: |
| 49 | name: go.d/apcupsd.conf |
| 50 | options: |
| 51 | description: | |
| 52 | The following options can be defined globally: update_every, autodetection_retry. |
| 53 | folding: |
| 54 | title: Config options |
| 55 | enabled: true |
| 56 | list: |
| 57 | - name: update_every |
| 58 | description: Data collection interval (seconds). |
| 59 | default_value: 1 |
| 60 | required: false |
| 61 | group: Collection |
| 62 | - name: autodetection_retry |
| 63 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 64 | default_value: 0 |
| 65 | required: false |
| 66 | group: Collection |
| 67 | |
| 68 | - name: address |
| 69 | description: apcupsd daemon address (`IP:PORT`). |
| 70 | default_value: 127.0.0.1:3551 |
| 71 | required: true |
| 72 | group: Target |
| 73 | - name: timeout |
| 74 | description: Connection, read, write, and name resolution timeout (seconds). |
| 75 | default_value: 2 |
| 76 | required: false |
| 77 | group: Target |
| 78 | |
| 79 | - name: vnode |
| 80 | description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). |
| 81 | default_value: "" |
| 82 | required: false |
| 83 | group: Virtual Node |
| 84 | examples: |
| 85 | folding: |
| 86 | title: Config |
| 87 | enabled: true |
| 88 | list: |
| 89 | - name: Basic |
| 90 | description: A basic example configuration. |
| 91 | config: | |
| 92 | jobs: |
| 93 | - name: local |
| 94 | address: 127.0.0.1:3551 |
| 95 | - name: Multi-instance |
| 96 | description: | |
| 97 | > **Note**: When you define multiple jobs, their names must be unique. |
| 98 | |
| 99 | Collecting metrics from local and remote instances. |
| 100 | config: | |
| 101 | jobs: |
| 102 | - name: local |
| 103 | address: 127.0.0.1:3551 |
| 104 | |
| 105 | - name: remote |
| 106 | address: 203.0.113.0:3551 |
| 107 | troubleshooting: |
| 108 | problems: |
| 109 | list: [] |
| 110 | alerts: |
| 111 | - name: apcupsd_ups_load_capacity |
| 112 | metric: apcupsd.ups_load_capacity_utilization |
| 113 | info: "APC UPS average load over the last 10 minutes" |
| 114 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/apcupsd.conf |
| 115 | - name: apcupsd_ups_battery_charge |
| 116 | metric: apcupsd.ups_battery_charge |
| 117 | info: "APC UPS average battery charge over the last minute" |
| 118 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/apcupsd.conf |
| 119 | - name: apcupsd_last_collected_secs |
| 120 | metric: apcupsd.ups_status |
| 121 | info: "APC UPS number of seconds since the last successful data collection" |
| 122 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/apcupsd.conf |
| 123 | - name: apcupsd_ups_selftest_warning |
| 124 | metric: apcupsd.ups_selftest |
| 125 | info: "APC UPS self-test failed due to insufficient battery capacity or due to overload" |
| 126 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/apcupsd.conf |
| 127 | - name: apcupsd_ups_status_onbatt |
| 128 | metric: apcupsd.ups_status |
| 129 | info: "APC UPS has switched to battery power because the input power has failed" |
| 130 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/apcupsd.conf |
| 131 | - name: apcupsd_ups_status_overload |
| 132 | metric: apcupsd.ups_status |
| 133 | info: "APC UPS is overloaded and cannot supply enough power to the load" |
| 134 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/apcupsd.conf |
| 135 | - name: apcupsd_ups_status_lowbatt |
| 136 | metric: apcupsd.ups_status |
| 137 | info: "APC UPS battery is low and needs to be recharged" |
| 138 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/apcupsd.conf |
| 139 | - name: apcupsd_ups_status_replacebatt |
| 140 | metric: apcupsd.ups_status |
| 141 | info: "APC UPS battery has reached the end of its lifespan and needs to be replaced" |
| 142 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/apcupsd.conf |
| 143 | - name: apcupsd_ups_status_nobatt |
| 144 | metric: apcupsd.ups_status |
| 145 | info: "APC UPS has no battery" |
| 146 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/apcupsd.conf |
| 147 | - name: apcupsd_ups_status_commlost |
| 148 | metric: apcupsd.ups_status |
| 149 | info: "APC UPS communication link is lost" |
| 150 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/apcupsd.conf |
| 151 | metrics: |
| 152 | folding: |
| 153 | title: Metrics |
| 154 | enabled: false |
| 155 | description: "" |
| 156 | availability: [] |
| 157 | scopes: |
| 158 | - name: ups |
| 159 | description: These metrics refer to the UPS unit. |
| 160 | labels: [] |
| 161 | metrics: |
| 162 | - name: apcupsd.ups_status |
| 163 | description: UPS Status |
| 164 | unit: status |
| 165 | chart_type: line |
| 166 | dimensions: |
| 167 | - name: TRIM |
| 168 | - name: BOOST |
| 169 | - name: CAL |
| 170 | - name: ONLINE |
| 171 | - name: ONBATT |
| 172 | - name: OVERLOAD |
| 173 | - name: LOWBATT |
| 174 | - name: REPLACEBATT |
| 175 | - name: NOBATT |
| 176 | - name: SLAVE |
| 177 | - name: SLAVEDOWN |
| 178 | - name: COMMLOST |
| 179 | - name: SHUTTING_DOWN |
| 180 | - name: apcupsd.ups_selftest |
| 181 | description: UPS Self-Test Status |
| 182 | unit: status |
| 183 | chart_type: line |
| 184 | dimensions: |
| 185 | - name: NO |
| 186 | - name: NG |
| 187 | - name: WN |
| 188 | - name: IP |
| 189 | - name: OK |
| 190 | - name: BT |
| 191 | - name: UNK |
| 192 | - name: apcupsd.ups_battery_charge |
| 193 | description: UPS Battery Charge |
| 194 | unit: percent |
| 195 | chart_type: area |
| 196 | dimensions: |
| 197 | - name: charge |
| 198 | - name: apcupsd.ups_battery_time_remaining |
| 199 | description: UPS Estimated Runtime on Battery |
| 200 | unit: seconds |
| 201 | chart_type: line |
| 202 | dimensions: |
| 203 | - name: timeleft |
| 204 | - name: apcupsd.ups_battery_time_since_replacement |
| 205 | description: UPS Time Since Battery Replacement |
| 206 | unit: seconds |
| 207 | chart_type: line |
| 208 | dimensions: |
| 209 | - name: since_replacement |
| 210 | - name: apcupsd.ups_battery_voltage |
| 211 | description: UPS Battery Voltage |
| 212 | unit: Volts |
| 213 | chart_type: line |
| 214 | dimensions: |
| 215 | - name: voltage |
| 216 | - name: nominal_voltage |
| 217 | - name: apcupsd.ups_load_capacity_utilization |
| 218 | description: UPS Load Capacity Utilization |
| 219 | unit: percent |
| 220 | chart_type: area |
| 221 | dimensions: |
| 222 | - name: load |
| 223 | - name: apcupsd.ups_load |
| 224 | description: UPS Load |
| 225 | unit: Watts |
| 226 | chart_type: line |
| 227 | dimensions: |
| 228 | - name: load |
| 229 | - name: apcupsd.ups_temperature |
| 230 | description: UPS Internal Temperature |
| 231 | unit: Celsius |
| 232 | chart_type: line |
| 233 | dimensions: |
| 234 | - name: temperature |
| 235 | - name: apcupsd.ups_input_voltage |
| 236 | description: UPS Input Voltage |
| 237 | unit: Volts |
| 238 | chart_type: line |
| 239 | dimensions: |
| 240 | - name: voltage |
| 241 | - name: min_voltage |
| 242 | - name: max_voltage |
| 243 | - name: apcupsd.ups_input_frequency |
| 244 | description: UPS Input Frequency |
| 245 | unit: Hz |
| 246 | chart_type: line |
| 247 | dimensions: |
| 248 | - name: frequency |
| 249 | - name: apcupsd.ups_output_voltage |
| 250 | description: UPS Output Voltage |
| 251 | unit: Volts |
| 252 | chart_type: line |
| 253 | dimensions: |
| 254 | - name: voltage |