RTLA documentation #100
RTLA documentation #100
Conversation
benjamin051000
added
the
documentation
There was a problem hiding this comment.
Thanks for the additions.
The commands are structured differently from every other command in this document:
- cyclictest
- dstat
- oslat
- RTLA
- osnoise
- hwnoise
- timerlat
- ps
- perf
- stress-ng
- watch
I suggest maintaining a flat structure, sorted alphabetically:
- cyclictest - from RT Tests
- dstat
- hwnoise - from RTLA
- oslat - from RT Tests
- osnoise - from RTLA
- ps
- perf
- stress-ng
- timerlat - from RTLA
- watch
Signed-off-by: Benjamin Wheeler <[email protected]>
|
@farshidtz I added the note about Ubuntu Core not being supported. |
|
@benjamin051000 thanks for the changes. For your convenience, I've submitted a PR to merge them: #114 |
Signed-off-by: Farshid Tavakolizadeh <[email protected]>
| @@ -217,3 +217,8 @@ ww | |||
| xetex | |||
| xindy | |||
| yaml | |||
| rtla | |||
There was a problem hiding this comment.
Could you sort this @benjamin051000 ?
makes it easier to manage the list.
There was a problem hiding this comment.
Will do. Note that I opened an issue in the starter pack to auto-sort in CI:
canonical/sphinx-docs-starter-pack#380
| rtla | ||
| ----- | ||
|
|
||
| `RTLA`_ provides a set of tools for the analysis of the kernel's realtime behavior on specific hardware. |
There was a problem hiding this comment.
| `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. |
|
|
||
| hwnoise | ||
| ^^^^^^^ | ||
| See how hardware noise affects kernel threads. |
There was a problem hiding this comment.
| See how hardware noise affects kernel threads. | |
| 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. |
There was a problem hiding this comment.
| 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. |
|
|
||
| osnoise | ||
| ^^^^^^^ | ||
| See how operating system noise (preemption, IRQs/soft-IRQs) affect kernel threads. |
There was a problem hiding this comment.
| See how operating system noise (preemption, IRQs/soft-IRQs) affect kernel threads. | |
| 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. |
There was a problem hiding this comment.
| 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. |
|
|
||
| For more information, see the `rtla-osnoise-top`_ and `rtla-osnoise-hist`_ documentation. | ||
|
|
||
|
|
|
|
||
|
|
||
| timerlat | ||
| ^^^^^^^^ |
There was a problem hiding this comment.
| ^^^^^^^^ | |
| ^^^^^^^^ | |
|
|
||
| timerlat | ||
| ^^^^^^^^ | ||
| timerlat runs threads which periodically wake up and sleep, and data is collected about how much latency overhead the operating system adds to them. |
There was a problem hiding this comment.
| 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. |
| ^^^^^^^^ | ||
| 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. |
There was a problem hiding this comment.
| 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. | ||
|
|
||
|
|
| @@ -121,6 +164,8 @@ where: | |||
|
|
|||
| This command runs the ``oslat`` test and then prints the results, which include latency measurements for each core. | |||
|
|
|||
|
|
|||
|
|
|||
There was a problem hiding this comment.
hey @benjamin051000 , some formatting-related changes suggested.
Otherwise it reads well; thanks for the effort!
Note
Link to built docs: https://canonical-ubuntu-documentation-library--100.com.readthedocs.build/real-time/en/100/reference/real-time-metrics-tools/