This project provides SolarNode plugin that can collect data from an external helper program that provides OS statistic information in CSV form.

The plugin can be installed via the Plugins page on your SolarNode. It appears under the Datum category as OS Statistics Data Source.

Once installed, a new OS Statistics component will appear on the Settings page on your SolarNode. Click on the Manage button to configure sources.

Each configuration contains the following overall settings:

Source ID

This value unique identifies the data collected from this device, by this node, on SolarNetwork. Each configured device should use a different value.

Statistics

This is a list of pre-determined statistic types to collect. Each one will be passed to the external helper program as an argument.

Command

The helper command that provides the statistics. This program is OS dependent but must accept a single statistic type (from the Statistics setting) and return CSV formatted data of the expected format.

This plugin will publish some OS information as node metadata, under the os property metadata key. The metadata is:

For example:

{
	"pm": {
		"os": {
			"name": "Linux",
			"arch": "arm",
			"version": "4.14.34-v7+"
		}
	}
}

Here's an example datum collected by this plugin:

{
	"created": "2018-08-13 18:25:21.014Z",
	"nodeId": 344,
	"sourceId": "OS Stats",
	"localDate": "2018-08-14",
	"localTime": "06:25",
	"cpu_idle": 98.27,
	"cpu_user": 1.59,
	"cpu_system": 0.13,
	"fs_size_/": 1887322112,
	"fs_used_/": 793722880,
	"fs_used_percent_/": 45,
	"fs_size_/run": 512094208,
	"fs_used_/run": 15802368,
	"fs_used_percent_/run": 4,
	"sys_load_1min": 0.35,
	"sys_load_5min": 0.14,
	"sys_load_15min": 0.11,
	"ram_avail": 743899136,
	"ram_total": 1024188416,
	"ram_used_percent": 27.4,
	"sys_up": 2923.77,
	"net_bytes_in_eth0": 528719,
	"net_bytes_out_eth0": 459475,
	"net_packets_in_eth0": 2312,
	"net_packets_out_eth0": 1848
}

The external helper command must support the following statistic types and return data in the following formats. The output must always include a header row before any data rows. Extra columns are allowed; they will simply be ignored.

Average CPU utilization information, inspired by sysstat. Any number of rows of data may be returned, but only the last row of data may be used.

An example output looks like:

user,system,idle
0.03,0.03,99.93

Filesystem utilization information. Each row represents a single mount point. Each property has the mount point appended to the end. For example the root mount point / would have a percentage used property named fs_used_percent_/.

An example output looks like:

mount,size-kb,used-kb,used-percent
/dev,2003748,0,0
/run,403224,12268,4
/,19880876,12383500,66
/boot,233191,36370,17

RAM utilization information.

An example output looks like:

total-kb,avail-kb
33554432,9505456

Network use information. Each row represents a single network device. Each property has the device name appended to the end. For example the WiFi device wlan0 would have a bytes out property named net_bytes_out_wlan0.

device,bytes-in,bytes-out,packets-in,packets-out
wlan0,9161,5970,86,38
lo,1242,1242,12,12
eth0,9348,10031,80,81
usb0,0,0,0,0

System load information.

An example output looks like:

1min,5min,15min
0.09,0.10,0.07

System uptime information.

An example output looks like:

up-sec
26483.63

Since version 1.1 this plugin supports custom statistic collection via arbitrary statistic names. The configured Command must support the statistic names, of course, and they must return CSV formatted data, including a header row. All returned columns will be populated as status datum properties. To populate instantaneous or accumulating properties, the column names should be prefixed with i/ and a/, respectively. The actual property name used on the datum will be stripped of this prefix. For example, if the Command supports a cpu-temp statistic that should populate an instantaneous property cpu_temp the output should be formatted like this:

i/cpu_temp
30.1