Skip to content

Commit e7041c6

Browse files
Daniel Bristot de Oliveirarostedt
authored andcommitted
rtla: Add rtla osnoise hist documentation
Man page for rtla osnoise hist mode. Link: https://lkml.kernel.org/r/d43cc5d516b8db180575c4b66c4aa67c6a724a8d.1639158831.git.bristot@kernel.org Cc: Tao Zhou <tao.zhou@linux.dev> Cc: Ingo Molnar <mingo@redhat.com> Cc: Tom Zanussi <zanussi@kernel.org> Cc: Masami Hiramatsu <mhiramat@kernel.org> Cc: Juri Lelli <juri.lelli@redhat.com> Cc: Clark Williams <williams@redhat.com> Cc: John Kacur <jkacur@redhat.com> Cc: Peter Zijlstra <peterz@infradead.org> Cc: Thomas Gleixner <tglx@linutronix.de> Cc: Sebastian Andrzej Siewior <bigeasy@linutronix.de> Cc: Daniel Bristot de Oliveira <bristot@kernel.org> Cc: linux-rt-users@vger.kernel.org Cc: linux-trace-devel@vger.kernel.org Cc: linux-kernel@vger.kernel.org Signed-off-by: Daniel Bristot de Oliveira <bristot@kernel.org> Signed-off-by: Steven Rostedt <rostedt@goodmis.org>
1 parent b1be483 commit e7041c6

File tree

2 files changed

+89
-0
lines changed

2 files changed

+89
-0
lines changed
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
**-b**, **--bucket-size** *N*
2+
3+
Set the histogram bucket size (default *1*).
4+
5+
**-e**, **--entries** *N*
6+
7+
Set the number of entries of the histogram (default 256).
8+
9+
**--no-header**
10+
11+
Do not print header.
12+
13+
**--no-summary**
14+
15+
Do not print summary.
16+
17+
**--no-index**
18+
19+
Do not print index.
20+
21+
**--with-zeros**
22+
23+
Print zero only entries.
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
===================
2+
rtla-osnoise-hist
3+
===================
4+
------------------------------------------------------
5+
Display a histogram of the osnoise tracer samples
6+
------------------------------------------------------
7+
8+
:Manual section: 1
9+
10+
SYNOPSIS
11+
========
12+
**rtla osnoise hist** [*OPTIONS*]
13+
14+
DESCRIPTION
15+
===========
16+
.. include:: common_osnoise_description.rst
17+
18+
The **rtla osnoise hist** tool collects all **osnoise:sample_threshold**
19+
occurrence in a histogram, displaying the results in a user-friendly way.
20+
The tool also allows many configurations of the *osnoise* tracer and the
21+
collection of the tracer output.
22+
23+
OPTIONS
24+
=======
25+
.. include:: common_osnoise_options.rst
26+
27+
.. include:: common_hist_options.rst
28+
29+
.. include:: common_options.rst
30+
31+
EXAMPLE
32+
=======
33+
In the example below, *osnoise* tracer threads are set to run with real-time
34+
priority *FIFO:1*, on CPUs *0-11*, for *900ms* at each period (*1s* by
35+
default). The reason for reducing the runtime is to avoid starving the
36+
**rtla** tool. The tool is also set to run for *one minute*. The output
37+
histogram is set to group outputs in buckets of *10us* and *25* entries::
38+
39+
[root@f34 ~/]# rtla osnoise hist -P F:1 -c 0-11 -r 900000 -d 1M -b 10 -e 25
40+
# RTLA osnoise histogram
41+
# Time unit is microseconds (us)
42+
# Duration: 0 00:01:00
43+
Index CPU-000 CPU-001 CPU-002 CPU-003 CPU-004 CPU-005 CPU-006 CPU-007 CPU-008 CPU-009 CPU-010 CPU-011
44+
0 42982 46287 51779 53740 52024 44817 49898 36500 50408 50128 49523 52377
45+
10 12224 8356 2912 878 2667 10155 4573 18894 4214 4836 5708 2413
46+
20 8 5 12 2 13 24 20 41 29 53 39 39
47+
30 1 1 0 0 10 3 6 19 15 31 30 38
48+
40 0 0 0 0 0 4 2 7 2 3 8 11
49+
50 0 0 0 0 0 0 0 0 0 1 1 2
50+
over: 0 0 0 0 0 0 0 0 0 0 0 0
51+
count: 55215 54649 54703 54620 54714 55003 54499 55461 54668 55052 55309 54880
52+
min: 0 0 0 0 0 0 0 0 0 0 0 0
53+
avg: 0 0 0 0 0 0 0 0 0 0 0 0
54+
max: 30 30 20 20 30 40 40 40 40 50 50 50
55+
56+
SEE ALSO
57+
========
58+
**rtla-osnoise**\(1), **rtla-osnoise-top**\(1)
59+
60+
*osnoise* tracer documentation: <https://www.kernel.org/doc/html/latest/trace/osnoise-tracer.html>
61+
62+
AUTHOR
63+
======
64+
Written by Daniel Bristot de Oliveira <bristot@kernel.org>
65+
66+
.. include:: common_appendix.rst

0 commit comments

Comments
 (0)