@ -1,4 +1,4 @@
#!/usr/bin/env python
#!/usr/bin/env python3
"""
Script to parse StorCLI ' s JSON output and expose
MegaRAID health as Prometheus metrics .
@ -19,110 +19,181 @@ import argparse
import json
import os
import subprocess
import shlex
from dateutil . parser import parse
import collections
from enum import IntEnum
DESCRIPTION = """ Parses StorCLI ' s JSON output and exposes MegaRAID health as
Prometheus metrics . """
VERSION = ' 0.0.1 '
VERSION = ' 0.0.2 '
storcli_path = ' '
metric_prefix = ' megaraid_ '
metric_list = { }
metric_list = collections . defaultdict ( list )
class VD_State ( IntEnum ) :
Optl = 0 # Optimal
Dgrd = 1 # Degraded
Pdgd = 2 # Partially Degraded
OfLn = 3 # Offline
Rec = 4 # Recovery
Cac = 5 # CacheCade
def main ( args ) :
""" main """
# exporter variables
metric_prefix = ' megaraid_ '
metric_controller_labels = ' {{ controller= " {} " , model= " {} " }} '
data = json . loads ( get_storcli_json ( args . storcli_path ) )
# It appears that the data we need will always be present in the first
# item in the Controllers array
status = data [ ' Controllers ' ] [ 0 ]
metrics = {
' status_code ' : status [ ' Command Status ' ] [ ' Status Code ' ] ,
' controllers ' : status [ ' Response Data ' ] [ ' Number of Controllers ' ] ,
}
for name , value in metrics . iteritems ( ) :
print ( ' # HELP {} {} MegaRAID {} ' . format ( metric_prefix , name , name . replace ( ' _ ' , ' ' ) ) )
print ( ' # TYPE {} {} gauge ' . format ( metric_prefix , name ) )
print ( " {} {} {} " . format ( metric_prefix , name , value ) )
controller_info = [ ]
controller_metrics = { }
overview = [ ]
try :
overview = status [ ' Response Data ' ] [ ' System Overview ' ]
except KeyError :
pass
for controller in overview :
controller_index = controller [ ' Ctl ' ]
model = controller [ ' Model ' ]
controller_info . append ( metric_controller_labels . format ( controller_index , model ) )
controller_metrics = {
# FIXME: Parse dimmer switch options
# 'dimmer_switch': controller['DS'],
' battery_backup_healthy ' : int ( controller [ ' BBU ' ] == ' Opt ' ) ,
' degraded ' : int ( controller [ ' Hlth ' ] == ' Dgd ' ) ,
' drive_groups ' : controller [ ' DGs ' ] ,
' emergency_hot_spare ' : int ( controller [ ' EHS ' ] == ' Y ' ) ,
' failed ' : int ( controller [ ' Hlth ' ] == ' Fld ' ) ,
' healthy ' : int ( controller [ ' Hlth ' ] == ' Opt ' ) ,
' physical_drives ' : controller [ ' PDs ' ] ,
' ports ' : controller [ ' Ports ' ] ,
' scheduled_patrol_read ' : int ( controller [ ' sPR ' ] == ' On ' ) ,
' virtual_drives ' : controller [ ' VDs ' ] ,
# Reverse StorCLI's logic to make metrics consistent
' drive_groups_optimal ' : int ( controller [ ' DNOpt ' ] == 0 ) ,
' virtual_drives_optimal ' : int ( controller [ ' VNOpt ' ] == 0 ) ,
}
for name , value in controller_metrics . iteritems ( ) :
print ( ' # HELP {} {} MegaRAID {} ' . format ( metric_prefix , name , name . replace ( ' _ ' , ' ' ) ) )
print ( ' # TYPE {} {} gauge ' . format ( metric_prefix , name ) )
print ( ' {} {} {{ controller= " {} " }} {} ' . format ( metric_prefix , name ,
controller_index , value ) )
if controller_info :
print ( ' # HELP {} {} MegaRAID controller info ' . format ( metric_prefix , ' controller_info ' ) )
print ( ' # TYPE {} {} gauge ' . format ( metric_prefix , ' controller_info ' ) )
for labels in controller_info :
print ( ' {} {} {} {} ' . format ( metric_prefix , ' controller_info ' , labels , 1 ) )
def get_storcli_json ( storcli_path ) :
global storcli_path
storcli_path = args . storcli_path
data = json . loads ( get_storcli_json ( ' /cALL show all J ' ) )
# All the information is collected underneath the Controllers key
data = data [ ' Controllers ' ]
# try:
# overview = status['Response Data']['System Overview']
# except KeyError:
# pass
for controller in data :
response = controller [ ' Response Data ' ]
if response [ ' Version ' ] [ ' Driver Name ' ] == ' megaraid_sas ' :
handle_megaraid_controller ( response )
elif response [ ' Version ' ] [ ' Driver Name ' ] == ' mpt3sas ' :
handle_sas_controller ( response )
# print_dict_to_exporter({'controller_info': [1]}, controller_info_list)
# print_dict_to_exporter({'virtual_disk_info': [1]}, vd_info_list)
# print_dict_to_exporter({'physical_disk_info': [1]}, pd_info_list)
# print_all_metrics(vd_metric_list)
print_all_metrics ( metric_list )
def handle_sas_controller ( response ) :
pass
def handle_megaraid_controller ( response ) :
controller_index = response [ ' Basics ' ] [ ' Controller ' ]
baselabel = ' controller= " {} " ' . format ( controller_index )
controller_info_label = baselabel + ' ,model= " {} " ,serial= " {} " ,fwversion= " {} " ' . format (
response [ ' Basics ' ] [ ' Model ' ] ,
response [ ' Basics ' ] [ ' Serial Number ' ] ,
response [ ' Version ' ] [ ' Firmware Version ' ] ,
)
add_metric ( ' controller_info ' , controller_info_label , 1 )
add_metric ( ' battery_backup_healthy ' , baselabel , int ( response [ ' Status ' ] [ ' BBU Status ' ] == 0 ) )
add_metric ( ' degraded ' , baselabel , int ( response [ ' Status ' ] [ ' Controller Status ' ] == ' Degraded ' ) )
add_metric ( ' failed ' , baselabel , int ( response [ ' Status ' ] [ ' Controller Status ' ] == ' Failed ' ) )
add_metric ( ' healthy ' , baselabel , int ( response [ ' Status ' ] [ ' Controller Status ' ] == ' Optimal ' ) )
add_metric ( ' drive_groups ' , baselabel , response [ ' Drive Groups ' ] )
add_metric ( ' virtual_drives ' , baselabel , response [ ' Virtual Drives ' ] )
add_metric ( ' physical_drives ' , baselabel , response [ ' Physical Drives ' ] )
add_metric ( ' ports ' , baselabel , response [ ' HwCfg ' ] [ ' Backend Port Count ' ] )
add_metric ( ' scheduled_patrol_read ' , baselabel ,
int ( ' hrs ' in response [ ' Scheduled Tasks ' ] [ ' Patrol Read Reoccurrence ' ] ) )
time_difference_seconds = - 1
system_time = parse ( response [ ' Basics ' ] . get ( ' Current System Date/time ' ) )
controller_time = parse ( response [ ' Basics ' ] . get ( ' Current Controller Date/Time ' ) )
if system_time and controller_time :
time_difference_seconds = abs ( system_time - controller_time ) . seconds
add_metric ( ' time_difference ' , baselabel , time_difference_seconds )
for virtual_drive in response [ ' VD LIST ' ] :
vd_position = virtual_drive . get ( ' DG/VD ' )
drive_group , volume_group = - 1 , - 1
if vd_position :
drive_group = vd_position . split ( ' / ' ) [ 0 ]
volume_group = vd_position . split ( ' / ' ) [ 1 ]
vd_baselabel = ' controller= " {} " ,DG= " {} " ,VG= " {} " ' . format ( controller_index , drive_group ,
volume_group )
vd_info_label = vd_baselabel + ' ,name= " {} " ,cache= " {} " ,type= " {} " ' . format (
virtual_drive . get ( ' Name ' ) , virtual_drive . get ( ' Cache ' ) , virtual_drive . get ( ' TYPE ' ) )
add_metric ( ' vd_info ' , vd_info_label , 1 )
add_metric ( ' vd_status ' , vd_baselabel , int ( VD_State [ virtual_drive . get ( ' State ' ) ] ) )
if response [ ' Physical Drives ' ] > 0 :
data = json . loads ( get_storcli_json ( ' /cALL/eALL/sALL show all J ' ) )
drive_info = data [ ' Controllers ' ] [ controller_index ] [ ' Response Data ' ]
for physical_drive in response [ ' PD LIST ' ] :
enclosure = physical_drive . get ( ' EID:Slt ' ) . split ( ' : ' ) [ 0 ]
slot = physical_drive . get ( ' EID:Slt ' ) . split ( ' : ' ) [ 1 ]
pd_baselabel = ' controller= " {} " ,enclosure= " {} " ,slot= " {} " ' . format (
controller_index , enclosure , slot )
pd_info_label = pd_baselabel + ' ,disk_id= " {} " ,interface= " {} " ,media= " {} " ,model= " {} " ' . format (
physical_drive . get ( ' DID ' ) , physical_drive . get ( ' Intf ' ) , physical_drive . get ( ' Med ' ) ,
physical_drive . get ( ' Model ' ) . strip ( ) )
drive_identifier = ' Drive /c ' + str ( controller_index ) + ' /e ' + str ( enclosure ) + ' /s ' + str (
slot )
try :
info = drive_info [ drive_identifier + ' - Detailed Information ' ]
state = info [ drive_identifier + ' State ' ]
attributes = info [ drive_identifier + ' Device attributes ' ]
settings = info [ drive_identifier + ' Policies/Settings ' ]
add_metric ( ' pd_shield_counter ' , pd_baselabel , state [ ' Shield Counter ' ] )
add_metric ( ' pd_media_errors_total ' , pd_baselabel , state [ ' Media Error Count ' ] )
add_metric ( ' pd_other_errors_total ' , pd_baselabel , state [ ' Other Error Count ' ] )
add_metric ( ' pd_predictive_errors_total ' , pd_baselabel ,
state [ ' Predictive Failure Count ' ] )
add_metric ( ' pd_smart_alerted ' , pd_baselabel ,
int ( state [ ' S.M.A.R.T alert flagged by drive ' ] == ' Yes ' ) )
add_metric ( ' pd_link_speed_gbps ' , pd_baselabel , attributes [ ' Link Speed ' ] . split ( ' . ' ) [ 0 ] )
add_metric ( ' pd_device_speed_gbps ' , pd_baselabel ,
attributes [ ' Device Speed ' ] . split ( ' . ' ) [ 0 ] )
add_metric ( ' pd_commissioned_spare ' , pd_baselabel ,
int ( settings [ ' Commissioned Spare ' ] == ' Yes ' ) )
add_metric ( ' pd_emergency_spare ' , pd_baselabel ,
int ( settings [ ' Emergency Spare ' ] == ' Yes ' ) )
pd_info_label + = ' ,firmware= " {} " ' . format ( attributes [ ' Firmware Revision ' ] )
except KeyError :
pass
add_metric ( ' pd_info ' , pd_info_label , 1 )
def add_metric ( name , labels , value ) :
global metric_list
metric_list [ name ] . append ( {
' labels ' : labels ,
' value ' : value ,
} )
def print_all_metrics ( metrics ) :
for metric , measurements in metrics . items ( ) :
print ( ' # HELP {} {} MegaRAID {} ' . format ( metric_prefix , metric , metric . replace ( ' _ ' , ' ' ) ) )
print ( ' # TYPE {} {} gauge ' . format ( metric_prefix , metric ) )
for measurement in measurements :
print ( ' {} {} {} {} ' . format ( metric_prefix , metric , ' { ' + measurement [ ' labels ' ] + ' } ' ,
measurement [ ' value ' ] ) )
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 ) ) :
SystemExit ( 1 )
storcli_cmd = shlex . split ( storcli_path + ' ' + storcli_args )
proc = subprocess . Popen (
storcli_cmd , shell = False , stdout = subprocess . PIPE , stderr = subprocess . PIPE )
output_json = proc . communicate ( ) [ 0 ]
return output_json . decode ( " utf-8 " )
# Check if storcli is installed
if os . path . isfile ( storcli_path ) and os . access ( storcli_path , os . X_OK ) :
storcli_cmd = [ storcli_path , ' show ' , ' all ' , ' J ' ]
proc = subprocess . Popen ( storcli_cmd , shell = False ,
stdout = subprocess . PIPE , stderr = subprocess . PIPE )
output_json = proc . communicate ( ) [ 0 ]
else :
# Create an empty dummy-JSON where storcli not installed.
dummy_json = { " Controllers " : [ {
" Command Status " : { " Status Code " : 0 , " Status " : " Success " ,
" Description " : " None " } ,
" Response Data " : { " Number of Controllers " : 0 } } ] }
output_json = json . dumps ( dummy_json )
return output_json
if __name__ == " __main__ " :
PARSER = argparse . ArgumentParser ( description = DESCRIPTION ,
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 {} ' . format ( VERSION ) )
PARSER = argparse . ArgumentParser (
description = DESCRIPTION , 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 {} ' . format ( VERSION ) )
ARGS = PARSER . parse_args ( )
main ( ARGS )
Christopher Blum
6 years ago
committed by