| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-upsd |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: upsd |
| 7 | monitored_instance: |
| 8 | name: UPS (NUT) |
| 9 | link: "" |
| 10 | icon_filename: plug-circle-bolt.svg |
| 11 | categories: |
| 12 | - data-collection.hardware-and-sensors |
| 13 | keywords: |
| 14 | - ups |
| 15 | - nut |
| 16 | related_resources: |
| 17 | integrations: |
| 18 | list: [] |
| 19 | info_provided_to_referring_integrations: |
| 20 | description: "" |
| 21 | overview: |
| 22 | data_collection: |
| 23 | metrics_description: | |
| 24 | This collector monitors Uninterruptible Power Supplies by polling the UPS daemon using the NUT network protocol. |
| 25 | method_description: "" |
| 26 | supported_platforms: |
| 27 | include: [] |
| 28 | exclude: [] |
| 29 | multi_instance: true |
| 30 | additional_permissions: |
| 31 | description: "" |
| 32 | default_behavior: |
| 33 | auto_detection: |
| 34 | description: "" |
| 35 | limits: |
| 36 | description: "" |
| 37 | performance_impact: |
| 38 | description: "" |
| 39 | setup: |
| 40 | prerequisites: |
| 41 | list: [] |
| 42 | configuration: |
| 43 | file: |
| 44 | name: go.d/upsd.conf |
| 45 | options: |
| 46 | description: | |
| 47 | The following options can be defined globally: update_every, autodetection_retry. |
| 48 | folding: |
| 49 | title: Config options |
| 50 | enabled: true |
| 51 | list: |
| 52 | - name: update_every |
| 53 | description: Data collection frequency. |
| 54 | default_value: 1 |
| 55 | required: false |
| 56 | group: Collection |
| 57 | - name: autodetection_retry |
| 58 | description: Recheck interval in seconds. Zero means no recheck will be scheduled. |
| 59 | default_value: 0 |
| 60 | required: false |
| 61 | group: Collection |
| 62 | |
| 63 | - name: address |
| 64 | description: UPS daemon address in IP:PORT format. |
| 65 | default_value: 127.0.0.1:3493 |
| 66 | required: true |
| 67 | group: Target |
| 68 | - name: timeout |
| 69 | description: Connection/read/write timeout in seconds. The timeout includes name resolution, if required. |
| 70 | default_value: 2 |
| 71 | required: false |
| 72 | group: Target |
| 73 | |
| 74 | - name: username |
| 75 | description: Username for authentication. |
| 76 | default_value: "" |
| 77 | required: false |
| 78 | group: Auth |
| 79 | - name: password |
| 80 | description: Password for authentication. |
| 81 | default_value: "" |
| 82 | required: false |
| 83 | group: Auth |
| 84 | |
| 85 | - name: vnode |
| 86 | 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). |
| 87 | default_value: "" |
| 88 | required: false |
| 89 | group: Virtual Node |
| 90 | examples: |
| 91 | folding: |
| 92 | title: Config |
| 93 | enabled: true |
| 94 | list: |
| 95 | - name: Basic |
| 96 | description: A basic example configuration. |
| 97 | config: | |
| 98 | jobs: |
| 99 | - name: local |
| 100 | address: 127.0.0.1:3493 |
| 101 | - name: Multi-instance |
| 102 | description: | |
| 103 | > **Note**: When you define multiple jobs, their names must be unique. |
| 104 | |
| 105 | Collecting metrics from local and remote instances. |
| 106 | config: | |
| 107 | jobs: |
| 108 | - name: local |
| 109 | address: 127.0.0.1:3493 |
| 110 | |
| 111 | - name: remote |
| 112 | address: 203.0.113.0:3493 |
| 113 | troubleshooting: |
| 114 | problems: |
| 115 | list: [] |
| 116 | alerts: |
| 117 | - name: upsd_10min_ups_load |
| 118 | metric: upsd.ups_load |
| 119 | info: "UPS ${label:ups_name} average load over the last 10 minutes" |
| 120 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/upsd.conf |
| 121 | - name: upsd_ups_battery_charge |
| 122 | metric: upsd.ups_battery_charge |
| 123 | info: "UPS ${label:ups_name} average battery charge over the last minute" |
| 124 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/upsd.conf |
| 125 | - name: upsd_ups_last_collected_secs |
| 126 | metric: upsd.ups_load |
| 127 | info: "UPS ${label:ups_name} number of seconds since the last successful data collection" |
| 128 | link: https://github.com/netdata/netdata/blob/master/src/health/health.d/upsd.conf |
| 129 | metrics: |
| 130 | folding: |
| 131 | title: Metrics |
| 132 | enabled: false |
| 133 | description: "" |
| 134 | availability: [] |
| 135 | scopes: |
| 136 | - name: ups |
| 137 | description: These metrics refer to the UPS unit. |
| 138 | labels: |
| 139 | - name: ups_name |
| 140 | description: UPS name. |
| 141 | - name: battery_type |
| 142 | description: Battery type (chemistry). "battery.type" variable value. |
| 143 | - name: device_model |
| 144 | description: Device model. "device.mode" variable value. |
| 145 | - name: device_serial |
| 146 | description: Device serial number. "device.serial" variable value. |
| 147 | - name: device_manufacturer |
| 148 | description: Device manufacturer. "device.mfr" variable value. |
| 149 | - name: device_type |
| 150 | description: Device type (ups, pdu, scd, psu, ats). "device.type" variable value. |
| 151 | metrics: |
| 152 | - name: upsd.ups_load |
| 153 | description: UPS load |
| 154 | unit: percentage |
| 155 | chart_type: area |
| 156 | dimensions: |
| 157 | - name: load |
| 158 | - name: upsd.ups_load_usage |
| 159 | description: UPS load usage (power output) |
| 160 | unit: Watts |
| 161 | chart_type: line |
| 162 | dimensions: |
| 163 | - name: load_usage |
| 164 | - name: upsd.ups_status |
| 165 | description: UPS status |
| 166 | unit: status |
| 167 | chart_type: line |
| 168 | dimensions: |
| 169 | - name: on_line |
| 170 | - name: on_battery |
| 171 | - name: low_battery |
| 172 | - name: high_battery |
| 173 | - name: replace_battery |
| 174 | - name: charging |
| 175 | - name: discharging |
| 176 | - name: bypass |
| 177 | - name: calibration |
| 178 | - name: offline |
| 179 | - name: overloaded |
| 180 | - name: trim_input_voltage |
| 181 | - name: boost_input_voltage |
| 182 | - name: forced_shutdown |
| 183 | - name: other |
| 184 | - name: upsd.ups_temperature |
| 185 | description: UPS temperature |
| 186 | unit: Celsius |
| 187 | chart_type: line |
| 188 | dimensions: |
| 189 | - name: temperature |
| 190 | - name: upsd.ups_battery_charge |
| 191 | description: UPS Battery charge |
| 192 | unit: percentage |
| 193 | chart_type: area |
| 194 | dimensions: |
| 195 | - name: charge |
| 196 | - name: upsd.ups_battery_estimated_runtime |
| 197 | description: UPS Battery estimated runtime |
| 198 | unit: seconds |
| 199 | chart_type: line |
| 200 | dimensions: |
| 201 | - name: runtime |
| 202 | - name: upsd.ups_battery_voltage |
| 203 | description: UPS Battery voltage |
| 204 | unit: Volts |
| 205 | chart_type: line |
| 206 | dimensions: |
| 207 | - name: voltage |
| 208 | - name: upsd.ups_battery_voltage_nominal |
| 209 | description: UPS Battery voltage nominal |
| 210 | unit: Volts |
| 211 | chart_type: line |
| 212 | dimensions: |
| 213 | - name: nominal_voltage |
| 214 | - name: upsd.ups_input_voltage |
| 215 | description: UPS Input voltage |
| 216 | unit: Volts |
| 217 | chart_type: line |
| 218 | dimensions: |
| 219 | - name: voltage |
| 220 | - name: upsd.ups_input_voltage_nominal |
| 221 | description: UPS Input voltage nominal |
| 222 | unit: Volts |
| 223 | chart_type: line |
| 224 | dimensions: |
| 225 | - name: nominal_voltage |
| 226 | - name: upsd.ups_input_current |
| 227 | description: UPS Input current |
| 228 | unit: Ampere |
| 229 | chart_type: line |
| 230 | dimensions: |
| 231 | - name: current |
| 232 | - name: upsd.ups_input_current_nominal |
| 233 | description: UPS Input current nominal |
| 234 | unit: Ampere |
| 235 | chart_type: line |
| 236 | dimensions: |
| 237 | - name: nominal_current |
| 238 | - name: upsd.ups_input_frequency |
| 239 | description: UPS Input frequency |
| 240 | unit: Hz |
| 241 | chart_type: line |
| 242 | dimensions: |
| 243 | - name: frequency |
| 244 | - name: upsd.ups_input_frequency_nominal |
| 245 | description: UPS Input frequency nominal |
| 246 | unit: Hz |
| 247 | chart_type: line |
| 248 | dimensions: |
| 249 | - name: nominal_frequency |
| 250 | - name: upsd.ups_output_voltage |
| 251 | description: UPS Output voltage |
| 252 | unit: Volts |
| 253 | chart_type: line |
| 254 | dimensions: |
| 255 | - name: voltage |
| 256 | - name: upsd.ups_output_voltage_nominal |
| 257 | description: UPS Output voltage nominal |
| 258 | unit: Volts |
| 259 | chart_type: line |
| 260 | dimensions: |
| 261 | - name: nominal_voltage |
| 262 | - name: upsd.ups_output_current |
| 263 | description: UPS Output current |
| 264 | unit: Ampere |
| 265 | chart_type: line |
| 266 | dimensions: |
| 267 | - name: current |
| 268 | - name: upsd.ups_output_current_nominal |
| 269 | description: UPS Output current nominal |
| 270 | unit: Ampere |
| 271 | chart_type: line |
| 272 | dimensions: |
| 273 | - name: nominal_current |
| 274 | - name: upsd.ups_output_frequency |
| 275 | description: UPS Output frequency |
| 276 | unit: Hz |
| 277 | chart_type: line |
| 278 | dimensions: |
| 279 | - name: frequency |
| 280 | - name: upsd.ups_output_frequency_nominal |
| 281 | description: UPS Output frequency nominal |
| 282 | unit: Hz |
| 283 | chart_type: line |
| 284 | dimensions: |
| 285 | - name: nominal_frequency |