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