Linux Statistics Driver

An EPICS Driver to serve up Linux system and/or process specific information from an IOC.

Comparison with iocStats

This module provides a super-set for the information provided by iocStats where possible with the same record names. However unlike iocStats, this module is limited to Linux.

linStat	iocStats	Description
X	X	CPU Usage
X	X	Mem Usage
X	X	FD Usage
X		malloc() stats
X		Swap Usage
X		IP Stats.
X		NIC Stats.
X		FS Usage
	X	DB Scan stats. (TODO)

Additional information provided by linStat includes:

$(IOC):SYS_TOT_LOAD CPU usage including overheads (IRQ handling, I/O waits, ...)
IP stack statistics, host and process
Network Interface Card (NIC) statistics
File System usage

Building

Requires:

epics-base >= 7.0.8
Compiler supporting c++17 or later

git clone https://github.com/mdavidsaver/linStat
cd linStat
echo "EPICS_BASE=/path/to/epics-base" >> configure/RELEASE.local
make
# Optionally "make LINSTAT_BUILD_EXAMPLE=NO"
# to omit building linStatDemo application.

Including in an IOC

Starting from a template produced by:

makeBaseApp.pl -t ioc my
makeBaseApp.pl -t ioc -i -p myApp myioc

Edit and append configure/RELEASE (or create configure/RELEASE.local) to set the path to the built linStat tree.

LINSTAT=/path/to/linStat

Optionally edit myApp/Db/Makefile. Recommended when building with STATIC_BUILD=NO.

#  ADD MACRO DEFINITIONS AFTER THIS LINE

ifdef LINSTAT_0_0_0                                      # <----- Add
DB_INSTALLS += $(wildcard $(LINSTAT_TOP)/db/linStat*.db) # <----- Add
endif                                                    # <----- Add

Edit myApp/src/Makefile.

# ... myApp/src/Makefile
PROD_IOC += myapp
DBD += myapp.dbd
...
myapp_SRCS += myapp_registerRecordDeviceDriver.cpp
myapp_DBD += base.dbd

ifdef LINSTAT_0_0_0            # <----- Add
linStatDemo_DBD += linStat.dbd # <----- Add
linStatDemo_LIBS += linStat    # <----- Add
endif                          # <----- Add

myapp_LIBS +=  $(EPICS_BASE_IOC_LIBS)

Create/overwrite iocBoot/iocmyioc/st.cmd.

# iocBoot/iocmyioc/st.cmd
#!../../linux-x86_64/myapp

# search PATH for dbLoadRecords()
# If no DB_INSTALLS for linStat*.db, then append LINSTAT /db directory.
epicsEnvSet("EPICS_DB_INCLUDE_PATH", "$(PWD)../../db")

dbLoadDatabase("../../dbd/myapp.dbd")
myapp_registerRecordDeviceDriver(pdbbase)


# Replace "LOCALHOST" with a unique record name prefix
epicsEnvSet("IOC", "LOCALHOST")

# Optional information
#epicsEnvSet("ENGINEER", "Respectible Name")
#epicsEnvSet("LOCATION", "Where am I?")

# (un)comment some or all of the following dbLoadRecords before iocInit.

# System-wide information
dbLoadRecords("../../db/linStatHost.db","IOC=$(IOC)")

# IOC process specific information
dbLoadRecords("../../db/linStatProc.db","IOC=$(IOC)")

# Network interface information
dbLoadRecords("../../db/linStatNIC.db","IOC=$(IOC),NIC=lo")
# may repeat with different NIC= network interface name(s)
#dbLoadRecords("../../db/linStatNIC.db","IOC=$(IOC),NIC=eth0")

# File system mount point information
dbLoadRecords("../../db/linStatFS.db","P=$(IOC):ROOT,DIR=/")
# may repeat with different file system mount points
# change both P= and DIR=
#dbLoadRecords("../../db/linStatFS.db","P=$(IOC):DATA,DIR=/data")

iocInit()

TODO

OPIs
PDB
- scan tasks
  - execution time (diff time between PHAS=-32768 and PHAS=32767)
  - scan period (diff time between successive scans)
- callback pool info
- scan once info
System
Process
- Capabilities mask?
FS
NIC
- Link speed