From: tip-bot for Andi Kleen <tipbot@zytor.com>
To: linux-tip-commits@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, jolsa@kernel.org,
tglx@linutronix.de, ak@linux.intel.com, acme@redhat.com,
hpa@zytor.com, mingo@kernel.org
Subject: [tip:perf/core] perf stat: Document CSV format in manpage
Date: Fri, 11 Mar 2016 00:52:00 -0800 [thread overview]
Message-ID: <tip-6b45f7b2a37b0e00693985fd0abfc8e0319f91ce@git.kernel.org> (raw)
In-Reply-To: <1457049458-28956-5-git-send-email-andi@firstfloor.org>
Commit-ID: 6b45f7b2a37b0e00693985fd0abfc8e0319f91ce
Gitweb: http://git.kernel.org/tip/6b45f7b2a37b0e00693985fd0abfc8e0319f91ce
Author: Andi Kleen <ak@linux.intel.com>
AuthorDate: Thu, 3 Mar 2016 15:57:35 -0800
Committer: Arnaldo Carvalho de Melo <acme@redhat.com>
CommitDate: Thu, 10 Mar 2016 16:49:06 -0300
perf stat: Document CSV format in manpage
With all the recently added fields in the perf stat CSV output we should
finally document them in the man page. Do this here.
v2: Fix fields in documentation (Jiri)
v3: fix order of fields again (Jiri)
v4: Change order again.
v5: Document more fields (Jiri)
v6: Move time stamp first
v7: More fixes (Jiri)
Signed-off-by: Andi Kleen <ak@linux.intel.com>
Acked-by: Jiri Olsa <jolsa@kernel.org>
Link: http://lkml.kernel.org/r/1457049458-28956-5-git-send-email-andi@firstfloor.org
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
---
tools/perf/Documentation/perf-stat.txt | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/tools/perf/Documentation/perf-stat.txt b/tools/perf/Documentation/perf-stat.txt
index 14d9e8f..8812d73 100644
--- a/tools/perf/Documentation/perf-stat.txt
+++ b/tools/perf/Documentation/perf-stat.txt
@@ -219,6 +219,29 @@ $ perf stat -- make -j
Wall-clock time elapsed: 719.554352 msecs
+CSV FORMAT
+----------
+
+With -x, perf stat is able to output a not-quite-CSV format output
+Commas in the output are not put into "". To make it easy to parse
+it is recommended to use a different character like -x \;
+
+The fields are in this order:
+
+ - optional usec time stamp in fractions of second (with -I xxx)
+ - optional CPU, core, or socket identifier
+ - optional number of logical CPUs aggregated
+ - counter value
+ - unit of the counter value or empty
+ - event name
+ - run time of counter
+ - percentage of measurement time the counter was running
+ - optional variance if multiple values are collected with -r
+ - optional metric value
+ - optional unit of metric
+
+Additional metrics may be printed with all earlier fields being empty.
+
SEE ALSO
--------
linkperf:perf-top[1], linkperf:perf-list[1]
next prev parent reply other threads:[~2016-03-11 8:52 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-03-03 23:57 perf, tools: Refactor and support interval and CSV metrics Andi Kleen
2016-03-03 23:57 ` [PATCH 1/7] perf, tools, stat: Check existence of frontend/backed stalled cycles Andi Kleen
2016-03-03 23:57 ` [PATCH 2/7] perf, tools, stat: Implement CSV metrics output Andi Kleen
2016-03-03 23:57 ` [PATCH 3/7] perf, tools, stat: Support metrics in --per-core/socket mode Andi Kleen
2016-03-03 23:57 ` [PATCH 4/7] perf, tools, stat: Document CSV format in manpage Andi Kleen
2016-03-10 11:29 ` Jiri Olsa
2016-03-11 8:52 ` tip-bot for Andi Kleen [this message]
2016-03-03 23:57 ` [PATCH 5/7] perf, tools, stat: Implement --metric-only mode Andi Kleen
2016-03-10 11:28 ` Jiri Olsa
2016-03-11 8:52 ` [tip:perf/core] perf " tip-bot for Andi Kleen
2016-03-03 23:57 ` [PATCH 6/7] perf, tools, stat: Add --metric-only support for -A Andi Kleen
2016-03-10 11:32 ` Jiri Olsa
2016-03-11 8:52 ` [tip:perf/core] perf " tip-bot for Andi Kleen
2016-03-03 23:57 ` [PATCH 7/7] perf, tools, stat: Check for frontend stalled for metrics Andi Kleen
2016-03-07 10:08 ` perf, tools: Refactor and support interval and CSV metrics Jiri Olsa
2016-03-07 18:22 ` Andi Kleen
2016-03-07 18:48 ` Jiri Olsa
2016-03-07 21:11 ` Andi Kleen
2016-03-10 11:34 ` Jiri Olsa
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=tip-6b45f7b2a37b0e00693985fd0abfc8e0319f91ce@git.kernel.org \
--to=tipbot@zytor.com \
--cc=acme@redhat.com \
--cc=ak@linux.intel.com \
--cc=hpa@zytor.com \
--cc=jolsa@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-tip-commits@vger.kernel.org \
--cc=mingo@kernel.org \
--cc=tglx@linutronix.de \
/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).