2017-12-07 15:48:45 -06:00
|
|
|
source: Support/Device-Sensors.md
|
2018-10-27 23:04:34 +01:00
|
|
|
path: blob/master/doc/
|
2017-12-07 15:48:45 -06:00
|
|
|
|
2019-07-18 21:25:53 -05:00
|
|
|
# Device Sensors
|
2017-12-07 15:48:45 -06:00
|
|
|
|
2019-07-18 21:25:53 -05:00
|
|
|
LibreNMS has a standard for device sensors they are split into
|
|
|
|
categories. This doc is to help users understand device sensors in
|
|
|
|
general, if you need help with developing sensors for a device please
|
|
|
|
see the Contributing + Developing section.
|
2017-12-07 15:48:45 -06:00
|
|
|
|
2019-07-18 21:25:53 -05:00
|
|
|
## Health Sensors
|
2017-12-07 15:48:45 -06:00
|
|
|
|
2019-07-18 21:25:53 -05:00
|
|
|
The High and Low values of these sensors can be edited in Web UI by
|
|
|
|
going to the device settings -> Health. There you can set your own
|
|
|
|
custom High and Low values. List of these sensors can be found here
|
|
|
|
[Link](../Developing/os/Health-Information.md)
|
2017-12-07 15:48:45 -06:00
|
|
|
|
2019-07-18 21:25:53 -05:00
|
|
|
**Note** Some values are defined by the manufactures and others are
|
|
|
|
auto calculated when you add the device into librenms. Keep in mind
|
|
|
|
every environment is different and may require user input.
|
2017-12-07 15:48:45 -06:00
|
|
|
|
2019-07-18 21:25:53 -05:00
|
|
|
## Wireless Sensors
|
2017-12-07 15:48:45 -06:00
|
|
|
|
2019-07-18 21:25:53 -05:00
|
|
|
Some Wireless have High and Low values of these sensors can be edited
|
|
|
|
in Web UI by going to the device settings -> Wireless Sensors There
|
|
|
|
you can set your own custom High and Low values. List of these sensors
|
|
|
|
can be found here [Link](../Developing/os/Wireless-Sensors.md)
|
2017-12-07 15:48:45 -06:00
|
|
|
|
2019-07-18 21:25:53 -05:00
|
|
|
**Note** Some values are defined by the manufactures and others are
|
|
|
|
auto calculated when you add the device into librenms. Keep in mind
|
|
|
|
every environment is different and may require user input.
|
2017-12-07 15:48:45 -06:00
|
|
|
|
2019-07-18 21:25:53 -05:00
|
|
|
## State Sensors
|
2017-12-07 15:48:45 -06:00
|
|
|
|
2019-07-18 21:25:53 -05:00
|
|
|
Return states of device entries sensors states. For example.
|
2017-12-07 15:48:45 -06:00
|
|
|
|
2019-07-18 21:25:53 -05:00
|
|
|
Drive Status, Memory Status, Power Supply Status.
|
2017-12-07 15:48:45 -06:00
|
|
|
|
|
|
|
```
|
|
|
|
0 = OK
|
|
|
|
1 = Warning
|
|
|
|
2 = Critical
|
|
|
|
3 = Unknown
|
2017-12-07 18:09:41 -06:00
|
|
|
```
|
2017-12-07 15:48:45 -06:00
|
|
|
|
2019-07-18 21:25:53 -05:00
|
|
|
## Alerting Sensors
|
2017-12-07 15:48:45 -06:00
|
|
|
|
2019-07-18 21:25:53 -05:00
|
|
|
These alert rules can be found inside the Alert Rules Collection. The
|
|
|
|
alert rules below are the default alert rules, there are more
|
|
|
|
device-specific alert rules in the alerts collection.
|
2017-12-07 15:48:45 -06:00
|
|
|
|
2019-07-18 21:25:53 -05:00
|
|
|
**Sensor Over Limit Alert Rule:** Will alert on any sensor value that
|
|
|
|
is over the limit.
|
2017-12-07 15:48:45 -06:00
|
|
|
|
2019-07-18 21:25:53 -05:00
|
|
|
**Sensor Under Limit Alert Rule:** Will alert on any sensor value that
|
|
|
|
is under the limit.
|
2017-12-07 15:48:45 -06:00
|
|
|
|
|
|
|
**Remember** you can set these limits inside device settings in the Web UI.
|
|
|
|
|
2017-12-07 18:09:41 -06:00
|
|
|
**State Sensor Critical:** Will alert on any state that returns critical = 2
|
2017-12-07 15:48:45 -06:00
|
|
|
|
2017-12-07 18:09:41 -06:00
|
|
|
**State Sensor Warning:** Will alert on any state that returns warning = 1
|
2018-02-11 16:18:49 -06:00
|
|
|
|
2019-07-18 21:25:53 -05:00
|
|
|
**Wireless Sensor Over Limit Alert Rule:** Will Alert on sensors that
|
|
|
|
listed in device settings under Wireless.
|
2018-02-11 16:18:49 -06:00
|
|
|
|
2019-07-18 21:25:53 -05:00
|
|
|
**Wireless Sensor Under Limit Alert Rule:** Will Alert on sensors that
|
|
|
|
listed in device settings under Wireless.
|