-
Notifications
You must be signed in to change notification settings - Fork 0
/
storcli.py
executable file
·418 lines (366 loc) · 14.5 KB
/
storcli.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
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
#!/usr/bin/env python3
"""
Script to parse StorCLI's JSON output and expose MegaRAID health as Prometheus metrics.
Tested against StorCLI 'Ver 1.14.12 Nov 25, 2014'.
and '007.1108.0000.0000 July 17, 2019'
StorCLI reference manual: https://docs.broadcom.com/docs/12352476
Advanced Software Options (ASO) not exposed as metrics currently.
JSON key abbreviations used by StorCLI are documented in the standard command output, i.e. when the
trailing 'J' is omitted from the command.
Formatting done with Black:
$ black -l 100 storcli.py
"""
import argparse
import json
import os
import shlex
import subprocess
from datetime import datetime
from prometheus_client import CollectorRegistry, Gauge, generate_latest
__doc__ = "Parse StorCLI's JSON output and expose MegaRAID health as Prometheus metrics."
__version__ = "0.1.0"
storcli_path = ""
namespace = "megaraid"
registry = CollectorRegistry()
metrics = {
# fmt: off
"ctrl_info": Gauge(
"controller_info",
"MegaRAID controller info",
["controller", "model", "serial", "fwversion"], namespace=namespace, registry=registry,
),
"ctrl_temperature": Gauge(
"temperature",
"MegaRAID controller temperature",
["controller"], namespace=namespace, registry=registry,
),
"ctrl_healthy": Gauge(
"healthy",
"MegaRAID controller healthy",
["controller"], namespace=namespace, registry=registry,
),
"ctrl_degraded": Gauge(
"degraded",
"MegaRAID controller degraded",
["controller"], namespace=namespace, registry=registry,
),
"ctrl_failed": Gauge(
"failed",
"MegaRAID controller failed",
["controller"], namespace=namespace, registry=registry,
),
"ctrl_time_difference": Gauge(
"time_difference",
"MegaRAID time difference",
["controller"], namespace=namespace, registry=registry,
),
"bbu_healthy": Gauge(
"battery_backup_healthy",
"MegaRAID battery backup healthy",
["controller"], namespace=namespace, registry=registry,
),
"bbu_temperature": Gauge(
"bbu_temperature",
"MegaRAID battery backup temperature",
["controller", "bbuidx"], namespace=namespace, registry=registry,
),
"cv_temperature": Gauge(
"cv_temperature",
"MegaRAID CacheVault temperature",
["controller", "cvidx"], namespace=namespace, registry=registry,
),
"ctrl_sched_patrol_read": Gauge(
"scheduled_patrol_read",
"MegaRAID scheduled patrol read",
["controller"], namespace=namespace, registry=registry,
),
"ctrl_ports": Gauge(
"ports",
"MegaRAID ports",
["controller"], namespace=namespace, registry=registry,
),
"ctrl_physical_drives": Gauge(
"physical_drives",
"MegaRAID physical drives",
["controller"], namespace=namespace, registry=registry,
),
"ctrl_drive_groups": Gauge(
"drive_groups",
"MegaRAID drive groups",
["controller"], namespace=namespace, registry=registry,
),
"ctrl_virtual_drives": Gauge(
"virtual_drives",
"MegaRAID virtual drives",
["controller"], namespace=namespace, registry=registry,
),
"vd_info": Gauge(
"vd_info",
"MegaRAID virtual drive info",
["controller", "DG", "VG", "name", "cache", "type", "state"],
namespace=namespace, registry=registry,
),
"pd_shield_counter": Gauge(
"pd_shield_counter",
"MegaRAID physical drive shield counter",
["controller", "enclosure", "slot"], namespace=namespace, registry=registry,
),
"pd_media_errors": Gauge(
"pd_media_errors",
"MegaRAID physical drive media errors",
["controller", "enclosure", "slot"], namespace=namespace, registry=registry,
),
"pd_other_errors": Gauge(
"pd_other_errors",
"MegaRAID physical drive other errors",
["controller", "enclosure", "slot"], namespace=namespace, registry=registry,
),
"pd_predictive_errors": Gauge(
"pd_predictive_errors",
"MegaRAID physical drive predictive errors",
["controller", "enclosure", "slot"], namespace=namespace, registry=registry,
),
"pd_smart_alerted": Gauge(
"pd_smart_alerted",
"MegaRAID physical drive SMART alerted",
["controller", "enclosure", "slot"], namespace=namespace, registry=registry,
),
"pd_link_speed": Gauge(
"pd_link_speed_gbps",
"MegaRAID physical drive link speed in Gbps",
["controller", "enclosure", "slot"], namespace=namespace, registry=registry,
),
"pd_device_speed": Gauge(
"pd_device_speed_gbps",
"MegaRAID physical drive device speed in Gbps",
["controller", "enclosure", "slot"], namespace=namespace, registry=registry,
),
"pd_commissioned_spare": Gauge(
"pd_commissioned_spare",
"MegaRAID physical drive commissioned spare",
["controller", "enclosure", "slot"], namespace=namespace, registry=registry,
),
"pd_emergency_spare": Gauge(
"pd_emergency_spare",
"MegaRAID physical drive emergency spare",
["controller", "enclosure", "slot"], namespace=namespace, registry=registry,
),
"pd_info": Gauge(
"pd_info",
"MegaRAID physical drive info",
[
"controller",
"enclosure",
"slot",
"disk_id",
"interface",
"media",
"model",
"DG",
"state",
"firmware",
"serial",
],
namespace=namespace, registry=registry,
),
# fmt: on
}
def main(args):
"""main"""
global storcli_path
storcli_path = args.storcli_path
data = get_storcli_json("/cALL show all J")
try:
# All the information is collected underneath the Controllers key
data = data["Controllers"]
for controller in data:
response = controller["Response Data"]
handle_common_controller(response)
if response["Version"]["Driver Name"] == "megaraid_sas":
handle_megaraid_controller(response)
elif response["Version"]["Driver Name"] == "mpt3sas":
handle_sas_controller(response)
except KeyError:
pass
print(generate_latest(registry).decode(), end="")
def handle_common_controller(response):
controller_index = response["Basics"]["Controller"]
metrics["ctrl_info"].labels(
controller_index,
response["Basics"]["Model"],
response["Basics"]["Serial Number"],
response["Version"]["Firmware Version"],
).set(1)
# Older boards don't have this sensor at all ("Temperature Sensor for ROC" : "Absent")
for key in ["ROC temperature(Degree Celcius)", "ROC temperature(Degree Celsius)"]:
if key in response["HwCfg"]:
metrics["ctrl_temperature"].labels(controller_index).set(response["HwCfg"][key])
break
def handle_sas_controller(response):
controller_index = response["Basics"]["Controller"]
metrics["ctrl_healthy"].labels(controller_index).set(
response["Status"]["Controller Status"] == "OK"
)
metrics["ctrl_ports"].labels(controller_index).set(response["HwCfg"]["Backend Port Count"])
try:
# The number of physical disks is half of the number of items in this dict. Every disk is
# listed twice - once for basic info, again for detailed info.
metrics["ctrl_physical_drives"].labels(controller_index).set(
len(response["Physical Device Information"].keys()) / 2
)
except AttributeError:
pass
for key, basic_disk_info in response["Physical Device Information"].items():
if "Detailed Information" in key:
continue
create_metrics_of_physical_drive(
basic_disk_info[0], response["Physical Device Information"], controller_index
)
def handle_megaraid_controller(response):
controller_index = response["Basics"]["Controller"]
if response["Status"]["BBU Status"] != "NA":
# BBU Status Optimal value is 0 for normal, 8 for charging.
metrics["bbu_healthy"].labels(controller_index).set(
response["Status"]["BBU Status"] in [0, 8, 4096]
)
metrics["ctrl_degraded"].labels(controller_index).set(
response["Status"]["Controller Status"] == "Degraded"
)
metrics["ctrl_failed"].labels(controller_index).set(
response["Status"]["Controller Status"] == "Failed"
)
metrics["ctrl_healthy"].labels(controller_index).set(
response["Status"]["Controller Status"] == "Optimal"
)
metrics["ctrl_ports"].labels(controller_index).set(response["HwCfg"]["Backend Port Count"])
metrics["ctrl_sched_patrol_read"].labels(controller_index).set(
"hrs" in response["Scheduled Tasks"]["Patrol Read Reoccurrence"]
)
for cvidx, cvinfo in enumerate(response.get("Cachevault_Info", [])):
if "Temp" in cvinfo:
metrics["cv_temperature"].labels(controller_index, cvidx).set(
cvinfo["Temp"].replace("C", "")
)
for bbuidx, bbuinfo in enumerate(response.get("BBU_Info", [])):
if "Temp" in bbuinfo:
metrics["bbu_temperature"].labels(controller_index, bbuidx).set(
bbuinfo["Temp"].replace("C", "")
)
system_time = datetime.strptime(
response["Basics"]["Current System Date/time"], "%m/%d/%Y, %H:%M:%S"
)
controller_time = datetime.strptime(
response["Basics"]["Current Controller Date/Time"], "%m/%d/%Y, %H:%M:%S"
)
if system_time and controller_time:
metrics["ctrl_time_difference"].labels(controller_index).set(
abs(system_time - controller_time).seconds
)
# Make sure it doesn't crash if it's a JBOD setup
if "Drive Groups" in response:
metrics["ctrl_drive_groups"].labels(controller_index).set(response["Drive Groups"])
metrics["ctrl_virtual_drives"].labels(controller_index).set(response["Virtual Drives"])
for virtual_drive in response["VD LIST"]:
vd_position = virtual_drive.get("DG/VD")
if vd_position:
drive_group, volume_group = vd_position.split("/")[:2]
else:
drive_group, volume_group = -1, -1
metrics["vd_info"].labels(
controller_index,
drive_group,
volume_group,
virtual_drive["Name"],
virtual_drive["Cache"],
virtual_drive["TYPE"],
virtual_drive["State"],
).set(1)
metrics["ctrl_physical_drives"].labels(controller_index).set(response["Physical Drives"])
if response["Physical Drives"] > 0:
data = get_storcli_json("/cALL/eALL/sALL show all J")
drive_info = data["Controllers"][controller_index]["Response Data"]
for physical_drive in response["PD LIST"]:
create_metrics_of_physical_drive(physical_drive, drive_info, controller_index)
def create_metrics_of_physical_drive(physical_drive, detailed_info_array, controller_index):
enclosure, slot = physical_drive.get("EID:Slt").split(":")[:2]
if enclosure == " ":
drive_identifier = "Drive /c{0}/s{1}".format(controller_index, slot)
enclosure = ""
else:
drive_identifier = "Drive /c{0}/e{1}/s{2}".format(controller_index, enclosure, slot)
try:
info = detailed_info_array[drive_identifier + " - Detailed Information"]
state = info[drive_identifier + " State"]
attributes = info[drive_identifier + " Device attributes"]
settings = info[drive_identifier + " Policies/Settings"]
metrics["pd_shield_counter"].labels(controller_index, enclosure, slot).set(
state["Shield Counter"]
)
metrics["pd_media_errors"].labels(controller_index, enclosure, slot).set(
state["Media Error Count"]
)
metrics["pd_other_errors"].labels(controller_index, enclosure, slot).set(
state["Other Error Count"]
)
metrics["pd_predictive_errors"].labels(controller_index, enclosure, slot).set(
state["Predictive Failure Count"]
)
metrics["pd_smart_alerted"].labels(controller_index, enclosure, slot).set(
state["S.M.A.R.T alert flagged by drive"] == "Yes"
)
metrics["pd_link_speed"].labels(controller_index, enclosure, slot).set(
attributes["Link Speed"].split(".")[0]
)
metrics["pd_device_speed"].labels(controller_index, enclosure, slot).set(
attributes["Device Speed"].split(".")[0]
)
metrics["pd_commissioned_spare"].labels(controller_index, enclosure, slot).set(
settings["Commissioned Spare"] == "Yes"
)
metrics["pd_emergency_spare"].labels(controller_index, enclosure, slot).set(
settings["Emergency Spare"] == "Yes"
)
# Model, firmware version and serial number may be space-padded, so strip() them.
metrics["pd_info"].labels(
controller_index,
enclosure,
slot,
physical_drive["DID"],
physical_drive["Intf"],
physical_drive["Med"],
physical_drive["Model"].strip(),
physical_drive["DG"],
physical_drive["State"],
attributes["Firmware Revision"].strip(),
attributes["SN"].strip(),
).set(1)
except KeyError:
pass
def get_storcli_json(storcli_args):
"""Get storcli output in JSON format."""
# Check if storcli is installed and executable
if not (os.path.isfile(storcli_path) and os.access(storcli_path, os.X_OK)):
raise SystemExit(1)
storcli_cmd = [storcli_path]
storcli_cmd.extend(shlex.split(storcli_args))
storcli_cmd.append("nolog")
proc = subprocess.Popen(
storcli_cmd, shell=False, stdout=subprocess.PIPE, stderr=subprocess.PIPE
)
stdout, _ = proc.communicate()
data = json.loads(stdout.decode())
if data["Controllers"][0]["Command Status"]["Status"] != "Success":
raise SystemExit(1)
return data
if __name__ == "__main__":
parser = argparse.ArgumentParser(
description=__doc__, formatter_class=argparse.ArgumentDefaultsHelpFormatter
)
parser.add_argument(
"--storcli_path",
default="/opt/MegaRAID/storcli/storcli64",
help="path to StorCLI binary",
)
parser.add_argument("--version", action="version", version="%(prog)s {0}".format(__version__))
args = parser.parse_args()
main(args)