librenms/tests/data/ciscosat.json
Martijn Schmidt 048fd0f6ed Remove guessed limits for some health sensors, documentation for sensor classes (#10327)
* Default to null for group yaml discovery.

* Update test data for a154bda yaml group null fix.

* Changes to guessed limit functions for sensors.

Original behaviour
===================

The file `includes/discovery/functions.inc.php` contains
`sensor_limit_low()` and `sensor_limit()` which both attempt to
guess a sane value for sensors when no explicitly defined
low_limit or high_limit can be found during discovery.

Both switch control structures used in those two functions
have empty case statements which means that if one of those matches,
it's going to fall through and run the code for each subsequent
case until a `break` is reached.

For example, when we call `function sensor_low_limit(dbm, -13.036)`
it will return the value `-12.3842` instead of `null`. That is
because there will be a match at `case 'dbm':` which falls through
all the way to `case 'cooling':`, where it performs
`$limit = -13.036 * 0.95` before hitting a `break`.

Changed behaviour
===================

Removed `power_consumed` and `count` guessed low_limit and
high_limit, I personally added those sensor classes in PR #9471
when I didn't understand that a switch control structure has
fall-through behaviour so I can guarantee that guessing limits for
those is a mistake on my behalf. It should not be there, only
power_factor can have guessed limits. Apologies for the issue,
I'm still a beginning programmer!

Furthermore, I removed guessed high_limit values for `current`
and `power` because these are supposed to draw higher values as
more devices or components are installed on for example a PDU or
a chassis.

Finally, I removed guessed low_limit and high_limit for `dbm`
sensors, there is a much too large variance in power budget on
commercially available optical transceivers for there to be a
sensible window where you can guess these values.

* Documentation on adding sensor classes.

* Update test data - sensor limit changes @ 30212d2
2019-06-21 09:03:27 -05:00

448 lines
18 KiB
JSON

{
"os": {
"discovery": {
"devices": [
{
"sysName": "<private>",
"sysObjectID": ".1.3.6.1.4.1.1429.2.2.6.5",
"sysDescr": "D9854 APR",
"sysContact": null,
"version": null,
"hardware": null,
"features": null,
"os": "ciscosat",
"type": "network",
"serial": null,
"icon": "cisco.svg",
"location": null
}
]
},
"poller": {
"devices": [
{
"sysName": "<private>",
"sysObjectID": ".1.3.6.1.4.1.1429.2.2.6.5",
"sysDescr": "D9854 APR",
"sysContact": "<private>",
"version": "1.50(1.11)",
"hardware": "D9859",
"features": null,
"os": "ciscosat",
"type": "network",
"serial": "<private>",
"icon": "cisco.svg",
"location": "<private>"
}
]
}
},
"sensors": {
"discovery": {
"sensors": [
{
"sensor_deleted": 0,
"sensor_class": "fanspeed",
"poller_type": "snmp",
"sensor_oid": ".1.3.6.1.4.1.1429.2.2.5.18.2.2.1.3.1",
"sensor_index": "diagFanRPMValue.1",
"sensor_type": "ciscosat",
"sensor_descr": "Fan Speed 1",
"group": null,
"sensor_divisor": 1,
"sensor_multiplier": 1,
"sensor_current": 4920,
"sensor_limit": 8856,
"sensor_limit_warn": null,
"sensor_limit_low": 3936,
"sensor_limit_low_warn": null,
"sensor_alert": 1,
"sensor_custom": "No",
"entPhysicalIndex": null,
"entPhysicalIndex_measured": null,
"sensor_prev": null,
"user_func": null,
"state_name": null
},
{
"sensor_deleted": 0,
"sensor_class": "fanspeed",
"poller_type": "snmp",
"sensor_oid": ".1.3.6.1.4.1.1429.2.2.5.18.2.2.1.3.2",
"sensor_index": "diagFanRPMValue.2",
"sensor_type": "ciscosat",
"sensor_descr": "Fan Speed 2",
"group": null,
"sensor_divisor": 1,
"sensor_multiplier": 1,
"sensor_current": 4860,
"sensor_limit": 8748,
"sensor_limit_warn": null,
"sensor_limit_low": 3888,
"sensor_limit_low_warn": null,
"sensor_alert": 1,
"sensor_custom": "No",
"entPhysicalIndex": null,
"entPhysicalIndex_measured": null,
"sensor_prev": null,
"user_func": null,
"state_name": null
},
{
"sensor_deleted": 0,
"sensor_class": "fanspeed",
"poller_type": "snmp",
"sensor_oid": ".1.3.6.1.4.1.1429.2.2.5.18.2.2.1.3.3",
"sensor_index": "diagFanRPMValue.3",
"sensor_type": "ciscosat",
"sensor_descr": "Fan Speed 3",
"group": null,
"sensor_divisor": 1,
"sensor_multiplier": 1,
"sensor_current": 5100,
"sensor_limit": 9180,
"sensor_limit_warn": null,
"sensor_limit_low": 4080,
"sensor_limit_low_warn": null,
"sensor_alert": 1,
"sensor_custom": "No",
"entPhysicalIndex": null,
"entPhysicalIndex_measured": null,
"sensor_prev": null,
"user_func": null,
"state_name": null
},
{
"sensor_deleted": 0,
"sensor_class": "fanspeed",
"poller_type": "snmp",
"sensor_oid": ".1.3.6.1.4.1.1429.2.2.5.18.2.2.1.3.4",
"sensor_index": "diagFanRPMValue.4",
"sensor_type": "ciscosat",
"sensor_descr": "Fan Speed 4",
"group": null,
"sensor_divisor": 1,
"sensor_multiplier": 1,
"sensor_current": 4860,
"sensor_limit": 8748,
"sensor_limit_warn": null,
"sensor_limit_low": 3888,
"sensor_limit_low_warn": null,
"sensor_alert": 1,
"sensor_custom": "No",
"entPhysicalIndex": null,
"entPhysicalIndex_measured": null,
"sensor_prev": null,
"user_func": null,
"state_name": null
},
{
"sensor_deleted": 0,
"sensor_class": "fanspeed",
"poller_type": "snmp",
"sensor_oid": ".1.3.6.1.4.1.1429.2.2.5.18.2.2.1.3.5",
"sensor_index": "diagFanRPMValue.5",
"sensor_type": "ciscosat",
"sensor_descr": "Fan Speed 5",
"group": null,
"sensor_divisor": 1,
"sensor_multiplier": 1,
"sensor_current": 5100,
"sensor_limit": 9180,
"sensor_limit_warn": null,
"sensor_limit_low": 4080,
"sensor_limit_low_warn": null,
"sensor_alert": 1,
"sensor_custom": "No",
"entPhysicalIndex": null,
"entPhysicalIndex_measured": null,
"sensor_prev": null,
"user_func": null,
"state_name": null
},
{
"sensor_deleted": 0,
"sensor_class": "fanspeed",
"poller_type": "snmp",
"sensor_oid": ".1.3.6.1.4.1.1429.2.2.5.18.2.2.1.3.6",
"sensor_index": "diagFanRPMValue.6",
"sensor_type": "ciscosat",
"sensor_descr": "Fan Speed 6",
"group": null,
"sensor_divisor": 1,
"sensor_multiplier": 1,
"sensor_current": 4800,
"sensor_limit": 8640,
"sensor_limit_warn": null,
"sensor_limit_low": 3840,
"sensor_limit_low_warn": null,
"sensor_alert": 1,
"sensor_custom": "No",
"entPhysicalIndex": null,
"entPhysicalIndex_measured": null,
"sensor_prev": null,
"user_func": null,
"state_name": null
},
{
"sensor_deleted": 0,
"sensor_class": "fanspeed",
"poller_type": "snmp",
"sensor_oid": ".1.3.6.1.4.1.1429.2.2.5.18.2.2.1.3.7",
"sensor_index": "diagFanRPMValue.7",
"sensor_type": "ciscosat",
"sensor_descr": "Fan Speed 7",
"group": null,
"sensor_divisor": 1,
"sensor_multiplier": 1,
"sensor_current": 4980,
"sensor_limit": 8964,
"sensor_limit_warn": null,
"sensor_limit_low": 3984,
"sensor_limit_low_warn": null,
"sensor_alert": 1,
"sensor_custom": "No",
"entPhysicalIndex": null,
"entPhysicalIndex_measured": null,
"sensor_prev": null,
"user_func": null,
"state_name": null
},
{
"sensor_deleted": 0,
"sensor_class": "state",
"poller_type": "snmp",
"sensor_oid": ".1.3.6.1.4.1.1429.2.2.5.5.3.2.1.3.1",
"sensor_index": "inputStatusSatLock.1",
"sensor_type": "inputStatusSatLock",
"sensor_descr": "Sat Lock 1",
"group": null,
"sensor_divisor": 1,
"sensor_multiplier": 1,
"sensor_current": 3,
"sensor_limit": null,
"sensor_limit_warn": null,
"sensor_limit_low": null,
"sensor_limit_low_warn": null,
"sensor_alert": 1,
"sensor_custom": "No",
"entPhysicalIndex": null,
"entPhysicalIndex_measured": null,
"sensor_prev": null,
"user_func": null,
"state_name": "inputStatusSatLock"
}
],
"state_indexes": [
{
"state_name": "inputStatusSatLock",
"state_descr": "null",
"state_draw_graph": 0,
"state_value": -1,
"state_generic_value": 3
},
{
"state_name": "inputStatusSatLock",
"state_descr": "No Lock",
"state_draw_graph": 1,
"state_value": 1,
"state_generic_value": 2
},
{
"state_name": "inputStatusSatLock",
"state_descr": "Lock - Signal",
"state_draw_graph": 1,
"state_value": 2,
"state_generic_value": 1
},
{
"state_name": "inputStatusSatLock",
"state_descr": "Lock + Signal",
"state_draw_graph": 1,
"state_value": 3,
"state_generic_value": 0
}
]
},
"poller": "matches discovery"
},
"wireless": {
"discovery": {
"wireless_sensors": [
{
"sensor_deleted": 0,
"sensor_class": "snr",
"sensor_index": "1",
"sensor_type": "ciscosat-cn-margin",
"sensor_descr": "C/N Link Margin 1",
"sensor_divisor": 1,
"sensor_multiplier": 1,
"sensor_aggregator": "sum",
"sensor_current": 1.6,
"sensor_prev": null,
"sensor_limit": null,
"sensor_limit_warn": null,
"sensor_limit_low": null,
"sensor_limit_low_warn": null,
"sensor_alert": 1,
"sensor_custom": "No",
"entPhysicalIndex": null,
"entPhysicalIndex_measured": null,
"sensor_oids": "[\".1.3.6.1.4.1.1429.2.2.5.5.3.1.1.6.1\"]"
},
{
"sensor_deleted": 0,
"sensor_class": "snr",
"sensor_index": "1",
"sensor_type": "ciscosat-cn-ratio",
"sensor_descr": "C/N Ratio 1",
"sensor_divisor": 1,
"sensor_multiplier": 1,
"sensor_aggregator": "sum",
"sensor_current": 10,
"sensor_prev": null,
"sensor_limit": null,
"sensor_limit_warn": null,
"sensor_limit_low": null,
"sensor_limit_low_warn": null,
"sensor_alert": 1,
"sensor_custom": "No",
"entPhysicalIndex": null,
"entPhysicalIndex_measured": null,
"sensor_oids": "[\".1.3.6.1.4.1.1429.2.2.5.5.3.1.1.5.1\"]"
},
{
"sensor_deleted": 0,
"sensor_class": "rssi",
"sensor_index": "1",
"sensor_type": "ciscosat",
"sensor_descr": "Receive Signal Level 1",
"sensor_divisor": 1,
"sensor_multiplier": 1,
"sensor_aggregator": "sum",
"sensor_current": -40,
"sensor_prev": null,
"sensor_limit": null,
"sensor_limit_warn": null,
"sensor_limit_low": null,
"sensor_limit_low_warn": null,
"sensor_alert": 1,
"sensor_custom": "No",
"entPhysicalIndex": null,
"entPhysicalIndex_measured": null,
"sensor_oids": "[\".1.3.6.1.4.1.1429.2.2.5.5.3.1.1.7.1\"]"
},
{
"sensor_deleted": 0,
"sensor_class": "errors",
"sensor_index": "1",
"sensor_type": "ciscosat",
"sensor_descr": "Uncorrected Errors 1",
"sensor_divisor": 1,
"sensor_multiplier": 1,
"sensor_aggregator": "sum",
"sensor_current": 42277,
"sensor_prev": null,
"sensor_limit": null,
"sensor_limit_warn": null,
"sensor_limit_low": null,
"sensor_limit_low_warn": null,
"sensor_alert": 1,
"sensor_custom": "No",
"entPhysicalIndex": null,
"entPhysicalIndex_measured": null,
"sensor_oids": "[\".1.3.6.1.4.1.1429.2.2.5.5.3.1.1.12.1\"]"
}
]
},
"poller": {
"wireless_sensors": [
{
"sensor_deleted": 0,
"sensor_class": "snr",
"sensor_index": "1",
"sensor_type": "ciscosat-cn-margin",
"sensor_descr": "C/N Link Margin 1",
"sensor_divisor": 1,
"sensor_multiplier": 1,
"sensor_aggregator": "sum",
"sensor_current": 1.6,
"sensor_prev": 1.6,
"sensor_limit": null,
"sensor_limit_warn": null,
"sensor_limit_low": null,
"sensor_limit_low_warn": null,
"sensor_alert": 1,
"sensor_custom": "No",
"entPhysicalIndex": null,
"entPhysicalIndex_measured": null,
"sensor_oids": "[\".1.3.6.1.4.1.1429.2.2.5.5.3.1.1.6.1\"]"
},
{
"sensor_deleted": 0,
"sensor_class": "snr",
"sensor_index": "1",
"sensor_type": "ciscosat-cn-ratio",
"sensor_descr": "C/N Ratio 1",
"sensor_divisor": 1,
"sensor_multiplier": 1,
"sensor_aggregator": "sum",
"sensor_current": 10,
"sensor_prev": 10,
"sensor_limit": null,
"sensor_limit_warn": null,
"sensor_limit_low": null,
"sensor_limit_low_warn": null,
"sensor_alert": 1,
"sensor_custom": "No",
"entPhysicalIndex": null,
"entPhysicalIndex_measured": null,
"sensor_oids": "[\".1.3.6.1.4.1.1429.2.2.5.5.3.1.1.5.1\"]"
},
{
"sensor_deleted": 0,
"sensor_class": "rssi",
"sensor_index": "1",
"sensor_type": "ciscosat",
"sensor_descr": "Receive Signal Level 1",
"sensor_divisor": 1,
"sensor_multiplier": 1,
"sensor_aggregator": "sum",
"sensor_current": -40,
"sensor_prev": -40,
"sensor_limit": null,
"sensor_limit_warn": null,
"sensor_limit_low": null,
"sensor_limit_low_warn": null,
"sensor_alert": 1,
"sensor_custom": "No",
"entPhysicalIndex": null,
"entPhysicalIndex_measured": null,
"sensor_oids": "[\".1.3.6.1.4.1.1429.2.2.5.5.3.1.1.7.1\"]"
},
{
"sensor_deleted": 0,
"sensor_class": "errors",
"sensor_index": "1",
"sensor_type": "ciscosat",
"sensor_descr": "Uncorrected Errors 1",
"sensor_divisor": 1,
"sensor_multiplier": 1,
"sensor_aggregator": "sum",
"sensor_current": 42277,
"sensor_prev": 42277,
"sensor_limit": null,
"sensor_limit_warn": null,
"sensor_limit_low": null,
"sensor_limit_low_warn": null,
"sensor_alert": 1,
"sensor_custom": "No",
"entPhysicalIndex": null,
"entPhysicalIndex_measured": null,
"sensor_oids": "[\".1.3.6.1.4.1.1429.2.2.5.5.3.1.1.12.1\"]"
}
]
}
}
}