-
Notifications
You must be signed in to change notification settings - Fork 185
/
tw_cli.py
executable file
·335 lines (274 loc) · 12.9 KB
/
tw_cli.py
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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
#!/usr/bin/env python3
#
# Prometheus node_exporter textfile collector for 3ware RAID controllers
#
# Half of it based on "Nagios Plugin for 3ware RAID" from "Hari Sekhon",
# Ref: http://github.com/harisekhon/nagios-plugins
# ... with additions for full info (-I) gathering
#
# (c) 2019, Nuno Tavares <[email protected]>
#
# You can find the latest version at:
# https://github.com/ntavares/node-exporter-textfile-collector-scripts
#
"""Nagios plugin to test the state of all 3ware RAID arrays and / or drives on all 3ware controllers
on the local machine. Requires the tw_cli program written by 3ware, which should be called tw_cli_64
if running on a 64-bit system. May be remotely executed via any of the standard remote nagios
execution mechanisms"""
import copy
import os
import re
import sys
from argparse import ArgumentParser
from subprocess import Popen, PIPE, STDOUT
__version__ = '0.1.0'
BIN = None
METRICS = {}
METRIC_PREFIX = 'tw_cli'
def exit_error(msg):
print('{}_cli_error{{message="{}"}}\t1'.format(METRIC_PREFIX, msg))
sys.exit(1)
def exit_clean():
global METRICS
for mk, mv in METRICS.items():
print('{}_{}\t{}'.format(METRIC_PREFIX, mk, mv))
sys.exit(0)
def add_metric(metric, labels, value):
global METRICS
labelstrs = []
for lk, lv in labels.items():
labelstrs += ['{}="{}"'.format(lk, lv)]
labelstr = ','.join(labelstrs)
METRICS[metric + '{' + labelstr + '}'] = str(value)
def _set_twcli_binary():
"""Set the path to the twcli binary"""
global BIN
BIN = '/usr/sbin/tw_cli'
def run(cmd, stripOutput=True):
"""Runs a system command and returns stripped output"""
if not cmd:
exit_error("Internal python error - no cmd supplied for 3ware utility")
try:
process = Popen(BIN, stdin=PIPE, stdout=PIPE, stderr=STDOUT)
except OSError as error:
error = str(error)
if error == "No such file or directory":
exit_error("Cannot find 3ware utility '{}'".format(BIN))
else:
exit_error("Error trying to run 3ware utility - {}".format(error))
if process.poll():
exit_error("3ware utility process ended prematurely")
try:
stdout, stderr = process.communicate(cmd)
except OSError as error:
exit_error("Unable to communicate with 3ware utility - {}".format(error))
if not stdout:
exit_error("No output from 3ware utility")
output = str(stdout).split('\n')
# Strip command prompt, since we're running an interactive CLI shell
output[0] = re.sub(r'//.*?> ', '', output[0])
if output[1] == "No controller found.":
exit_error("No 3ware controllers were found on this machine")
if process.returncode != 0:
stderr = str(stdout).replace('\n', ' ')
exit_error("3ware utility returned an exit code of {} - {}".format(process.returncode,
stderr))
if stripOutput:
return output[3:-2]
return output
def test_all(verbosity, warn_true=False):
"""Calls the RAID and drive testing functions"""
test_arrays(verbosity, warn_true)
test_drives(verbosity, warn_true)
def test_arrays(verbosity, warn_true=False):
"""Tests all the RAID arrays on all the 3ware controllers on the local machine"""
lines = run('show')
# controllers = [line.split()[0] for line in lines]
controllers = [line.split()[0] for line in lines if line.startswith('c')]
for controller in controllers:
unit_lines = run('/{} show unitstatus'.format(controller))
if verbosity >= 3:
for unit_line in unit_lines:
print(unit_line)
print()
for unit_line in unit_lines:
unit_line = unit_line.split()
state = unit_line[2]
unit = int(unit_line[0][1:])
raid = unit_line[1]
add_metric('array_info', {'controller': controller[1:], 'unit': unit, 'state': state,
'raid': raid}, 1)
if state == 'OK':
add_metric('array_status', {'controller': controller[1:], 'unit': unit,
'state': state}, 1)
continue
elif state in ('REBUILDING', 'VERIFY-PAUSED', 'VERIFYING', 'INITIALIZING'):
if state in ('VERIFY-PAUSED', 'VERIFYING', 'INITIALIZING'):
percent_complete = unit_line[4]
else:
percent_complete = unit_line[3]
if warn_true:
add_metric('array_status', {'controller': controller[1:], 'unit': unit,
'state': state, 'pct': percent_complete}, 0)
else:
add_metric('array_status', {'controller': controller[1:], 'unit': unit,
'state': state, 'pct': percent_complete}, 1)
else:
add_metric('array_status', {'controller': controller[1:], 'unit': unit,
'state': state}, 0)
def test_drives(verbosity, warn_true=False):
"""Tests all the drives on the all the 3ware RAID controllers on the local machine"""
lines = run('show')
controllers = []
for line in lines:
parts = line.split()
if parts:
controllers.append(parts[0])
for controller in controllers:
drive_lines = run('/{} show drivestatus'.format(controller))
if verbosity >= 3:
for drive_line in drive_lines:
print(drive_line)
print()
for drive_line in drive_lines:
drive_line = drive_line.split()
state = drive_line[1]
drive = drive_line[0]
if drive[0] == 'd':
drive = drive[1:]
array = drive_line[2]
if array[0] == 'u':
array = array[1:]
if state in ('OK', 'NOT-PRESENT'):
add_metric('drive_status', {'controller': controller[1:], 'drive': drive,
'array': array, 'state': state}, 1)
continue
if not warn_true and state in ('VERIFYING', 'REBUILDING', 'INITIALIZING'):
add_metric('drive_status', {'controller': controller[1:], 'drive': drive,
'array': array, 'state': state}, 1)
continue
else:
add_metric('drive_status', {'controller': controller[1:], 'drive': drive,
'array': array, 'state': state}, 0)
def _parse_temperature(val):
result = re.split(r'(\d+)(.*)$', val)
return result[1]
def _parse_yes_ok_on(val):
if val in ('OK', 'Yes', 'On'):
return 1
return 0
def collect_details(cmdprefix, detailsMap, metric, injectedLabels, verbosity):
"""Generic function to parse key = value lists, based on a detailsMap which selects the fields
to parse. injectedLabels is just baseline labels to be included. Note that the map may list both
labels to append to a catchall 'metric', or individual metrics, whose name overrides 'metric'
and will contain injectedLabels."""
lines = run('{} show all'.format(cmdprefix), False)
labels = copy.copy(injectedLabels)
for line in lines:
if re.match('^' + cmdprefix + ' (.+?)= (.+?)$', line):
if verbosity >= 3:
print(line)
result = re.split(r'\S+ (.+?)= (.+?)$', line)
# print("RESULT:", str(result))
k = result[1].strip()
v = result[2].strip()
if k in detailsMap:
if detailsMap[k]['parser']:
v = detailsMap[k]['parser'](v)
# If this field is meant for a separate metric, do it
if 'metric' in detailsMap[k]:
add_metric(detailsMap[k]['metric'], injectedLabels, v)
else:
labels[detailsMap[k]['label']] = v
add_metric(metric, labels, 1)
def collect_controller(verbosity):
CTRL_DETAILS = {
'Model': {'label': 'model', 'parser': None},
'Firmware Version': {'label': 'firmware', 'parser': None},
'Bios Version': {'label': 'bios', 'parser': None},
'Serial Number': {'label': 'serial', 'parser': None},
'PCB Version': {'label': 'pcb', 'parser': None},
'PCHIP Version': {'label': 'pchip', 'parser': None},
'ACHIP Version': {'label': 'achip', 'parser': None},
}
lines = run('show')
controllers = [line.split()[0] for line in lines if line.startswith('c')]
for controller in controllers:
collect_details('/' + controller, CTRL_DETAILS, 'controller_info',
{'controller': controller[1:]}, verbosity)
collect_bbu(controller, verbosity)
collect_drives(controller, verbosity)
def collect_drives(controller, verbosity):
DRIVE_DETAILS = {
# 'Status': {'metric': 'drive_status', 'parser': _parse_yes_ok_on},
'Reallocated Sectors': {'metric': 'drive_reallocated_sectors', 'parser': None},
'Temperature': {'metric': 'drive_temperature', 'parser': _parse_temperature},
'Model': {'label': 'model', 'parser': None},
'Firmware Version': {'label': 'firmware', 'parser': None},
'Serial': {'label': 'serial', 'parser': None},
'Belongs to Unit': {'label': 'unit', 'parser': None},
'Link Speed': {'label': 'linkspeed', 'parser': None},
}
drive_lines = run('/' + controller + ' show drivestatus')
for drive_line in drive_lines:
drive_line = drive_line.split()
drive = drive_line[0]
collect_details('/' + controller + '/' + drive, DRIVE_DETAILS, 'drive_info',
{'controller': controller[1:], 'drive': drive}, verbosity)
def collect_bbu(controller, verbosity):
BBU_DETAILS = {
'Firmware Version': {'label': 'firmware', 'parser': None},
'Serial Number': {'label': 'serial', 'parser': None},
'Bootloader Version': {'label': 'bootloader', 'parser': None},
'PCB Revision': {'label': 'pcb', 'parser': None},
'Battery Installation Date': {'label': 'since', 'parser': None},
'Online State': {'metric': 'bbu_online', 'parser': _parse_yes_ok_on},
'BBU Ready': {'metric': 'bbu_ready', 'parser': _parse_yes_ok_on},
'BBU Status': {'metric': 'bbu_status', 'parser': _parse_yes_ok_on},
'Battery Voltage status': {'metric': 'bbu_voltage_status', 'parser': _parse_yes_ok_on},
'Battery Temperature Status': {'metric': 'bbu_temperature_status',
'parser': _parse_yes_ok_on},
'Battery Temperature Value': {'metric': 'bbu_temperature',
'parser': _parse_temperature},
}
collect_details('/' + controller + '/bbu', BBU_DETAILS, 'bbu_info',
{'controller': controller[1:]}, verbosity)
def main():
"""Parses command line options and calls the function to test the arrays/drives"""
parser = ArgumentParser()
group = parser.add_mutually_exclusive_group()
group.add_argument('-a', '--arrays-only', action='store_true',
help="Only test the arrays (default: %(default)s)")
group.add_argument('-d', '--drives-only', action='store_true',
help="Only test the drives (default: %(default)s)")
parser.add_argument('-I', '--info', action='store_true', dest='incl_info',
help="Include detailed component info (default: %(default)s)")
parser.add_argument('-w', '--warn-rebuilding', action='store_true',
help="Warn when an array or disk is Rebuilding, Initializing or Verifying. "
"You might want to do this to keep a closer eye on things. Also, these "
"conditions can affect performance so you might want to know this is going "
"on (default: %(default)s)")
parser.add_argument('-v', '--verbose', action='count', dest='verbosity',
help="Verbose mode. By default only one result line is printed as per "
"Nagios standards")
parser.add_argument('-V', '--version', action='version', version=__version__)
args = parser.parse_args()
if args.drives_only and args.warn_rebuilding:
parser.error("You cannot use the -d and -w switches together. Array warning states are "
"invalid when testing only drives.")
if os.geteuid() != 0:
exit_error("You must be root to run this plugin")
_set_twcli_binary()
if args.drives_only:
test_drives(args.verbosity, args.warn_rebuilding)
else:
test_all(args.verbosity, args.warn_rebuilding)
if args.incl_info:
collect_controller(args.verbosity)
exit_clean()
if __name__ == '__main__':
try:
main()
except KeyboardInterrupt:
print("Caught Control-C...")
sys.exit(1)