Spearhead/checkmk-plugins
12
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add Sentry PDU (3rd line) outlet power checks, for CheckMK 1.6 and 2.2.

Browse Source
This commit is contained in:
Marsell Kukuljevic 2024-02-27 08:47:28 +01:00
parent 15f69ddc0c
commit 775f9515a1
6 changed files with 2891 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2365
check_mk-sentry-pdu/Sentry3.mib Executable file
View File

File diff suppressed because it is too large Load Diff

17
check_mk-sentry-pdu/checkmk_1.6/local/share/check_mk/checkman/sentry_pdu_outlets_power Normal file
View File

@ -0,0 +1,17 @@
title: Sentry PDU Devices: Outlet Power
agents: snmp
catalog: hw/power/servertech
license: Proprietary
distribution: Spearhead Systems SRL
description:
This check monitors the power of outlets in a Sentry PDU Device.
Without configuration the status will always be OK, except when an infeed is
returning no data.
You are able to set warn/crit levels, such that the status may change to
WARN or CRIT dependent on the levels.
item:
The items are named "Outlet" with following socket ID and names.
inventory:
One service per socket.

175
check_mk-sentry-pdu/checkmk_1.6/local/share/check_mk/checks/sentry_pdu_outlets_power Normal file
View File

@ -0,0 +1,175 @@
#!/usr/bin/env python
#
# Copyright 2024 Spearhead Systems SRL
#
# Docs for this system:
# https://cdn10.servertech.com/assets/documents/documents/135/original/manual_CDU_Y-30932L.pdf
# https://cdn10.servertech.com/assets/documents/documents/793/original/Sentry3.mib
from itertools import chain
# A note about MAX_SOCKETS:
#
# According to the MIB, MAX_SOCKETS should be 64. However, since CheckMK 1.6
# doesn't appear to have something like 2.*'s SNMPTree functionality, we
# brute-force by explicitly querying every possible socket. Unfortunately,
# this means querying ~3K OIDs. In practice, the data received from the customer
# shows that they only have two or four sockets per infeed, so I've set the
# MAX_SOCKETS here to 16, which cuts the queried OIDs to 800. Using MAX_SOCKETS
# of 4 would still satisfy the customer's current needs, but leaves no leeway
# if the get more sockets in an infeed.
MAX_TOWERS = 4
MAX_INFEEDS = 4
MAX_SOCKETS = 16 # XXX
TOWER_ARR_SIZE = MAX_TOWERS
INFEED_ARR_SIZE = MAX_TOWERS * MAX_INFEEDS
SOCKET_ARR_SIZE = MAX_TOWERS * MAX_INFEEDS * MAX_SOCKETS
TOWER_NUM_OFFSET = 0
INFEED_NUM_OFFSET = TOWER_NUM_OFFSET + 1
INFEED_ID_OFFSET = INFEED_NUM_OFFSET + TOWER_ARR_SIZE
INFEED_VOLT_OFFSET = INFEED_ID_OFFSET + INFEED_ARR_SIZE
SOCKET_NUM_OFFSET = INFEED_VOLT_OFFSET + INFEED_ARR_SIZE
SOCKET_ID_OFFSET = SOCKET_NUM_OFFSET + INFEED_ARR_SIZE
SOCKET_NAME_OFFSET = SOCKET_ID_OFFSET + SOCKET_ARR_SIZE
SOCKET_LOAD_OFFSET = SOCKET_NAME_OFFSET + SOCKET_ARR_SIZE
def parse_sentry_pdu(info):
outlets_info = {}
results = info[0]
num_towers = int(results[TOWER_NUM_OFFSET])
for tower_id in range(num_towers):
num_infeeds = int(results[INFEED_NUM_OFFSET + tower_id])
for infeed_id in range(num_infeeds):
infeed_idx = tower_id * MAX_TOWERS + infeed_id
infeed_sid = results[INFEED_ID_OFFSET + infeed_idx]
infeed_voltage = float(results[INFEED_VOLT_OFFSET + infeed_idx]) / 10
num_outlets = int(results[SOCKET_NUM_OFFSET + infeed_idx])
for outlet_id in range(num_outlets):
outlet_idx = MAX_INFEEDS * MAX_SOCKETS * tower_id + MAX_SOCKETS * infeed_id + outlet_id
outlet_sid = results[SOCKET_ID_OFFSET + outlet_idx]
outlet_name = results[SOCKET_NAME_OFFSET + outlet_idx]
outlet_load = float(results[SOCKET_LOAD_OFFSET + outlet_idx]) / 100
outlet_key = '%s.%s.%s' % (tower_id, infeed_id, outlet_id)
outlets_info[outlet_key] = {
'infeed_id': infeed_sid,
'infeed_voltage': infeed_voltage,
'outlet_id': outlet_sid,
'outlet_name': outlet_name,
'outlet_load': outlet_load
}
return outlets_info
def check_sentry_pdu(item, params, parsed):
id = params['id']
outlet = parsed.get(id)
if outlet is None:
return (3, 'item not found in snmp data')
voltage = outlet['infeed_voltage']
amps = outlet['outlet_load']
if voltage < 0:
return (1, 'Infeed voltage unavailable')
elif amps < 0:
return (1, 'Outlet load unavailable')
power = voltage * amps
state = 0
crit_watts_above = params.get('crit_watts_above')
warn_watts_above = params.get('warn_watts_above')
warn_watts_below = params.get('warn_watts_below')
crit_watts_below = params.get('crit_watts_below')
if crit_watts_above and crit_watts_above < power:
state = 2
elif crit_watts_below and crit_watts_below > power:
state = 2
elif warn_watts_above and warn_watts_above < power:
state = 1
elif warn_watts_below and warn_watts_below > power:
state = 1
return (state, '%.1f watts' % power)
def inventory_sentry_pdu(parsed):
items = []
for id, outlet in parsed.items():
name = '%s %s [infeed %s] power' % (
outlet['outlet_id'],
outlet['outlet_name'],
outlet['infeed_id'])
items.append((name, { 'id': id }))
return items
check_info['sentry_pdu_outlets_power'] = {
'parse_function': parse_sentry_pdu,
'check_function': check_sentry_pdu,
'inventory_function': inventory_sentry_pdu,
'service_description': 'Outlet %s',
'group': 'sentry_pdu_outlets_power',
'snmp_info': (
'.1.3.6.1.4.1.1718.3',
# In CheckMK 2.* there is SMPTree, but 1.6 doesn't seem to have that.
# Therefore we resort to this sledge-hammer approach to get the
# information we need. It's... not ideal.
list(chain(
# Number of towers
['1.4.0'],
# Number of infeeds
# .1.3.6.1.4.1.1718.3.2.1.1.5.<tower #>
['2.1.1.5.%s' % (x) for x in range(1, MAX_TOWERS+1)],
# Infeed IDs:
# .1.3.6.1.4.1.1718.3.2.2.1.2.<tower #>.<infeed #>
['2.2.1.2.%s.%s' % (x, y) for x in range(1, MAX_TOWERS+1)
for y in range(1, MAX_INFEEDS+1)],
# Infeed voltage:
# .1.3.6.1.4.1.1718.3.2.2.1.11.<tower #>.<infeed #>
['2.2.1.11.%s.%s' % (x, y) for x in range(1, MAX_TOWERS+1)
for y in range(1, MAX_INFEEDS+1)],
# Number of outlets
# .1.3.6.1.4.1.1718.3.2.2.1.9.<tower #>.<infeed #>
['2.2.1.9.%s.%s' % (x, y) for x in range(1, MAX_TOWERS+1)
for y in range(1, MAX_INFEEDS+1)],
# Outlet IDs:
# .1.3.6.1.4.1.1718.3.2.3.1.2.<tower #>.<infeed #>.<outlet #>
['2.3.1.2.%s.%s.%s' % (x, y, z) for x in range(1, MAX_TOWERS+1)
for y in range(1, MAX_INFEEDS+1)
for z in range(1, MAX_SOCKETS+1)],
# Outlet names:
# .1.3.6.1.4.1.1718.3.2.3.1.3.<tower #>.<infeed #>.<outlet #>
['2.3.1.3.%s.%s.%s' % (x, y, z) for x in range(1, MAX_TOWERS+1)
for y in range(1, MAX_INFEEDS+1)
for z in range(1, MAX_SOCKETS+1)],
# Outlet load:
# .1.3.6.1.4.1.1718.3.2.3.1.7.<tower #>.<infeed #>.<outlet #>
['2.3.1.7.%s.%s.%s' % (x, y, z) for x in range(1, MAX_TOWERS+1)
for y in range(1, MAX_INFEEDS+1)
for z in range(1, MAX_SOCKETS+1)],
))),
'snmp_scan_function': lambda oid: 'Sentry Switched -48 VDC' in oid('.1.3.6.1.2.1.1.1.0')
}

