Difference between revisions of "Systemtap"

[quality revision] [pending revision]
m
m
 

1 Article Purpose[edit]

This article provides basic information to start using the Linux kernel tool: SystemTap[1] with stap command line tool.

2 Introduction[edit]

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™
Name Category Purpose Starter Package Developer Package Distribution Package Starter Package Developer Package Distribution Package
SystemTap Monitoring tools SystemTap[1] provides stap target command line tool.

SystemTap provides free software (GPL) infrastructure to simplify the gathering of information about the running Linux system. This assists diagnosis of a performance or functional problem.

No Yes Yes No No No

SystemTap provides a simple command line interface and scripting language for writing instrumentation for a live running kernel plus user-space applications. We are publishing samples, as well as enlarging the internal "tapset" script library to aid reuse and abstraction.

Among other tracing/probing tools, SystemTap is the tool of choice for complex tasks that may require live analysis, programmable on-line response, and whole-system symbolic access. SystemTap can also handle simple tracing jobs.

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

3.1 Using STM32MPU Embedded Software distribution[edit]

stap from systemtap is installed by default and ready to be used with all STM32MPU Embedded Software Packages.

Board $> which stap
/usr/bin/stap 

systemtap is integrated in weston image distribution through through meta-st package: meta-st/meta-st-openstlinux/recipes-st/packagegroups/packagegroup-framework-tools.bb.

RDEPENDS_packagegroup-framework-tools-core = "\
   grep            \
   util-linux      \
   util-linux-lscpu \
   procps          \
   kbd             \
   file            \
   bc              \
   e2fsprogs       \
   e2fsprogs-resize2fs \
   sysstat         \
   minicom         \
   ntp             \
   systemtap       \
   gptfdisk        \
   lsb-openstlinux \
   "

4 Getting started[edit]

Under construction.png Check to introduce basic commands and examples for using dtrace and stap

5 To go further[edit]

Under construction.png Coming soon


6 References[edit]

"External links"
Document link Document Type Description
SystemTap beginner guide User Guide sourceware.org
SystemTap Wiki Wiki sourceware.org
SystemTap Wiki Wiki Wikipedia
SystemTap documentation User guide sourceware.org
stap manpage Standard linux.die.net
dtrace manpage Standard linux.die.net



<noinclude>

{{ArticleBasedOnModel | [[Trace and debug tools article model]]}}
{{ArticleMainWriter | Jean-PhilippeR}}
{{ArticleApprovedVersion | Jean-ChristopheT | Nobody | No previous approved version | Automatic approval (article under construction) | 19Feb’19}}== Article Purpose ==
This article provides basic information to start using the Linux kernel tool: '''SystemTap'''<ref name=systemtapdotorg/> with '''stap''' command line tool.

== Introduction ==
{{:Trace_and_debug_tools_assignment_table_template}}<onlyinclude>

 | [[Systemtap|SystemTap]]
 | [[:Category:Monitoring tools|Monitoring tools]]
 | style="text-align:left;" | '''SystemTap'''<ref name=systemtapdotorg>https://sourceware.org/systemtap/</ref> provides '''stap''' target command line tool.<br>

'''SystemTap''' provides free software (GPL) infrastructure to simplify the gathering of information about the running Linux system. This assists diagnosis of a performance or functional problem.
 | {{N}} || {{Y}} || {{Y}}
 | {{N}} || {{N}} || {{N}}
 |-</onlyinclude>

 |}

'''SystemTap''' provides a simple command line interface and scripting language for writing instrumentation for a live running kernel plus user-space applications. We are publishing samples, as well as enlarging the internal "tapset" script library to aid reuse and abstraction.

Among other tracing/probing tools, '''SystemTap''' is the tool of choice for complex tasks that may require live analysis, programmable on-line response, and whole-system symbolic access. SystemTap can also handle simple tracing jobs.

== Installing the trace and debug tool on your target board ==
=== Using STM32MPU Embedded Software distribution ===
'''stap''' from systemtap is installed by default and ready to be used with all STM32MPU Embedded Software Packages.
 {{Board$}} which stap
 /usr/bin/stap 

'''systemtap''' is integrated in weston image distribution through through meta-st package: <code>''meta-st/meta-st-openstlinux/recipes-st/packagegroups/packagegroup-framework-tools.bb''</code>.
 RDEPENDS_packagegroup-framework-tools-core = "\
    grep            \
    util-linux      \
    util-linux-lscpu \
    procps          \
    kbd             \
    file            \
    bc              \
    e2fsprogs       \
    e2fsprogs-resize2fs \
    sysstat         \
    minicom         \
    ntp             \
    {{green|'''systemtap'''}}       \
    gptfdisk        \
    lsb-openstlinux \
    "

== Getting started ==
{{UnderConstruction|Check to introduce basic commands and examples for using dtrace and stap}}

== To go further ==
{{UnderConstruction}}
{{ReviewsComments|Check possibility to use Flame to visualize SystemTap trace}}

== References ==<references />


