Skip to content

RTLA documentation #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

RTLA documentation #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b313260
RTLA documentation
benjamin051000 Mar 25, 2025
a046109
Merge RTLA subcommands (#114)
farshidtz Apr 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/.custom_wordlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -217,3 +217,8 @@ ww
xetex
xindy
yaml
rtla
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you sort this @benjamin051000 ?
makes it easier to manage the list.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will do. Note that I opened an issue in the starter pack to auto-sort in CI:
canonical/sphinx-docs-starter-pack#380

osnoise
timerlat
hwnoise
maskable
53 changes: 53 additions & 0 deletions docs/reference/real-time-metrics-tools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,49 @@ where:

This command displays system resource statistics with timestamps and shows most frequent interrupts.

rtla
-----

`RTLA`_ provides a set of tools for the analysis of the kernel's realtime behavior on specific hardware.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`RTLA`_ provides a set of tools for the analysis of the kernel's realtime behavior on specific hardware.
`RTLA`_ provides a set of tools for the analysis of the kernel's real-time behavior on specific hardware.


RTLA comes pre-installed on Ubuntu 24.04 LTS (Noble Numbat) and later.
It is not available as a package on Ubuntu Core.

hwnoise
^^^^^^^
See how hardware noise affects kernel threads.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
See how hardware noise affects kernel threads.
See how hardware noise affects kernel threads.


hwnoise is similar to osnoise, except that it disables interrupts. Only non-maskable interrupts and hardware-related noise will affect the test.
Copy link
Collaborator

@AnneCYH AnneCYH Apr 17, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
hwnoise is similar to osnoise, except that it disables interrupts. Only non-maskable interrupts and hardware-related noise will affect the test.
``hwnoise`` is similar to ``osnoise``, except that it disables interrupts.
Only non-maskable interrupts and hardware-related noise will affect the test.


Run ``rtla hwnoise top`` for a top-like interface that shows the time each thread takes to read the current time.

Run ``rtla hwnoise hist`` for a histogram, which may be better suited for logging.

For more information, see the `rtla-hwnoise`_ documentation.

osnoise
^^^^^^^
See how operating system noise (preemption, IRQs/soft-IRQs) affect kernel threads.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
See how operating system noise (preemption, IRQs/soft-IRQs) affect kernel threads.
See how operating system noise (preemption, IRQs/soft-IRQs) affect kernel threads.


osnoise is part of the `rtla`_ suite, which comes pre-installed on Ubuntu 24.04 LTS (Noble Numbat) and later.
Copy link
Collaborator

@AnneCYH AnneCYH Apr 17, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
osnoise is part of the `rtla`_ suite, which comes pre-installed on Ubuntu 24.04 LTS (Noble Numbat) and later.
``osnoise`` is part of the `rtla`_ suite, which comes pre-installed on Ubuntu 24.04 LTS (Noble Numbat) and later.

It does not support older versions of Ubuntu.

Run ``rtla osnoise top`` for a top-like interface that shows the time each thread takes to read the current time.

Run ``rtla osnoise hist`` for a histogram, which may be better suited for logging.

For more information, see the `rtla-osnoise-top`_ and `rtla-osnoise-hist`_ documentation.


Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

timerlat
^^^^^^^^
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
^^^^^^^^
^^^^^^^^

timerlat runs threads which periodically wake up and sleep, and data is collected about how much latency overhead the operating system adds to them.
Copy link
Collaborator

@AnneCYH AnneCYH Apr 17, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
timerlat runs threads which periodically wake up and sleep, and data is collected about how much latency overhead the operating system adds to them.
``timerlat`` runs threads which periodically wake up and sleep, and data is collected about how much latency overhead the operating system adds to them.


Like osnoise, timerlat offers both a ``timerlat top`` and ``timerlat hist`` mode.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Like osnoise, timerlat offers both a ``timerlat top`` and ``timerlat hist`` mode.
Like ``osnoise``, ``timerlat`` offers both a ``timerlat top`` and ``timerlat hist`` mode.


For more information, see the `rtla-timerlat-top`_ and `rtla-timerlat-hist`_ documentation.


Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

oslat
-----

Expand Down Expand Up @@ -121,6 +164,8 @@ where:

This command runs the ``oslat`` test and then prints the results, which include latency measurements for each core.



Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

ps
---

Expand Down Expand Up @@ -219,6 +264,14 @@ This could be used to monitor real-time observation of system activities such as
.. _cyclictest: https://man.archlinux.org/man/cyclictest.8.en
.. _dstat: https://manpages.ubuntu.com/manpages/jammy/man1/pcp-dstat.1.html
.. _oslat: https://manpages.ubuntu.com/manpages/jammy/man8/oslat.8.html

.. _rtla: https://docs.kernel.org/tools/rtla/index.html
.. _rtla-osnoise-top: https://docs.kernel.org/tools/rtla/rtla-osnoise-top.html
.. _rtla-osnoise-hist: https://docs.kernel.org/tools/rtla/rtla-osnoise-hist.html
.. _rtla-hwnoise: https://docs.kernel.org/tools/rtla/rtla-hwnoise.html
.. _rtla-timerlat-top: https://docs.kernel.org/tools/rtla/rtla-timerlat-top.html
.. _rtla-timerlat-hist: https://docs.kernel.org/tools/rtla/rtla-timerlat-hist.html

.. _ps: https://www.man7.org/linux/man-pages/man1/ps.1.html
.. _perf: https://www.man7.org/linux/man-pages/man1/perf.1.html
.. _stress-ng: https://manpages.ubuntu.com/manpages/noble/en/man1/stress-ng.1.html
Expand Down