Systeminfo Binding - wuellueb/openhab GitHub Wiki

Introduction

System information binding provides operating system monitoring data including:

  • System memory, swap, cpu, load average, uptime
  • Per-process memory, cpu
  • File system metrics
  • Network interface metrics

Binding uses Hyperic SIGAR API to access system information regardless of the underlying platform (Windows, Linux, OS X...).

For installation of the binding, please see Wiki page Bindings.

Generic Item Binding Configuration

openhab.cfg file (in the folder '${openhab_home}/configurations').

############################### Systeminfo Binding ####################################
#
# Interval in milliseconds when to find new refresh candidates
# (optional, defaults to 1000)
#systeminfo:granularity=

# Data Storage Unit, where B=Bytes, K=kB, M=MB, T=TB (optional, defaults to M)
#systeminfo:units=

Hyperic SIGAR Native libraries

The SystemInformation binding does not include SIGAR native libraries currently. The platform dependent Sigar native libraries can be found here for several platforms (see sigar-bin/lib folder). The Pre-built libraries need to be moved into the ${openhabhome]/lib folder. ARM-based devices, such as Raspberry PI require manual setup. See discussion.

Item Binding Configuration

In order to bind an item to the device, you need to provide configuration settings. The easiest way to do so is to add some binding information in your item file (in the folder configurations/items). The syntax of the binding configuration strings accepted is the following:

systeminfo="<commandType>:<refreshPeriod>(<target>)"

Where

<commandType> corresponds to the command type. See complete list below. Note that the output of some commands (eg. DirUsage) will be affected by filesystem permissions. ie. Directories that the process is not permitted access to cannot be include in the tally.

<refreshPeriod> corresponds to the update interval of the item in milliseconds.

<target> corresponds to the target of the command. Target field is mandatory only for commands, which need target. See further details from supported command list below.

List of supported commands (commandType)

