EfiMon: An agnostic efficiency monitor library

Easy-To-Use Linux Power and Resource Consumption Monitoring Library and Daemon. Monitors CPU, GPU, RAM, I/O, Network and the overall system.

Installation

This library uses meson as the building system. To install meson, Python >= 3.8 is required. Please, check the following instructions according to your needs:

• Python and PIP

# Ubuntu
sudo apt install python3 python3-pip

• Ninja Build

# Ubuntu
sudo apt install ninja-build

• Meson

sudo pip3 install meson

Dependencies

First, it is important to recall that this is a Linux library. It requires the following dependencies:

• libprocps
• sqlite3 >= 3.31.1
• Linux Perf
• Intel RAPL
• Free IPMI

On Fedora 40, you can install some of these dependencies using:

# ProcPS
yum install procps-ng-devel.x86_64 procps-ng.x86_64
# Linux Perf
yum install perf
# SQLite
yum install libsqlite3x.x86_64 libsqlite3x-devel.x86_64
# ZeroMQ
yum install cppzmq-devel.x86_64
# JsonCPP
yum install jsoncpp-devel.x86_64

On Ubuntu 20.04:

# ProcPS
apt install libprocps-dev libprocps8
# Linux Perf
apt install linux-tools-common linux-tools-generic
# SQLite
apt install libsqlite3-dev libsqlite3-0
# ZeroMQ
apt install libzmqpp4 libzmqpp-dev
# JsonCPP
apt install libjsoncpp-dev

Optional

For the documentation, you will require other dependencies like graphviz, java, texlive and doxygen. Please, install them by using:

# Ubuntu
sudo apt install doxygen graphviz openjdk-17-jre texlive-font-utils

You can switch the "-Dbuild-docs" or "-Dbuild-docs-only" to true if you want to compile the documentation.

Compiling EfiMon

Compiling EfiMon follows the same process as any meson project. Please, follow the steps to have EfiMon on your system:

meson builddir $OPTIONS
ninja -C builddinr
sudo ninja -C builddir

EfiMon will be installed under the /usr/local/ prefix.

For the $OPTIONS, you can select the following:

Option	Default Value	Values	Description
build-docs	false	[true, false]	Enable docs compilation
build-docs-only	false	[true, false]	Enable docs-only compilation
build-examples	true	[true, false]	Enable examples compilation
developer-mode	true	[true, false]	Enable developer mode
enable-pcm	true	[true, false]	Enable the Intel PCM
enable-perf	true	[true, false]	Enable the Linux Perf Tool
enable-rapl	true	[true, false]	Enable the RAPL Interface
enable-sql	true	[true, false]	Enable the SQL Logger
enable-ipmi	true	[true, false]	Enable the IPMI Logger

Testing the installation

T.B.D

Usage

EfiMon Power Analyser

The EfiMon Power Analyser wraps a process and perform the analysis. It is self-contained and requires root.

Currently, we have been focused on an analyser for measuring the power consumption based on the histograms.

PID=2000 # Process ID
STIME=10 # Metering during 10 seconds
sudo efimon-power-analyser -p ${PID} -s ${STIME} > consumption.csv

Another way to execute it:

STIME=10 # Metering during 10 seconds
# the command is time sleep 1
sudo efimon-power-analyser -s ${STIME} -c time sleep 1

EfiMon Daemon

The EfiMon Daemon is a server that performs observations of PID. It receives the information about the processes to analyse over IPC (TCP). It does require root.

Example of usage:

efimon-daemon

It has options to:

• Change the output folder for the logs (default folder: /tmp)
• Adjust the frequency of perf
• Adjust the delay between samples
• Change the port of the IPC

EfiMon Launcher

The EfiMon Launcher wraps an application, launching its execution or intercepting a PID. It connects to the EfiMon Daemon over IPC and extracts the analysis.

It does not require root.

• Example of usage (wrapper):

APP="../NanoBenchmark/cpu 11"

efimon-launcher -s 10 -c ${APP}

It launches a command.

• Example of usage (interceptor):

efimon-launcher -s 3 --pid 60603

It monitors an already running process.

It has options to:

• Save the log file in a different location
• Adjust the frequency of perf
• Adjust the delay between samples
• Change the port of the IPC
• Enable of disable perf

The launcher requires a running instance of the EfiMon Daemon

Platforms

EfiMon has been tested in the following platforms:

• Ubuntu 20.04 with Intel Core i5 6000
• Fedora 16 with AMD Epyc Zen2

Additional Information

This project is given to you under the LGPL v2.1 Licence. Dynamic linkage from commercial applications to EfiMon is allowed. Derived work and modifications must be released under the same license as EfiMon (LGPL v2.1).

Contributors

• Luis G. Leon Vega luis.leon@ieee.org

Official Repository

• Github: https://github.com/lleon95/efimon