blob: ea2e6b2eb666d045adfc97e31fe8d438276f7d64 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
plugin_name: charts.d.plugin
modules:
- meta:
plugin_name: charts.d.plugin
module_name: nut
monitored_instance:
name: Network UPS Tools (NUT)
link: ''
categories:
- data-collection.ups
icon_filename: 'plug-circle-bolt.svg'
related_resources:
integrations:
list: []
info_provided_to_referring_integrations:
description: ''
keywords:
- nut
- network ups tools
- ups
- pdu
most_popular: false
overview:
data_collection:
metrics_description: 'Examine UPS/PDU metrics with Netdata for insights into power device performance. Improve your power device performance with comprehensive dashboards and anomaly detection.'
method_description: 'This collector uses the `nut` (Network UPS Tools) to query statistics for multiple UPS devices.'
supported_platforms:
include: []
exclude: []
multi_instance: true
additional_permissions:
description: ''
default_behavior:
auto_detection:
description: ''
limits:
description: ''
performance_impact:
description: ''
setup:
prerequisites:
list:
- title: "Required software"
description: "Make sure the Network UPS Tools (`nut`) is installed and can detect your UPS devices."
configuration:
file:
name: charts.d/nut.conf
options:
description: |
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 nut collector.
folding:
title: "Config options"
enabled: true
list:
- name: nut_ups
description: A space separated list of UPS names. If empty, the list returned by `upsc -l` will be used.
default_value: ""
required: false
- name: nut_names
description: Each line represents an alias for one UPS. If empty, the FQDN will be used.
default_value: ""
required: false
- name: nut_timeout
description: How long to wait for nut to respond.
default_value: 2
required: false
- name: nut_clients_chart
description: Set this to 1 to enable another chart showing the number of UPS clients connected to `upsd`.
default_value: 1
required: false
- name: nut_update_every
description: The data collection frequency. If unset, will inherit the netdata update frequency.
default_value: 2
required: false
- name: nut_priority
description: The charts priority on the dashboard
default_value: 90000
required: false
- name: nut_retries
description: The number of retries to do in case of failure before disabling the collector.
default_value: 10
required: false
examples:
folding:
enabled: true
title: "Config"
list:
- name: Provide names to UPS devices
description: Map aliases to UPS devices
config: |
# a space separated list of UPS names
# if empty, the list returned by 'upsc -l' will be used
#nut_ups=
# each line represents an alias for one UPS
# if empty, the FQDN will be used
nut_names["XXXXXX"]="UPS-office"
nut_names["YYYYYY"]="UPS-rack"
# how much time in seconds, to wait for nut to respond
#nut_timeout=2
# set this to 1, to enable another chart showing the number
# of UPS clients connected to upsd
#nut_clients_chart=1
# the data collection frequency
# if unset, will inherit the netdata update frequency
#nut_update_every=2
# the charts priority on the dashboard
#nut_priority=90000
# the number of retries to do in case of failure
# before disabling the module
#nut_retries=10
troubleshooting:
problems:
list: []
alerts:
- name: nut_ups_charge
link: https://github.com/netdata/netdata/blob/master/health/health.d/nut.conf
metric: nut.charge
info: average UPS charge over the last minute
os: "*"
- name: nut_10min_ups_load
link: https://github.com/netdata/netdata/blob/master/health/health.d/nut.conf
metric: nut.load
info: average UPS load over the last 10 minutes
os: "*"
- name: nut_last_collected_secs
link: https://github.com/netdata/netdata/blob/master/health/health.d/nut.conf
metric: nut.load
info: number of seconds since the last successful data collection
metrics:
folding:
title: Metrics
enabled: false
description: ""
availability: []
scopes:
- name: ups
description: "Metrics related to UPS. Each UPS provides its own set of the following metrics."
labels: []
metrics:
- name: nut.charge
description: UPS Charge
unit: "percentage"
chart_type: area
dimensions:
- name: charge
- name: nut.runtime
description: UPS Runtime
unit: "seconds"
chart_type: line
dimensions:
- name: runtime
- name: nut.battery.voltage
description: UPS Battery Voltage
unit: "Volts"
chart_type: line
dimensions:
- name: voltage
- name: high
- name: low
- name: nominal
- name: nut.input.voltage
description: UPS Input Voltage
unit: "Volts"
chart_type: line
dimensions:
- name: voltage
- name: fault
- name: nominal
- name: nut.input.current
description: UPS Input Current
unit: "Ampere"
chart_type: line
dimensions:
- name: nominal
- name: nut.input.frequency
description: UPS Input Frequency
unit: "Hz"
chart_type: line
dimensions:
- name: frequency
- name: nominal
- name: nut.output.voltage
description: UPS Output Voltage
unit: "Volts"
chart_type: line
dimensions:
- name: voltage
- name: nut.load
description: UPS Load
unit: "percentage"
chart_type: area
dimensions:
- name: load
- name: nut.load_usage
description: UPS Load Usage
unit: "Watts"
chart_type: area
dimensions:
- name: load_usage
- name: nut.temperature
description: UPS Temperature
unit: "temperature"
chart_type: line
dimensions:
- name: temp
- name: nut.clients
description: UPS Connected Clients
unit: "clients"
chart_type: area
dimensions:
- name: clients
|
