Hardware(sensor) monitoring

NetXMS has subagents that allow to monitor hardware sensors.

lm-sensors - Can collect data from all sensors that are supported by lm-sensors drivers on Linux.
DS18x20 - This subagent collects temperature data from ds18x20 sensors. Linux only.
RPI - This subagent is created for Raspberry Pi. It can collect data from DHT22 sensor and get the status of any GPIO pin.

lm-sensors

This subagent can be used to read hardware status using the lm_sensors package.

Pre-requisites

The package lm_sensors should be installed and configured properly. The output of the sensors command should produce meaningful output (see example below).

alk@b08s02ur:~$ sensors
w83627dhg-isa-0290
Adapter: ISA adapter
Vcore:       +1.14 V  (min =  +0.00 V, max =  +1.74 V)
in1:         +1.61 V  (min =  +0.05 V, max =  +0.01 V)   ALARM
AVCC:        +3.31 V  (min =  +2.98 V, max =  +3.63 V)
VCC:         +3.31 V  (min =  +2.98 V, max =  +3.63 V)
in4:         +1.79 V  (min =  +1.29 V, max =  +0.05 V)   ALARM
in5:         +1.26 V  (min =  +0.05 V, max =  +1.67 V)
in6:         +0.10 V  (min =  +0.26 V, max =  +0.08 V)   ALARM
3VSB:        +3.30 V  (min =  +2.98 V, max =  +3.63 V)
Vbat:        +3.18 V  (min =  +2.70 V, max =  +3.30 V)
fan1:       3308 RPM  (min = 1188 RPM, div = 8)
fan2:       6250 RPM  (min = 84375 RPM, div = 8)  ALARM
fan3:          0 RPM  (min = 5273 RPM, div = 128)  ALARM
fan4:          0 RPM  (min = 10546 RPM, div = 128)  ALARM
fan5:          0 RPM  (min = 10546 RPM, div = 128)  ALARM
temp1:       +39.0°C  (high =  +4.0°C, hyst =  +1.0°C)  ALARM  sensor = diode
temp2:       +17.0°C  (high = +80.0°C, hyst = +75.0°C)  sensor = diode
temp3:      +124.5°C  (high = +80.0°C, hyst = +75.0°C)  ALARM  sensor = thermistor
cpu0_vid:   +2.050 V

coretemp-isa-0000
Adapter: ISA adapter
Core 0:      +37.0°C  (high = +76.0°C, crit = +100.0°C)

coretemp-isa-0001
Adapter: ISA adapter
Core 1:      +37.0°C  (high = +76.0°C, crit = +100.0°C)

Parameters

When loaded, the lm_sensors subagent adds the following metrics:

Metric	Description
LMSensors.Value(chip, label)	Current value returned by hardware sensor

Configuration file

All configuration parameters related to lthe m_sensors subagent should be placed into the *LMSENSORS section of agent’s configuration file. The following configuration parameters are supported:

Parameter	Format	Description	Default value
UseFahrenheit	Boolean	If set to “yes”, all temperature reading will be converted to Fahrenheit	no
ConfigFile	String	Path to sensors.conf	none, use system default (usually /etc/sensors3.conf)

Configuration example

MasterServers = netxms.demo
SubAgent = lmsensors.nsm

[LMSENSORS]
UseFahrenheit = yes
ConfigFile = /etc/sensors.netxms.conf

Sample usage

(based on output of “sensors” from Pre-requisites section)

alk@b08s02ur:~$ nxget netxms.demo 'LMSensors.Value(coretemp-isa-0001,Core 1)'
38.000000
alk@b08s02ur:~$ nxget netxms.demo 'LMSensors.Value(w83627dhg-isa-0290,AVCC)'
3.312000

DS18x20

This subagent collects temperature from DS18x20 sensor. Subagent available for Linux only. To use this subagent the 1-Wire driver should be installed.

Metrics

Metric	Type	Meaning
Sensor.Temperature(*)	Float	Sensor temperature