88
check_mk-sentry-pdu/checkmk_1.6/local/share/check_mk/web/plugins/wato/sentry_pdu_outlets_power.py Normal file
View File

@ -0,0 +1,88 @@
#!/usr/bin/env python3
#
# Copyright 2024 Spearhead Systems SRL
from cmk.gui.i18n import _
from cmk.gui.plugins.wato import (
rulespec_registry,
CheckParameterRulespecWithItem,
RulespecGroupCheckParametersEnvironment,
)
from cmk.gui.valuespec import (
Dictionary,
Integer,
)
def _valuespec_outlets_power_check():
return Dictionary(
optional_keys=[
'crit_watts_above',
'warn_watts_above',
'warn_watts_below',
'crit_watts_below'
],
elements=[
(
'crit_watts_above',
Integer(
minvalue=0,
title=_('Crit when above power'),
unit=_('Watts'),
help=_(
'If the Wattage of an outlet goes above this number, enter a critical state.'
),
),
),
(
'warn_watts_above',
Integer(
minvalue=0,
title=_('Warn when above power'),
unit=_('Watts'),
help=_(
'If the Wattage of an outlet goes above this number, enter a warning state.'
),
),
),
(
'warn_watts_below',
Integer(
minvalue=0,
title=_('Warn when below power'),
unit=_('Watts'),
help=_(
'If the Wattage of an outlet goes below this number, enter a warning state.'
),
),
),
(
'crit_watts_below',
Integer(
minvalue=0,
title=_('Crit when below power'),
unit=_('Watts'),
help=_(
'If the Wattage of an outlet goes below this number, enter a critical state.'
),
),
),
],
)
def _item_spec_outlets_power_check():
return TextAscii(title=_('Socket Name'),
help=_('The name of the socket'))
rulespec_registry.register(
CheckParameterRulespecWithItem(
check_group_name='sentry_pdu_outlets_power',
group=RulespecGroupCheckParametersEnvironment,
match_type='dict',
item_spec=_item_spec_outlets_power_check,
parameter_valuespec=_valuespec_outlets_power_check,
title=lambda: _('Sentry PDU Outlets Power Checks'),
)
)

