xref: /linux/Documentation/tools/rtla/rtla-osnoise-hist.rst (revision ba199dc909a20fe62270ae4e93f263987bb9d119)
1===================
2rtla-osnoise-hist
3===================
4------------------------------------------------------
5Display a histogram of the osnoise tracer samples
6------------------------------------------------------
7
8:Manual section: 1
9
10SYNOPSIS
11========
12**rtla osnoise hist** [*OPTIONS*]
13
14DESCRIPTION
15===========
16.. include:: common_osnoise_description.rst
17
18The **rtla osnoise hist** tool collects all **osnoise:sample_threshold**
19occurrence in a histogram, displaying the results in a user-friendly way.
20The tool also allows many configurations of the *osnoise* tracer and the
21collection of the tracer output.
22
23OPTIONS
24=======
25.. include:: common_osnoise_options.rst
26
27.. include:: common_hist_options.rst
28
29.. include:: common_options.rst
30
31EXAMPLE
32=======
33In the example below, *osnoise* tracer threads are set to run with real-time
34priority *FIFO:1*, on CPUs *0-11*, for *900ms* at each period (*1s* by
35default). 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
37histogram 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
56SEE 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
62AUTHOR
63======
64Written by Daniel Bristot de Oliveira <bristot@kernel.org>
65
66.. include:: common_appendix.rst
67