Re: [PATCH 4/7] perf, tools, stat: Document CSV format in manpage

[Jiri Olsa]

On Mon, Feb 29, 2016 at 02:36:23PM -0800, Andi Kleen wrote:
> From: Andi Kleen <ak@xxxxxxxxxxxxxxx>
> 
> 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.
> Signed-off-by: Andi Kleen <ak@xxxxxxxxxxxxxxx>
> ---
>  tools/perf/Documentation/perf-stat.txt | 21 +++++++++++++++++++++
>  1 file changed, 21 insertions(+)
> 
> diff --git a/tools/perf/Documentation/perf-stat.txt b/tools/perf/Documentation/perf-stat.txt
> index 52ef7a9..3ae7907 100644
> --- a/tools/perf/Documentation/perf-stat.txt
> +++ b/tools/perf/Documentation/perf-stat.txt
> @@ -211,6 +211,27 @@ $ 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)

there's also optional CPU field in case you do other than GLOBAL aggregation:

[jolsa@krava perf]$ sudo ./perf.old stat -a -A -x, kill
kill: not enough arguments
CPU0,0.629921,,task-clock,629706,100.00


[jolsa@krava perf]$ sudo ./perf.old stat -a --per-core -x, kill
kill: not enough arguments
S0-C0,2,1.168179,,task-clock,1167956,100.00


[jolsa@krava perf]$ sudo ./perf.old stat -a --per-socket -x, kill
kill: not enough arguments
S0,4,2.296581,,task-clock,2296198,100.00

thanks,
jirka

> +	- 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]
> -- 
> 2.5.0
>