165
check_mk-sentry-pdu/checkmk_2.2/local/lib/check_mk/base/plugins/agent_based/sentry_pdu_outlets_power.py Normal file
View File

@ -0,0 +1,165 @@
#!/usr/bin/env python3
#
# Copyright 2024 Spearhead Systems SRL
#
# Docs for this system:
# https://cdn10.servertech.com/assets/documents/documents/135/original/manual_CDU_Y-30932L.pdf
# https://cdn10.servertech.com/assets/documents/documents/793/original/Sentry3.mib
from cmk.base.plugins.agent_based.agent_based_api.v1 import (
register,
Service,
Result,
State,
SNMPTree,
contains,
OIDEnd,
)
def extract_outlet(tower_id, infeed_id, outlet_id, data):
return next(filter(lambda x: x[0] == f'{tower_id+1}.{infeed_id+1}.{outlet_id+1}', data))[1]
# SNMP parsing function
def parse_sentry_pdu(string_table):
outlets_info = {}
num_towers = int(string_table[0][0][0])
for tower_id in range(num_towers):
num_infeeds = int(string_table[1][0][tower_id])
for infeed_id in range(num_infeeds):
infeed_sid = string_table[2][infeed_id][tower_id]
infeed_voltage = float(string_table[3][infeed_id][tower_id]) / 10
num_outlets = int(string_table[4][infeed_id][tower_id])
for outlet_id in range(num_outlets):
outlet_sid = extract_outlet(tower_id, infeed_id, outlet_id, string_table[5])
outlet_name = extract_outlet(tower_id, infeed_id, outlet_id, string_table[6])
outlet_load = float(extract_outlet(tower_id, infeed_id, outlet_id, string_table[7])) / 100
outlets_info[f'{tower_id}.{infeed_id}.{outlet_id}'] = {
'infeed_id': infeed_sid,
'infeed_voltage': infeed_voltage,
'outlet_id': outlet_sid,
'outlet_name': outlet_name,
'outlet_load': outlet_load
}
return outlets_info
# Inventory function, returning inventory based upon SNMP parsed result above
def discovery_sentry_pdu(section):
for key, outlet in section.items():
name = f'{outlet["outlet_id"]} {outlet["outlet_name"]} (infeed {outlet["infeed_id"]}) power'
yield Service(item=name, parameters={ 'id': key })
# Check function, returning warn/crit based upon SNMP parsed result above
def check_sentry_pdu(item, params, section):
outlet = section.get(params['id'])
if outlet is None:
return
voltage = outlet['infeed_voltage']
amps = outlet['outlet_load']
if voltage < 0:
yield Result(state=State.WARN, summary='Infeed voltage unavailable')
return
elif amps < 0:
yield Result(state=State.WARN, summary='Outlet load unavailable')
return
power = voltage * amps
state = State.OK
crit_watts_above = params.get('crit_watts_above')
warn_watts_above = params.get('warn_watts_above')
warn_watts_below = params.get('warn_watts_below')
crit_watts_below = params.get('crit_watts_below')
if crit_watts_above and crit_watts_above < power:
state = State.CRIT
elif crit_watts_below and crit_watts_below > power:
state = State.CRIT
elif warn_watts_above and warn_watts_above < power:
state = State.WARN
elif warn_watts_below and warn_watts_below > power:
state = State.WARN
yield Result(state=state, summary=f'{power:.1f} watts')
register.snmp_section(
name='sentry_pdu_outlets_power',
parse_function=parse_sentry_pdu,
fetch=[
# Number of towers (integer from 0 to 4)
SNMPTree(
base='.1.3.6.1.4.1.1718.3.1.4',
oids=['0']
),
# Number of infeeds (integer from 0 to 4):
# .1.3.6.1.4.1.1718.3.2.1.1.5.<tower #>
SNMPTree(
base='.1.3.6.1.4.1.1718.3.2.1.1.5',
oids=['1', '2', '3', '4'],
),
# Infeed IDs:
# .1.3.6.1.4.1.1718.3.2.2.1.2.<tower #>.<infeed #>
SNMPTree(
base='.1.3.6.1.4.1.1718.3.2.2.1.2',
oids=['1', '2', '3', '4'],
),
# Infeed voltage:
# .1.3.6.1.4.1.1718.3.2.2.1.11.<tower #>.<infeed #>
SNMPTree(
base='.1.3.6.1.4.1.1718.3.2.2.1.11',
oids=['1', '2', '3', '4'],
),
# Number of outlets (integer from 0 to 64):
# .1.3.6.1.4.1.1718.3.2.2.1.9.<tower #>.<infeed #>
SNMPTree(
base='.1.3.6.1.4.1.1718.3.2.2.1.9',
oids=['1', '2', '3', '4'],
),
# Outlet IDs:
# .1.3.6.1.4.1.1718.3.2.3.1.2.<tower #>.<infeed #>.<outlet #>
SNMPTree(
base='.1.3.6.1.4.1.1718.3.2.3.1',
oids=[OIDEnd(), '2'],
),
# Outlet names:
# .1.3.6.1.4.1.1718.3.2.3.1.3.<tower #>.<infeed #>.<outlet #>
SNMPTree(
base='.1.3.6.1.4.1.1718.3.2.3.1',
oids=[OIDEnd(), '3'],
),
# Outlet load:
# .1.3.6.1.4.1.1718.3.2.3.1.7.<tower #>.<infeed #>.<outlet #>
SNMPTree(
base='.1.3.6.1.4.1.1718.3.2.3.1',
oids=[OIDEnd(), '7']
),
],
detect=contains('.1.3.6.1.2.1.1.1.0', 'Sentry Switched -48 VDC'),
)
register.check_plugin(
name='sentry_pdu_outlets_power',
service_name='Outlet %s',
discovery_function=discovery_sentry_pdu,
check_function=check_sentry_pdu,
check_default_parameters={},
check_ruleset_name='sentry_pdu_outlets_power',
)

