JSON output for perf stat
Ian Rogers
reviewerv7 cover JSON output for perf stat
Parsing the CSV or text output of perf stat can be problematic when new output is added (columns in CSV format). JSON names values and simplifies the job of parsing. Add a JSON output option to perf-stat then add unit test that parses and validates the output.
This is a resend of two v2 patches:
https://lore.kernel.org/lkml/[email protected]/
https://lore.kernel.org/lkml/[email protected]/
with a few formatting changes and improvements to the linter.
v7. Weakens a test and adds a Makefile.perf change Suggested-by:
Arnaldo Carvalho de Melo <[email protected]>.
v6. Is a rebase.
v5. Drops the merged CSV check, fixes a json test issue found by
Arnaldo and a typo.
v4. Does some minor fixes to the json linter.
v3. There is some tidy up of CSV code including a potential memory
over run in the os.nfields set up caught by sanitizers. To facilitate this an AGGR_MAX value is added. v3 also adds the CSV testing.
v2. Fixes the system wide no aggregation test to not run if the
paranoia is wrong. It also makes the counter-value check handle the "<not counted>" and "<not supported>" cases.
Claire Jensen (2):
perf stat: Add JSON output option
perf test: Json format checking
tools/perf/Documentation/perf-stat.txt | 21 + tools/perf/Makefile.perf | 3 +- tools/perf/builtin-stat.c | 6 + .../tests/shell/lib/perf_json_output_lint.py | 96 +++++ tools/perf/tests/shell/stat+json_output.sh | 147 +++++++ tools/perf/util/stat-display.c | 383 +++++++++++++----- tools/perf/util/stat.c | 1 + tools/perf/util/stat.h | 2 + 8 files changed, 552 insertions(+), 107 deletions(-) create mode 100644 tools/perf/tests/shell/lib/perf_json_output_lint.py create mode 100755 tools/perf/tests/shell/stat+json_output.sh
Signature · 1 line
2.37.1.559.g78731f0fdb-goog
Ian Rogers
reviewerPATCH v7 1/2 perf stat: Add JSON output option
From: Claire Jensen <[email protected]>
CSV output is tricky to format and column layout changes are susceptible to breaking parsers. New JSON-formatted output has variable names to identify fields that are consistent and informative, making the output parseable.
CSV output example:
1.20,msec,task-clock:u,1204272,100.00,0.697,CPUs utilized 0,,context-switches:u,1204272,100.00,0.000,/sec 0,,cpu-migrations:u,1204272,100.00,0.000,/sec 70,,page-faults:u,1204272,100.00,58.126,K/sec
JSON output example:
{"counter-value" : "3805.723968", "unit" : "msec", "event" :
"cpu-clock", "event-runtime" : 3805731510100.00, "pcnt-running" : 100.00, "metric-value" : 4.007571, "metric-unit" : "CPUs utilized"} {"counter-value" : "6166.000000", "unit" : "", "event" :
"context-switches", "event-runtime" : 3805723045100.00, "pcnt-running" : 100.00, "metric-value" : 1.620191, "metric-unit" : "K/sec"} {"counter-value" : "466.000000", "unit" : "", "event" :
"cpu-migrations", "event-runtime" : 3805727613100.00, "pcnt-running" : 100.00, "metric-value" : 122.447136, "metric-unit" : "/sec"} {"counter-value" : "208.000000", "unit" : "", "event" :
"page-faults", "event-runtime" : 3805726799100.00, "pcnt-running" : 100.00, "metric-value" : 54.654516, "metric-unit" : "/sec"}
Also added documentation for JSON option.
There is some tidy up of CSV code including a potential memory over run in the os.nfields set up. To facilitate this an AGGR_MAX value is added.
--- tools/perf/Documentation/perf-stat.txt | 21 ++ tools/perf/builtin-stat.c | 6 + tools/perf/util/stat-display.c | 383 ++++++++++++++++++------- tools/perf/util/stat.c | 1 + tools/perf/util/stat.h | 2 + 5 files changed, 307 insertions(+), 106 deletions(-)
tools/perf/Documentation/perf-stat.txt +21 -0
@@ -570,6 +570,27 @@ Additional metrics may be printed with all earlier fields being empty. include::intel-hybrid.txt[] +JSON FORMAT +----------- + +With -j, perf stat is able to print out a JSON format output +that can be used for parsing. + +- timestamp : optional usec time stamp in fractions of second (with -I) +- optional aggregate options: + - core : core identifier (with --per-core) + - die : die identifier (with --per-die) + - socket : socket identifier (with --per-socket) + - node : node identifier (with --per-node) + - thread : thread identifier (with --per-thread) +- counter-value : counter value +- unit : unit of the counter value or empty +- event : event name +- variance : optional variance if multiple values are collected (with -r) +- runtime : run time of counter +- metric-value : optional metric value +- metric-unit : optional unit of metric + SEE ALSO -------- linkperf:perf-top[1], linkperf:perf-list[1]
tools/perf/builtin-stat.c +6 -0
@@ -1250,6 +1250,8 @@ static struct option stat_options[] = { "Merge identical named hybrid events"),OPT_STRING ('x' ,"field-separator" , &stat_config.csv_sep,"separator" ,"print counts with custom separator" ), +OPT_BOOLEAN ('j' ,"json-output" , &stat_config.json_output, +"print counts in JSON format" ),OPT_CALLBACK ('G' ,"cgroup" , &evsel_list,"name" ,"monitor event in cgroup name only" , parse_stat_cgroups), OPT_STRING(0, "for-each-cgroup", &stat_config.cgroup_list, "name",
@@ -1436,6 +1438,7 @@ static aggr_cpu_id_get_t aggr_mode__get_aggr(enum aggr_mode aggr_mode)case AGGR_GLOBAL :case AGGR_THREAD :case AGGR_UNSET : +case AGGR_MAX :default :return NULL ; }
@@ -1460,6 +1463,7 @@ static aggr_get_id_t aggr_mode__get_id(enum aggr_mode aggr_mode)case AGGR_GLOBAL :case AGGR_THREAD :case AGGR_UNSET : +case AGGR_MAX :default :return NULL ; }
@@ -1610,6 +1614,7 @@ static aggr_cpu_id_get_t aggr_mode__get_aggr_file(enum aggr_mode aggr_mode)case AGGR_GLOBAL :case AGGR_THREAD :case AGGR_UNSET : +case AGGR_MAX :default :return NULL ; }
@@ -1630,6 +1635,7 @@ static aggr_get_id_t aggr_mode__get_id_file(enum aggr_mode aggr_mode)case AGGR_GLOBAL :case AGGR_THREAD :case AGGR_UNSET : +case AGGR_MAX :default :return NULL ; }
tools/perf/util/stat-display.c +277 -106
555 lines not on this page · raw message
tools/perf/util/stat.c +1 -0
@@ -401,6 +401,7 @@ process_counter_values(struct perf_stat_config *config, struct evsel *evsel, aggr->ena += count->ena; aggr->run += count->run;case AGGR_UNSET : +case AGGR_MAX :default :break ; }
tools/perf/util/stat.h +2 -0
@@ -57,6 +57,7 @@ enum aggr_mode {AGGR_THREAD ,AGGR_UNSET ,AGGR_NODE , +AGGR_MAX }; enum {
@@ -121,6 +122,7 @@ struct perf_stat_config {bool no_inherit;bool identifier;bool csv_output; +bool json_output;bool interval_clear;bool metric_only;bool null_run;
Signature · 1 line
2.37.1.559.g78731f0fdb-goog
Ian Rogers
reviewerPATCH v7 2/2 perf test: Json format checking
In reply to Ian RogersFrom: Claire Jensen <[email protected]>
Add field checking tests for perf stat JSON output. Sanity checks the expected number of fields are present, that the expected keys are present and they have the correct values.
--- tools/perf/Makefile.perf | 3 +- .../tests/shell/lib/perf_json_output_lint.py | 96 ++++++++++++ tools/perf/tests/shell/stat+json_output.sh | 147 ++++++++++++++++++ 3 files changed, 245 insertions(+), 1 deletion(-) create mode 100644 tools/perf/tests/shell/lib/perf_json_output_lint.py create mode 100755 tools/perf/tests/shell/stat+json_output.sh
tools/perf/Makefile.perf +2 -1
@@ -1005,7 +1005,8 @@ install-tests: all install-gtk $(INSTALL) -d -m 755 '$(DESTDIR_SQ)$(perfexec_instdir_SQ)/tests/shell'; \ $(INSTALL) tests/shell/*.sh '$(DESTDIR_SQ)$(perfexec_instdir_SQ)/tests/shell'; \ $(INSTALL) -d -m 755 '$(DESTDIR_SQ)$(perfexec_instdir_SQ)/tests/shell/lib'; \ - $(INSTALL) tests/shell/lib/*.sh '$(DESTDIR_SQ)$(perfexec_instdir_SQ)/tests/shell/lib' + $(INSTALL) tests/shell/lib/*.sh '$(DESTDIR_SQ)$(perfexec_instdir_SQ)/tests/shell/lib' \ + $(INSTALL) tests/shell/lib/*.py '$(DESTDIR_SQ)$(perfexec_instdir_SQ)/tests/shell/lib' install-bin: install-tools install-tests install-traceevent-plugins
tools/perf/tests/shell/lib/perf_json_output_lint.py new file +96 -0
96 lines not on this page · raw message
tools/perf/tests/shell/stat+json_output.sh new file +147 -0
147 lines not on this page · raw message
Signature · 1 line
2.37.1.559.g78731f0fdb-goog
Arnaldo Carvalho de Melo
maintainerRe: [PATCH v7 2/2] perf test: Json format checking
Em Fri, Aug 05, 2022 at 01:01:05PM -0700, Ian Rogers escreveu:
Quoted 21 lines
From: Claire Jensen <[email protected]>
Add field checking tests for perf stat JSON output. Sanity checks the expected number of fields are present, that the expected keys are present and they have the correct values.
Signed-off-by Claire Jensen <[email protected]>Signed-off-by Ian Rogers <[email protected]>--- tools/perf/Makefile.perf | 3 +- .../tests/shell/lib/perf_json_output_lint.py | 96 ++++++++++++ tools/perf/tests/shell/stat+json_output.sh | 147 ++++++++++++++++++ 3 files changed, 245 insertions(+), 1 deletion(-) create mode 100644 tools/perf/tests/shell/lib/perf_json_output_lint.py create mode 100755 tools/perf/tests/shell/stat+json_output.shtools/perf/Makefile.perf +0
-0
tools/perf/Makefile.perf install-tests: all install-gtk · line 1009
Quoted 6 lines
tools/perf/Makefile.perf +2
-1@@ -1005,7 +1005,8 @@ install-tests: all install-gtk $(INSTALL) -d -m 755 '$(DESTDIR_SQ)$(perfexec_instdir_SQ)/tests/shell'; \ $(INSTALL) tests/shell/*.sh '$(DESTDIR_SQ)$(perfexec_instdir_SQ)/tests/shell'; \ $(INSTALL) -d -m 755 '$(DESTDIR_SQ)$(perfexec_instdir_SQ)/tests/shell/lib'; \ - $(INSTALL) tests/shell/lib/*.sh '$(DESTDIR_SQ)$(perfexec_instdir_SQ)/tests/shell/lib' + $(INSTALL) tests/shell/lib/*.sh '$(DESTDIR_SQ)$(perfexec_instdir_SQ)/tests/shell/lib' \ + $(INSTALL) tests/shell/lib/*.py '$(DESTDIR_SQ)$(perfexec_instdir_SQ)/tests/shell/lib'
Next time please test installing it, since this is adding a new file:
INSTALL tests
install: omitting directory '/home/acme/libexec/perf-core/tests/shell/lib'
install: cannot stat 'install': No such file or directory make[2]: *** [Makefile.perf:999: install-tests] Error 1 make[2]: *** Waiting for unfinished jobs....
Fixed with:
tools/perf/Makefile.perf +1 -1
@@ -1005,7 +1005,7 @@ install-tests: all install-gtk $(INSTALL) -d -m 755 '$(DESTDIR_SQ)$(perfexec_instdir_SQ)/tests/shell'; \ $(INSTALL) tests/shell/*.sh '$(DESTDIR_SQ)$(perfexec_instdir_SQ)/tests/shell'; \ $(INSTALL) -d -m 755 '$(DESTDIR_SQ)$(perfexec_instdir_SQ)/tests/shell/lib'; \ - $(INSTALL) tests/shell/lib/*.sh '$(DESTDIR_SQ)$(perfexec_instdir_SQ)/tests/shell/lib' \ + $(INSTALL) tests/shell/lib/*.sh '$(DESTDIR_SQ)$(perfexec_instdir_SQ)/tests/shell/lib'; \ $(INSTALL) tests/shell/lib/*.py '$(DESTDIR_SQ)$(perfexec_instdir_SQ)/tests/shell/lib' install-bin: install-tools install-tests install-traceevent-plugins
Hi Ian,
Quoted 26 lines · Ian Rogers
Parsing the CSV or text output of perf stat can be problematic when new output is added (columns in CSV format). JSON names values and simplifies the job of parsing. Add a JSON output option to perf-stat then add unit test that parses and validates the output.
This is a resend of two v2 patches:
https://lore.kernel.org/lkml/[email protected]/
https://lore.kernel.org/lkml/[email protected]/
with a few formatting changes and improvements to the linter.v7. Weakens a test and adds a Makefile.perf change Suggested-by:
Arnaldo Carvalho de Melo <[email protected]>.v6. Is a rebase.
v5. Drops the merged CSV check, fixes a json test issue found by
Arnaldo and a typo.v4. Does some minor fixes to the json linter.
v3. There is some tidy up of CSV code including a potential memory
over run in the os.nfields set up caught by sanitizers. To facilitate this anAGGR_MAXvalue is added. v3 also adds the CSV testing.
Quoted 7 lines
v2. Fixes the system wide no aggregation test to not run if the
paranoia is wrong. It also makes the counter-value check handle the "<not counted>" and "<not supported>" cases.Claire Jensen (2):
perf stat: Add JSON output option
perf test: Json format checking
I'd really like to clean up the perf stat output code as it's already hard to deal with.. Let me do that after adding this. So,
Thanks,
Namhyung
Quoted 16 lines
tools/perf/Documentation/perf-stat.txt | 21 + tools/perf/Makefile.perf | 3 +- tools/perf/builtin-stat.c | 6 + .../tests/shell/lib/perf_json_output_lint.py | 96 +++++ tools/perf/tests/shell/stat+json_output.sh | 147 +++++++ tools/perf/util/stat-display.c | 383 +++++++++++++----- tools/perf/util/stat.c | 1 + tools/perf/util/stat.h | 2 + 8 files changed, 552 insertions(+), 107 deletions(-) create mode 100644 tools/perf/tests/shell/lib/perf_json_output_lint.py create mode 100755 tools/perf/tests/shell/stat+json_output.sh--
2.37.1.559.g78731f0fdb-goog