Last edited one year ago

Sysdig

Applicable for STM32MP13x lines, STM32MP15x lines


1. Article purpose[edit source]

This article provides basic information to start using the Linux tool: sysdig[1].

2. Introduction[edit source]

The following table provides a brief description of the tool, as well as its availability depending on the software packages:

Yes: this tool is either present (ready to use or to be activated), or can be integrated and activated on the software package.

No: this tool is not present and cannot be integrated, or it is present but cannot be activated on the software package.

Tool STM32MPU Embedded Software distribution STM32MPU Embedded Software distribution for Android™
Warning white.png Warning
STM32MPU Embedded Software distribution for Android™ is no more supported by ST. You can contact our ST partner, Witekio, who can help you to port and maintain it on STM32MP15 platform.
Name Category Purpose Starter Package Developer Package Distribution Package Starter Package Developer Package Distribution Package
sysdig Monitoring tools sysdig[1] is a tool for system troubleshooting, analysis and exploration. It can be used to capture, filter and decode system calls and other OS events. No No Yes No No No

sysdig can be both used to inspect live systems or to generate trace files that can be analyzed at a later stage.

It includes a powerul filtering language, has customizable output, and can be extended through Lua scripts, called chisels.

sysdig aims to replace a collection of tools, as lsof, strace, iostat, ps, etc...

3. Installing the trace and debug tool on your target board[edit source]

sysdig is a user space application which is not part of the standard STM32MPU Embedded Software distribution image and Packages. It has to be integrated as an external component.

Linux kernel configuration must also enable CONFIG_TRACEPOINTS and CONFIG_HAVE_SYSCALL_TRACEPOINTS:

Symbol: TRACEPOINTS [=y]
Selected by: TRACING [=y] || BLK_DEV_IO_TRACE [=n] && TRACING_SUPPORT [=y] && FTRACE [=y] && SYSFS [=y] && BLOCK [=y]

Symbol: HAVE_SYSCALL_TRACEPOINTS [=y]
Selected by: ARM [=y]

3.1. Using STM32MPU Embedded Software distribution[edit source]

On STM32MPU Embedded Software distribution(weston), Linux kernel configuration already enable the required configuration options.

3.1.1. Developer Package[edit source]

There are too many dependencies for building sysdig application and kernel driver, that's the reason why this is recommended to use the Distribution package to integrate this tool.

3.1.2. Distribution Package[edit source]

Yocto recipes for building sysdig are part of the OpenSTLinux distribution.

Following steps to be done to enable sysdig and add it to the st-image-weston image:

  • Add sysdig package install for the image
 echo 'IMAGE_INSTALL_append += "sysdig-stm32mp"' >> layers/meta-st/meta-st-openstlinux/recipes-st/images/st-image-weston.bbappend
 echo 'IMAGE_INSTALL_append += "sysdig-driver"' >> layers/meta-st/meta-st-openstlinux/recipes-st/images/st-image-weston.bbappend
  • Regenerate the image file:
 bitbake st-image-weston

4. Getting started[edit source]

Below some basics commands extracted from official sysdig website[1]: Sysdig exemples.png

5. To go further[edit source]

Under construction.png Coming soon

6. References[edit source]

"External links"
Document link Document Type Description
sysdig manpage Standard Man page from Official github
sysdig wiki documentation User Guide Documentation from Official github