Command Item Type Purpose Note
LoadAverage1Min Number
LoadAverage5Min Number
LoadAverage15Min Number
CpuCombined Number
CpuUser Number
CpuSystem Number
CpuNice Number
CpuWait Number
Uptime Number
UptimeFormatted String
MemFree Number
MemFreePercent Number
MemUsed Number
MemUsedPercent Number
MemActualFree Number
MemActualUsed Number
MemTotal Number
SwapFree Number
SwapTotal Number
SwapUsed Number
SwapPageIn Number
SwapPageOut Number
NetTxBytes Number target = net interface name (1
NetRxBytes Number target = net interface name (1
DiskReads Number target = disk name (2
DiskWrites Number target = disk name (2
DiskReadBytes Number target = disk name (2
DiskWriteBytes Number target = disk name (2
DirUsage Number target = directory path (if folder contains lot of files scan can take a while!)
DirFiles Number target = directory path (if folder contains lot of files scan can take a while!)
ProcessRealMem Number target = process name (3
ProcessVirtualMem Number target = process name (3
ProcessCpuPercent Number target = process name (3
ProcessCpuSystem Number target = process name (3
ProcessCpuUser Number target = process name (3
ProcessCpuTotal Number target = process name (3
ProcessUptime Number target = process name (3
ProcessUptimeFormatted String target = process name (3
ProcessCpuPercent Number target = process name (3

(1 interface name: Check supported interface names by ifconfig, ipconfig or openhab debug log E.g. "21:56:12.930 DEBUG o.o.b.s.internal.SysteminfoBinding[- valid net interfaces: lo0, en0, en1, p2p0, vboxnet0

(2 disk name: Check supported disk names by iostat or openhab debug log "21:56:12.931 DEBUG o.o.b.s.internal.SysteminfoBinding[- valid disk names: /dev/disk0s2"

(3 process name supports:

Usage Example Explanatory
$$ $$ current process
processname eclipse process name contains "eclipse"
`**`processname `**`eclipse process name ends to "eclipse"
processname`**` eclipse`**` process name start with "eclipse"
=processname =eclipse process name equals "eclipse"
#PTQL #State.Name.eq=eclipse Sigar Process Table Query Language (see https://support.hyperic.com/display/SIGAR/PTQL)

Examples, how to configure your items:

Group System
Number loadAverage1min  "Load avg. 1min [%.1f]" (System) { systeminfo="LoadAverage1Min:5000" }
Number loadAverage5min  "Load avg. 5min [%.1f]" (System) { systeminfo="LoadAverage5Min:5000" }
Number loadAverage15min "Load avg. 15min [%.1f]"    (System) { systeminfo="LoadAverage15Min:5000" }

Number cpuCompined  "CPU combined [%.1f]"   (System) { systeminfo="CpuCombined:5000" }
Number cpuUser  "CPU user [%.1f]"   (System) { systeminfo="CpuUser:5000" }
Number cpuSystem    "CPU system [%.1f]" (System) { systeminfo="CpuSystem:5000" }
Number cpuNice  "CPU nice [%.1f]"   (System) { systeminfo="CpuNice:5000" }
Number cpuWait "CPU wait [%.1f]"    (System) { systeminfo="CpuWait:5000" }

Number uptime   "Uptime [%.1f]" (System) { systeminfo="Uptime:5000" }
String uptimeFormatted  "Update formatted [%s]" (System) { systeminfo="UptimeFormatted:5000" }

Number memFreePercentPeriod "MemFree chart selected [%.1f]" (System)
Number memFreePercent   	"Mem free [%.1f%%]" (System) { systeminfo="MemFreePercent:5000" }
Number memUsed  			"Mem used [%.1f]"   (System) { systeminfo="MemUsed:5000" }
Number memUsedPercent   	"Mem used [%.1f%%]" (System) { systeminfo="MemUsedPercent:5000" }
Number memActualFree    	"Mem actual free [%.1f]"    (System) { systeminfo="MemActualFree:5000" }
Number memActualUsed    	"Mem actual used [%.1f]"    (System) { systeminfo="MemActualUsed:5000" }
Number memTotal 			"Mem total [%.1f]"  (System) { systeminfo="MemTotal:5000" }

Number swapFree "Swap free [%.1f]"  (System) { systeminfo="SwapFree:5000" }
Number swapTotal    "Swap total [%.1f]" (System) { systeminfo="SwapTotal:5000" }
Number swapUsed "Swap used [%.1f]"  (System) { systeminfo="SwapUsed:5000" }
Number swapPageIn   "Swap pagein [%.1f]"    (System) { systeminfo="SwapPageIn:5000" }
Number swapPageOut  "Swap pageout [%.1f]"   (System) { systeminfo="SwapPageOut:5000" }

Number netTxBytes   "Next tx bytes [%.1f]"  (System) { systeminfo="NetTxBytes:5000:en1" }
Number netRxBytes   "Next rx bytes [%.1f]"  (System) { systeminfo="NetRxBytes:5000:en1" }

Number diskReads    "Disk reads [%.1f]" (System) { systeminfo="DiskReads:5000:/dev/disk1" }
Number diskWrites   "Disk writes [%.1f]"    (System) { systeminfo="DiskWrites:5000:/dev/disk1" }
Number diskReadBytes    "Disk read bytes [%.1f]"    (System) { systeminfo="DiskReadBytes:5000:/dev/disk1" }
Number diskWriteBytes   "Disk write bytes [%.1f]"   (System) { systeminfo="DiskWriteBytes:5000:/dev/disk1" }

Number dirUsage "Dir usage [%.1f]"  (System) { systeminfo="DirUsage:5000:/Users/foo" }
Number dirFiles "Dir files [%.1f]"  (System) { systeminfo="DirFiles:5000:/Users/foo" }

Number openhabRealMem   "Real mem [%.1f]"   (System) { systeminfo="ProcessRealMem:5000:$$" }
Number openhabVirtualMem    "Virtual mem [%.1f]"    (System) { systeminfo="ProcessVirtualMem:5000:$$" }
Number openhabCpuPercent    "Cpu percent [%.1f%%]"  (System) { systeminfo="ProcessCpuPercent:5000:$$" }
Number openhabCpuSystem "CPU system [%.1f]" (System) { systeminfo="ProcessCpuSystem:5000:$$" }
Number openhabCpuUser   "CPU user [%.1f]"   (System) { systeminfo="ProcessCpuUser:5000:$$" }
Number openhabCpuTotal  "CPU total [%.1f]"  (System) { systeminfo="ProcessCpuTotal:5000:$$" }
Number openhabUptime    "Uptime [%d]"   (System) { systeminfo="ProcessUptime:5000:$$" }
String openhabUptimeFormatted   "Uptime form. [%s]" (System) { systeminfo="ProcessUptimeFormatted:5000:$$" }

Number eclipseRealMem1  "Real mem1 [%.1f]"  (System) { systeminfo="<ProcessCpuPercent:10000:eclipse" }
Number eclipseRealMem2  "Real mem2 [%.1f]"  (System) { systeminfo="<ProcessCpuPercent:10000:*eclipse" }
Number eclipseRealMem3  "Real mem3 [%.1f]"  (System)  { systeminfo="<ProcessCpuPercent:10000:eclipse*" }
Number eclipseRealMem4  "Real mem4 [%.1f]"  (System) { systeminfo="<ProcessCpuPercent:10000:=eclipse" }
Number eclipseRealMem5  "Real mem5 [%.1f]"  (System) { systeminfo="<ProcessCpuPercent:10000:#State.Name.eq=eclipse"

Examples, how to configure your sitemap:

Frame {
	Group item=System label="System Info" icon="system" {
		Frame {
			Text item=uptime
			Text item=cpuCombined icon="system"
		}
		
		Frame label="Load" {
			Text item=loadAverage1min
			Text item=loadAverage5min
			Text item=loadAverage15min
		}
		Frame label="Memory" {
			Text item=memFreePercent  {
				Frame {
					Switch item=memFreePercentPeriod label="Periode" mappings=[0="Time", 1="Dag", 2="Uke"]
					Chart item=memFreePercent period=h refresh=30000 visibility=[memFreePercentPeriod==0, memFreePercentPeriod=="Uninitialized"]
					Chart item=memFreePercent period=D refresh=30000 visibility=[memFreePercentPeriod==1]
					Chart item=memFreePercent period=W refresh=30000 visibility=[memFreePercentPeriod==2]
				}
			}
			Text item=memUsed 
			Text item=memUsedPercent
			Text item=memActualFree 
			Text item=memActualUsed 
			Text item=memTotal 
		}
		
		Frame label="Swap" {
			Text item=swapFree 
			Text item=swapTotal
			Text item=swapUsed 
		}
		
		Frame label="Openhab" {
			Text item=openhabRealMem
			Text item=openhabVirtualMem
			Text item=openhabCpuPercent
			Text item=openhabCpuSystem
			Text item=openhabUptime
			Text item=openhabUptimeFormatted
		}
	}
}
Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️