81
check_mk-sentry-pdu/checkmk_2.2/local/share/check_mk/web/plugins/wato/sentry_pdu_outlets_power.py Normal file
View File

@ -0,0 +1,81 @@
#!/usr/bin/env python3
#
# Copyright 2024 Spearhead Systems SRL
from cmk.gui.i18n import _
from cmk.gui.plugins.wato.utils import (
rulespec_registry,
CheckParameterRulespecWithItem,
RulespecGroupCheckParametersEnvironment,
)
from cmk.gui.valuespec import (
Dictionary,
Integer,
)
def _valuespec_agents_sentry_pdu_outlets_power_check():
return Dictionary(
title=_('Sentry PDU Outlets Power Checks'),
optional_keys=[
'crit_watts_above',
'warn_watts_above',
'warn_watts_below',
'crit_watts_below'
],
elements=[
(
'crit_watts_above',
Integer(
minvalue=0,
title=_('Crit when above power'),
unit=_('Watts'),
help=_(
'If the Wattage of an outlet goes above this number, enter a critical state.'
),
),
),
(
'warn_watts_above',
Integer(
minvalue=0,
title=_('Warn when above power'),
unit=_('Watts'),
help=_(
'If the Wattage of an outlet goes above this number, enter a warning state.'
),
),
),
(
'warn_watts_below',
Integer(
minvalue=0,
title=_('Warn when below power'),
unit=_('Watts'),
help=_(
'If the Wattage of an outlet goes below this number, enter a warning state.'
),
),
),
(
'crit_watts_below',
Integer(
minvalue=0,
title=_('Crit when below power'),
unit=_('Watts'),
help=_(
'If the Wattage of an outlet goes below this number, enter a critical state.'
),
),
),
],
)
rulespec_registry.register(
CheckParameterRulespecWithItem(
check_group_name='sentry_pdu_outlets_power',
group=RulespecGroupCheckParametersEnvironment,
match_type='dict',
parameter_valuespec=_valuespec_agents_sentry_pdu_outlets_power_check,
)
)