Documentation/tools/rtla/rtla-osnoise.rst

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