Configuration file

All configuration parameters related to the lm_sensors subagent should be placed into the *DS18X20 section of the configuration file of the agent. The following configuration parameters are supported:

Parameter	Format	Description
Sensor	String	Sensor identification in format sensorName:uniqueID

Configuration example

MasterServers = netxms.demo
SubAgent = DS18X20.nsm

[DS18X20]
Sensor = sensorName:uiniqueID123456788990

RPI

This subagent collects data from the Raspberry Pi DHT22 sensor as well as the status of GPIO pins.

Metrics

Metric	Type	Meaning
GPIO.PinState(pinNumber)	Integer	State of pin with given number. This pin number should be enabled in the agent configuration file.
Sensors.Humidity	Integer	Sensors data for humidity
Sensors.Temperature	Integer	Sensors data for temperature

Configuration file

All configuration parameters related to the lm_sensors subagent should be placed into the *RPI section of the configuration file of the agent. The following configuration parameters are supported:

Parameter	Format	Description
DisableDHT22	Boolean	Disables dht22 sensor if `yes`. By default `no`.
EnabledPins	Comma separated list of numbers	List of pins that are enabled for status check.

Configuration example

MasterServers = netxms.demo
SubAgent = rpi.nsm

[RPI]
DisableDHT22 = no
EnabledPins = 1,4,5,8

MQTT

This is a subagent that can be used to collect data from devices and sensors that use the MQTT protocol for communication. The subagent can be used to connect to existing MQTT brokers, listen to user specified topics, map posted data to metrics and generate events.

There are two ways how to set up data collection for MQTT.

One approach is to specify an MQTT topic - agent metric mapping in agent configuration file. In this case DCIs are created with origin NetXMS Agent.

The other approach is to use the MQTT origin in DCI properties. The metric has the following format broker_name:mqtt_topic, where broker_name is name specified in the agent configuration file. The Agent which performs MQTT data collection is selected automatically. If the node is in a zone, the zone proxy is used. If a MQTT proxy is specified in the node properties, that will be used. With this approach there is no need to specify metrics in the agent configuration file - when the server requests mqtt topic for the first time, the agent subscribes to that topic.

Configuration file

These are configuration sections and parameters for the MQTT subagent:

Section	Parameters	Format	Description
[MQTT/Brokers/broker_name]	Hostname, Port, Login, Password	String	This section holds the data needed to connect to the MQTT broker
[MQTT/Brokers/broker_name/Events]	`EVENT_NAME`	String	This section is optional and allows to specify event that would be generated when MQTT topic gets new value
[MQTT/Brokers/broker_name/Metrics]	`Metric.Name`	Dot separated string	This section is optional and sets mapping of data posted to MQTT topics to agent metrics

Configuration example

      SubAgent = mqtt.nsm

[MQTT/Brokers/Local]
Hostname = 10.10.10.3

Configuration example with metric and event configuration

SubAgent = mqtt.nsm

[MQTT/Brokers/Office]
Hostname = mqtt.office.radensolutions.com

[MQTT/Brokers/Office/Events]
MQTT_METERHUB_RAW_DATA = "cmnd/5C:CF:7F:25:79:D6/#"

[MQTT/Brokers/Office/Metrics]
MeterHub.Telemetry.RSSI = "tele/5C:CF:7F:25:79:D6/RSSI"
MeterHub.Telemetry.Time = "tele/5C:CF:7F:25:79:D6/TIME"

This configuration will connect to an MQTT broker Office at the Hostname. Whenever data is published to the topic cmnd/5C:CF:7F:25:79:D6/#, the event MQTT_METERHUB_RAW_DATA will be triggered. It will also provide two metrics, MeterHub.Telemetry.RSSI and MeterHub.Telemetry.Time which will report data received on the topics tele/5C:CF:7F:25:79:D6/RSSI and tele/5C:CF:7F:25:79:D6/TIME respectively.