All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Masami Hiramatsu (Google)" <mhiramat@kernel.org>
To: Steven Rostedt <rostedt@goodmis.org>
Cc: Tom Zanussi <zanussi@kernel.org>, Ingo Molnar <mingo@redhat.com>,
	linux-kernel@vger.kernel.org
Subject: [PATCH v5 6/6] tracing: docs: Update histogram doc for .percent/.graph and 'nohitcount'
Date: Sun,  4 Sep 2022 13:13:07 +0900	[thread overview]
Message-ID: <166226478684.223837.9677310927556736590.stgit@devnote2> (raw)
In-Reply-To: <166226473132.223837.9011128463174539022.stgit@devnote2>

From: Masami Hiramatsu (Google) <mhiramat@kernel.org>

Update histogram document for .percent/.graph suffixes and 'nohitcount'
option.

Signed-off-by: Masami Hiramatsu (Google) <mhiramat@kernel.org>
---
 Documentation/trace/histogram.rst |   10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/Documentation/trace/histogram.rst b/Documentation/trace/histogram.rst
index 859fd1b76c63..b2da4e9c62e8 100644
--- a/Documentation/trace/histogram.rst
+++ b/Documentation/trace/histogram.rst
@@ -25,7 +25,7 @@ Documentation written by Tom Zanussi
 
         hist:keys=<field1[,field2,...]>[:values=<field1[,field2,...]>]
           [:sort=<field1[,field2,...]>][:size=#entries][:pause][:continue]
-          [:clear][:name=histname1][:<handler>.<action>] [if <filter>]
+          [:clear][:name=histname1][:nohitcount][:<handler>.<action>] [if <filter>]
 
   When a matching event is hit, an entry is added to a hash table
   using the key(s) and value(s) named.  Keys and values correspond to
@@ -79,6 +79,8 @@ Documentation written by Tom Zanussi
 	.log2          display log2 value rather than raw number
 	.buckets=size  display grouping of values rather than raw number
 	.usecs         display a common_timestamp in microseconds
+        .percent       display a number of percentage value
+        .graph         display a bar-graph of a value
 	=============  =================================================
 
   Note that in general the semantics of a given field aren't
@@ -137,6 +139,12 @@ Documentation written by Tom Zanussi
   existing trigger, rather than via the '>' operator, which will cause
   the trigger to be removed through truncation.
 
+  The 'nohitcount' (or NOHC) parameter will suppress display of
+  raw hitcount in the histogram. This option requires at least one
+  value field which is not a 'raw hitcount'. For example,
+  'hist:...:vals=hitcount:nohitcount' is rejected, but
+  'hist:...:vals=hitcount.percent:nohitcount' is OK.
+
 - enable_hist/disable_hist
 
   The enable_hist and disable_hist triggers can be used to have one


  parent reply	other threads:[~2022-09-04  4:13 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-04  4:12 [PATCH v5 0/6] tracing/hist: Add percentage histogram suffixes Masami Hiramatsu (Google)
2022-09-04  4:12 ` [PATCH v5 1/6] tracing: Allow multiple hitcount values in histograms Masami Hiramatsu (Google)
2022-09-07  2:03   ` Steven Rostedt
2022-09-07  6:12     ` Masami Hiramatsu
2022-09-04  4:12 ` [PATCH v5 2/6] tracing: Fix to check event_mutex is held while accessing trigger list Masami Hiramatsu (Google)
2022-09-07  2:09   ` Steven Rostedt
2022-09-04  4:12 ` [PATCH v5 3/6] tracing: Add .percent suffix option to histogram values Masami Hiramatsu (Google)
2022-09-04  4:12 ` [PATCH v5 4/6] tracing: Add .graph suffix option to histogram value Masami Hiramatsu (Google)
2022-09-04  4:12 ` [PATCH v5 5/6] tracing: Add nohitcount option for suppressing display of raw hitcount Masami Hiramatsu (Google)
2022-09-04  4:13 ` Masami Hiramatsu (Google) [this message]
2022-09-08 22:01 ` [PATCH v5 0/6] tracing/hist: Add percentage histogram suffixes Tom Zanussi

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=166226478684.223837.9677310927556736590.stgit@devnote2 \
    --to=mhiramat@kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mingo@redhat.com \
    --cc=rostedt@goodmis.org \
    --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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.