linux/tools/perf/scripts/python
Petar Gligoric fdd0f81f05 perf script: task-analyzer add csv support
This patch adds the possibility to write the trace and the summary as csv files
to a user specified file. A format as such simplifies further data processing.
This is achieved by having ";" as separators instead of spaces and solely one
header per file.

Additional parameters are being considered, like in the normal usage of the
script. Colors are turned off in the case of a csv output, thus the highlight
option is also being ignored.

Usage:

Write standard task to csv file:

  $ perf script report tasks-analyzer --csv <file>

write limited output to csv file in nanoseconds:

  $ perf script report tasks-analyzer --csv <file> --ns --limit-to-tasks 1337

Write summary to a csv file:

  $ perf script report tasks-analyzer --csv-summary <file>

Write summary to csv file with additional schedule information:

  $ perf script report tasks-analyzer --csv-summary <file> --summary-extended

Write both summary and standard task to a csv file:

  $ perf script report tasks-analyzer --csv --csv-summary

The following examples illustrate what is possible with the CSV output.  The
first command sequence will record all scheduler switch events for 10 seconds,
the task-analyzer calculates task information like runtimes as CSV.  A small
python snippet using pandas and matplotlib will visualize the most frequent
task (e.g. kworker/1:1) runtimes - each runtime as a bar in a bar chart:

  $ perf record -e sched:sched_switch -a -- sleep 10
  $ perf script report tasks-analyzer --ns --csv tasks.csv
  $ cat << EOF > /tmp/freq-comm-runtimes-bar.py
    import pandas as pd
    import matplotlib.pyplot as plt

    df = pd.read_csv("tasks.csv", sep=';')
    most_freq_comm = df["COMM"].value_counts().idxmax()
    most_freq_runtimes = df[df["COMM"]==most_freq_comm]["Runtime"]
    plt.title(f"Runtimes for Task {most_freq_comm} in Nanoseconds")
    plt.bar(range(len(most_freq_runtimes)), most_freq_runtimes)
    plt.show()
  $ python3 /tmp/freq-comm-runtimes-bar.py

As a seconds example, the subsequent script generates a pie chart of all
accumulated tasks runtimes for 10 seconds of system recordings:

  $ perf record -e sched:sched_switch -a -- sleep 10
  $ perf script report tasks-analyzer --csv-summary task-summary.csv
  $ cat << EOF > /tmp/accumulated-task-pie.py
    import pandas as pd
    from matplotlib.pyplot import pie, axis, show

    df = pd.read_csv("task-summary.csv", sep=';')
    sums = df.groupby(df["Comm"])["Accumulated"].sum()
    axis("equal")
    pie(sums, labels=sums.index);
    show()
  EOF
  $ python3 /tmp/accumulated-task-pie.py

A variety of other visualizations are possible in matplotlib and other
environments. Of course, pandas, numpy and co. also allow easy
statistical analysis of the data!

Signed-off-by: Petar Gligoric <petar.gligoric@rohde-schwarz.com>
Cc: Andi Kleen <ak@linux.intel.com>
Cc: Ian Rogers <irogers@google.com>
Cc: Jiri Olsa <jolsa@kernel.org>
Cc: Namhyung Kim <namhyung@kernel.org>
Link: https://lore.kernel.org/r/20221206154406.41941-3-petar.gligor@gmail.com
Signed-off-by: Hagen Paul Pfeifer <hagen@jauu.net>
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
2022-12-14 11:24:31 -03:00
..
bin perf script: Introduce task analyzer python script 2022-12-14 11:24:31 -03:00
Perf-Trace-Util perf build: Use libtraceevent from the system 2022-12-14 11:16:12 -03:00
arm-cs-trace-disasm.py perf scripts python: Let script to be python2 compliant 2022-07-27 11:17:50 -03:00
check-perf-trace.py perf script python: add Python3 support to check-perf-trace.py 2019-03-06 18:10:46 -03:00
compaction-times.py perf script python: Remove mixed indentation 2019-03-06 18:09:14 -03:00
event_analyzing_sample.py perf script python: Add Python3 support to event_analyzing_sample.py 2019-03-06 18:11:11 -03:00
export-to-postgresql.py perf scripts python: export-to-postgresql.py: Export all sample flags 2022-02-15 17:15:07 -03:00
export-to-sqlite.py perf scripts python: export-to-sqlite.py: Export all sample flags 2022-02-15 17:15:05 -03:00
exported-sql-viewer.py perf scripting python: exported-sql-viewer.py: Factor out libxed.py 2021-06-01 10:05:08 -03:00
failed-syscalls-by-pid.py perf script python: Remove mixed indentation 2019-03-06 18:09:14 -03:00
flamegraph.py perf flamegraph: flamegraph.py script improvements 2021-08-30 18:22:23 -03:00
futex-contention.py perf script: Add min, max to futex-contention output, in addition to avg 2020-09-23 12:58:53 -03:00
intel-pt-events.py perf scripts python: intel-pt-events.py: Add ability interleave output 2022-10-27 16:37:26 -03:00
libxed.py perf scripting python: exported-sql-viewer.py: Factor out libxed.py 2021-06-01 10:05:08 -03:00
mem-phys-addr.py perf script python: Remove mixed indentation 2019-03-06 18:09:14 -03:00
net_dropmonitor.py perf script python: Remove mixed indentation 2019-03-06 18:09:14 -03:00
netdev-times.py perf tools: Fix various typos in comments 2021-03-23 17:13:43 -03:00
powerpc-hcalls.py perf script python: Add Python3 support to powerpc-hcalls.py 2019-02-25 17:16:57 -03:00
sched-migration.py perf script python: Remove mixed indentation 2019-03-06 18:09:14 -03:00
sctop.py perf script python: Remove mixed indentation 2019-03-06 18:09:14 -03:00
stackcollapse.py perf script python: Remove mixed indentation 2019-03-06 18:09:14 -03:00
stat-cpi.py perf script python: Add Python3 support to stat-cpi.py 2019-02-25 17:17:07 -03:00
syscall-counts-by-pid.py perf script python: Remove mixed indentation 2019-03-06 18:09:14 -03:00
syscall-counts.py perf script python: Remove mixed indentation 2019-03-06 18:09:14 -03:00
task-analyzer.py perf script: task-analyzer add csv support 2022-12-14 11:24:31 -03:00