{|
|+ "External links"
|-
! scope=col | Document link
! scope=col | Document Type
! scope=col | Description
|-
| [https://sourceware.org/systemtap/SystemTap_Beginners_Guide/index.html SystemTap beginner guide]
| User Guide
| sourceware.org
|-
| [https://sourceware.org/systemtap/wiki SystemTap Wiki]
| Wiki
| sourceware.org
|-
| [https://en.wikipedia.org/wiki/SystemTap SystemTap Wiki]
| Wiki
| Wikipedia
|-
| [https://sourceware.org/systemtap/documentation.html SystemTap documentation]
| User guide
| sourceware.org
|-
| [https://linux.die.net/man/1/stap stap manpage]
| Standard
| linux.die.net
|-
| [https://linux.die.net/man/1/dtrace dtrace manpage]
| Standard
| linux.die.net
|}
<noinclude>

{{ArticleBasedOnModel | Trace and debug tools article model}}

[[Category:Linux monitoring tools]]</noinclude>

{{UnderConstruction}}
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
  +
== Article Purpose ==
  +
This article provides basic information to start using the Linux kernel tool: '''SystemTap'''<ref name=systemtapdotorg/> with '''stap''' command line tool.
  +
  +
== Introduction ==
  +
{{:Trace_and_debug_tools_assignment_table_template}}
  +
<onlyinclude>
  +
| [[Systemtap|SystemTap]]
  +
| [[:Category:Monitoring tools|Monitoring tools]]
  +
| style="text-align:left;" | '''SystemTap'''<ref name=systemtapdotorg>https://sourceware.org/systemtap/</ref> provides '''stap''' target command line tool.<br>
  +
'''SystemTap''' provides free software (GPL) infrastructure to simplify the gathering of information about the running Linux system. This assists diagnosis of a performance or functional problem.
  +
| {{N}} || {{Y}} || {{Y}}
  +
| {{N}} || {{N}} || {{N}}
  +
|-
  +
</onlyinclude>
  +
|}
  +
  +
'''SystemTap''' provides a simple command line interface and scripting language for writing instrumentation for a live running kernel plus user-space applications. We are publishing samples, as well as enlarging the internal "tapset" script library to aid reuse and abstraction.
  +
  +
Among other tracing/probing tools, '''SystemTap''' is the tool of choice for complex tasks that may require live analysis, programmable on-line response, and whole-system symbolic access. SystemTap can also handle simple tracing jobs.
  +
  +
== Installing the trace and debug tool on your target board ==
  +
=== Using STM32MPU Embedded Software distribution ===
  +
'''stap''' from systemtap is installed by default and ready to be used with all STM32MPU Embedded Software Packages.
  +
{{Board$}} which stap
  +
/usr/bin/stap
  +
  +
'''systemtap''' is integrated in weston image distribution through through meta-st package: <code>''meta-st/meta-st-openstlinux/recipes-st/packagegroups/packagegroup-framework-tools.bb''</code>.
  +
RDEPENDS_packagegroup-framework-tools-core = "\
  +
    grep            \
  +
    util-linux      \
  +
    util-linux-lscpu \
  +
    procps          \
  +
    kbd            \
  +
    file            \
  +
    bc              \
  +
    e2fsprogs      \
  +
    e2fsprogs-resize2fs \
  +
    sysstat        \
  +
    minicom        \
  +
    ntp            \
  +
    {{green|'''systemtap'''}}      \
  +
    gptfdisk        \
  +
    lsb-openstlinux \
  +
    "
  +
  +
== Getting started ==
  +
{{UnderConstruction|Check to introduce basic commands and examples for using dtrace and stap}}
  +
  +
== To go further ==
  +
{{UnderConstruction}}
  +
{{ReviewsComments|Check possibility to use Flame to visualize SystemTap trace}}
  +
  +
== References ==
  +
<references />
  +
  +
{|
  +
|+ "External links"
  +
|-
  +
! scope=col | Document link
  +
! scope=col | Document Type
  +
! scope=col | Description
  +
|-
  +
| [https://sourceware.org/systemtap/SystemTap_Beginners_Guide/index.html SystemTap beginner guide]
  +
| User Guide
  +
| sourceware.org
  +
|-
  +
| [https://sourceware.org/systemtap/wiki SystemTap Wiki]
  +
| Wiki
  +
| sourceware.org
  +
|-
  +
| [https://en.wikipedia.org/wiki/SystemTap SystemTap Wiki]
  +
| Wiki
  +
| Wikipedia
  +
|-
  +
| [https://sourceware.org/systemtap/documentation.html SystemTap documentation]
  +
| User guide
  +
| sourceware.org
  +
|-
  +
| [https://linux.die.net/man/1/stap stap manpage]
  +
| Standard
  +
| linux.die.net
  +
|-
  +
| [https://linux.die.net/man/1/dtrace dtrace manpage]
  +
| Standard
  +
| linux.die.net
  +
|}
  +
 
<noinclude>
 
<noinclude>
{{ArticleBasedOnModel | [[Trace and debug tools article model]]}}
+
{{ArticleBasedOnModel | Trace and debug tools article model}}
{{ArticleMainWriter | Jean-PhilippeR}}
 
{{ArticleApprovedVersion | Jean-ChristopheT | Nobody | No previous approved version | Automatic approval (article under construction) | 19Feb’19}}
 
 
[[Category:Linux monitoring tools]]
 
[[Category:Linux monitoring tools]]
 
</noinclude>
 
</noinclude>
{{UnderConstruction}}
 

Attachments

Discussions