From: Daniel Bristot de Oliveira <bristot@kernel.org>
To: Steven Rostedt <rostedt@goodmis.org>
Cc: Daniel Bristot de Oliveira <bristot@kernel.org>,
Ingo Molnar <mingo@redhat.com>, Tom Zanussi <zanussi@kernel.org>,
Masami Hiramatsu <mhiramat@kernel.org>,
Juri Lelli <juri.lelli@redhat.com>,
Clark Williams <williams@redhat.com>,
John Kacur <jkacur@redhat.com>,
Peter Zijlstra <peterz@infradead.org>,
Thomas Gleixner <tglx@linutronix.de>,
Sebastian Andrzej Siewior <bigeasy@linutronix.de>,
linux-rt-users@vger.kernel.org,
linux-trace-devel@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH V4 16/19] rtla: Add rtla osnoise hist documentation
Date: Thu, 21 Oct 2021 14:56:54 +0200 [thread overview]
Message-ID: <b9aa98890c8258db5bf0e7bf4216086bf93a7102.1634820694.git.bristot@kernel.org> (raw)
In-Reply-To: <cover.1634820694.git.bristot@kernel.org>
Man page for rtla osnoise hist mode.
Cc: Steven Rostedt <rostedt@goodmis.org>
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>
---
.../tools/rtla/common_hist_options.rst | 23 +++++++
.../tools/rtla/rtla-osnoise-hist.rst | 66 +++++++++++++++++++
2 files changed, 89 insertions(+)
create mode 100644 Documentation/tools/rtla/common_hist_options.rst
create mode 100644 Documentation/tools/rtla/rtla-osnoise-hist.rst
diff --git a/Documentation/tools/rtla/common_hist_options.rst b/Documentation/tools/rtla/common_hist_options.rst
new file mode 100644
index 000000000000..0266cd08a6c9
--- /dev/null
+++ b/Documentation/tools/rtla/common_hist_options.rst
@@ -0,0 +1,23 @@
+**-b**, **--bucket-size** *N*
+
+ Set the histogram bucket size (default *1*).
+
+**-e**, **--entries** *N*
+
+ Set the number of entries of the histogram (default 256).
+
+**--no-header**
+
+ Do not print header.
+
+**--no-summary**
+
+ Do not print summary.
+
+**--no-index**
+
+ Do not print index.
+
+**--with-zeros**
+
+ Print zero only entries.
diff --git a/Documentation/tools/rtla/rtla-osnoise-hist.rst b/Documentation/tools/rtla/rtla-osnoise-hist.rst
new file mode 100644
index 000000000000..f1cf80912c2b
--- /dev/null
+++ b/Documentation/tools/rtla/rtla-osnoise-hist.rst
@@ -0,0 +1,66 @@
+===================
+rtla-osnoise-hist
+===================
+------------------------------------------------------
+Display a histogram of the osnoise tracer samples
+------------------------------------------------------
+
+:Manual section: 1
+
+SYNOPSIS
+========
+**rtla osnoise hist** [*OPTIONS*]
+
+DESCRIPTION
+===========
+.. include:: common_osnoise_description.rst
+
+The **rtla osnoise hist** tool collects all **osnoise:sample_threshold**
+occurrence in a histogram, displaying the results in a user-friendly way.
+The tool also allows many configurations of the *osnoise* tracer and the
+collection of the tracer output.
+
+OPTIONS
+=======
+.. include:: common_osnoise_options.rst
+
+.. include:: common_hist_options.rst
+
+.. include:: common_options.rst
+
+EXAMPLE
+=======
+In the example below, *osnoise* tracer threads are set to run with real-time
+priority *FIFO:1*, on CPUs *0-11*, for *900ms* at each period (*1s* by
+default). The reason for reducing the runtime is to avoid starving the
+**rtla** tool. The tool is also set to run for *one minute*. The output
+histogram is set to group outputs in buckets of *10us* and *25* entries::
+
+ [root@f34 ~/]# rtla osnoise hist -P F:1 -c 0-11 -r 900000 -d 1M -b 10 -e 25
+ # RTLA osnoise histogram
+ # Time unit is microseconds (us)
+ # Duration: 0 00:01:00
+ 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
+ 0 42982 46287 51779 53740 52024 44817 49898 36500 50408 50128 49523 52377
+ 10 12224 8356 2912 878 2667 10155 4573 18894 4214 4836 5708 2413
+ 20 8 5 12 2 13 24 20 41 29 53 39 39
+ 30 1 1 0 0 10 3 6 19 15 31 30 38
+ 40 0 0 0 0 0 4 2 7 2 3 8 11
+ 50 0 0 0 0 0 0 0 0 0 1 1 2
+ over: 0 0 0 0 0 0 0 0 0 0 0 0
+ count: 55215 54649 54703 54620 54714 55003 54499 55461 54668 55052 55309 54880
+ min: 0 0 0 0 0 0 0 0 0 0 0 0
+ avg: 0 0 0 0 0 0 0 0 0 0 0 0
+ max: 30 30 20 20 30 40 40 40 40 50 50 50
+
+SEE ALSO
+========
+**rtla-osnoise**\(1), **rtla-osnoise-top**\(1)
+
+*osnoise* tracer documentation: <https://www.kernel.org/doc/html/latest/trace/osnoise-tracer.html>
+
+AUTHOR
+======
+Written by Daniel Bristot de Oliveira <bristot@kernel.org>
+
+.. include:: common_appendix.rst
--
2.31.1
next prev parent reply other threads:[~2021-10-21 12:59 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-21 12:56 [PATCH V4 00/19] RTLA: An interface for osnoise/timerlat tracers Daniel Bristot de Oliveira
2021-10-21 12:56 ` [PATCH V4 01/19] trace/osnoise: Do not follow tracing_cpumask Daniel Bristot de Oliveira
2021-10-23 2:23 ` Steven Rostedt
2021-10-25 7:26 ` Daniel Bristot de Oliveira
2021-10-21 12:56 ` [PATCH V4 02/19] trace/osnoise: Split workload start from the tracer start Daniel Bristot de Oliveira
2021-10-23 2:25 ` Steven Rostedt
2021-10-25 7:33 ` Daniel Bristot de Oliveira
2021-10-21 12:56 ` [PATCH V4 03/19] trace/osnoise: Use start/stop_per_cpu_kthreads() on osnoise_cpus_write() Daniel Bristot de Oliveira
2021-10-21 12:56 ` [PATCH V4 04/19] trace/osnoise: Support a list of trace_array *tr Daniel Bristot de Oliveira
2021-10-23 2:38 ` Steven Rostedt
2021-10-25 3:26 ` Paul E. McKenney
2021-10-25 9:10 ` Daniel Bristot de Oliveira
2021-10-25 13:35 ` Steven Rostedt
2021-10-25 14:33 ` Paul E. McKenney
2021-10-21 12:56 ` [PATCH V4 05/19] trace/osnoise: Allow multiple instances of the same tracer Daniel Bristot de Oliveira
2021-10-23 2:47 ` Steven Rostedt
2021-10-25 8:08 ` Daniel Bristot de Oliveira
2021-10-25 14:36 ` Steven Rostedt
2021-10-21 12:56 ` [PATCH V4 06/19] rtla: Real-Time Linux Analysis tool Daniel Bristot de Oliveira
2021-10-21 12:56 ` [PATCH V4 07/19] rtla: Helper functions for rtla Daniel Bristot de Oliveira
2021-10-21 12:56 ` [PATCH V4 08/19] rtla: Add osnoise tool Daniel Bristot de Oliveira
2021-10-21 12:56 ` [PATCH V4 09/19] rtla/osnoise: Add osnoise top mode Daniel Bristot de Oliveira
2021-10-21 12:56 ` [PATCH V4 10/19] rtla/osnoise: Add the hist mode Daniel Bristot de Oliveira
2021-10-21 12:56 ` [PATCH V4 11/19] rtla: Add timerlat tool and timelart top mode Daniel Bristot de Oliveira
2021-10-21 12:56 ` [PATCH V4 12/19] rtla/timerlat: Add timerlat hist mode Daniel Bristot de Oliveira
2021-10-21 12:56 ` [PATCH V4 13/19] rtla: Add Documentation Daniel Bristot de Oliveira
2021-10-21 12:56 ` [PATCH V4 14/19] rtla: Add rtla osnoise man page Daniel Bristot de Oliveira
2021-10-21 12:56 ` [PATCH V4 15/19] rtla: Add rtla osnoise top documentation Daniel Bristot de Oliveira
2021-10-21 12:56 ` Daniel Bristot de Oliveira [this message]
2021-10-21 12:56 ` [PATCH V4 17/19] rtla: Add rtla timerlat documentation Daniel Bristot de Oliveira
2021-10-21 12:56 ` [PATCH V4 18/19] rtla: Add rtla timerlat top documentation Daniel Bristot de Oliveira
2021-10-21 12:56 ` [PATCH V4 19/19] rtla: Add rtla timerlat hist documentation Daniel Bristot de Oliveira
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=b9aa98890c8258db5bf0e7bf4216086bf93a7102.1634820694.git.bristot@kernel.org \
--to=bristot@kernel.org \
--cc=bigeasy@linutronix.de \
--cc=jkacur@redhat.com \
--cc=juri.lelli@redhat.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-rt-users@vger.kernel.org \
--cc=linux-trace-devel@vger.kernel.org \
--cc=mhiramat@kernel.org \
--cc=mingo@redhat.com \
--cc=peterz@infradead.org \
--cc=rostedt@goodmis.org \
--cc=tglx@linutronix.de \
--cc=williams@redhat.com \
--cc=zanussi@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).