xref: /linux/Documentation/tools/rtla/rtla-osnoise.rst (revision 778b8ebe5192e7a7f00563a7456517dfa63e1d90)
1===============
2rtla-osnoise
3===============
4------------------------------------------------------------------
5Measure the operating system noise
6------------------------------------------------------------------
7
8:Manual section: 1
9
10SYNOPSIS
11========
12**rtla osnoise** [*MODE*] ...
13
14DESCRIPTION
15===========
16
17.. include:: common_osnoise_description.txt
18
19The *osnoise* tracer outputs information in two ways. It periodically prints
20a summary of the noise of the operating system, including the counters of
21the occurrence of the source of interference. It also provides information
22for each noise via the **osnoise:** tracepoints. The **rtla osnoise top**
23mode displays information about the periodic summary from the *osnoise* tracer.
24The **rtla osnoise hist** mode displays information about the noise using
25the **osnoise:** tracepoints. For further details, please refer to the
26respective man page.
27
28MODES
29=====
30**top**
31
32        Prints the summary from osnoise tracer.
33
34**hist**
35
36        Prints a histogram of osnoise samples.
37
38If no MODE is given, the top mode is called, passing the arguments.
39
40OPTIONS
41=======
42
43**-h**, **--help**
44
45        Display the help text.
46
47For other options, see the man page for the corresponding mode.
48
49SEE ALSO
50========
51**rtla-osnoise-top**\(1), **rtla-osnoise-hist**\(1)
52
53Osnoise tracer documentation: <https://www.kernel.org/doc/html/latest/trace/osnoise-tracer.html>
54
55AUTHOR
56======
57Written by Daniel Bristot de Oliveira <bristot@kernel.org>
58
59.. include:: common_appendix.txt
60