'\" t
.\"     Title: perf-timechart
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.10
.\"      Date: 2019-10-02
.\"    Manual: perf Manual
.\"    Source: perf
.\"  Language: English
.\"
.TH "PERF_5.3\-TIMECHART" "1" "2019-10-02" "perf" "perf Manual"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
perf\-timechart \- Tool to visualize total system behavior during a workload
.SH "SYNOPSIS"
.sp
.sp
.nf
\fIperf timechart\fP [<timechart options>] {record} [<record options>]
.fi
.br
.SH "DESCRIPTION"
.sp
There are two variants of perf timechart:
.sp
.if n .RS 4
.nf
\(aqperf timechart record <command>\(aq to record the system level events
of an arbitrary workload. By default timechart records only scheduler
and CPU events (task switches, running times, CPU power states, etc),
but it\(aqs possible to record IO (disk, network) activity using \-I argument.
.fi
.if n .RE
.sp
.if n .RS 4
.nf
\(aqperf timechart\(aq to turn a trace into a Scalable Vector Graphics file,
that can be viewed with popular SVG viewers such as \(aqInkscape\(aq. Depending
on the events in the perf.data file, timechart will contain scheduler/cpu
events or IO events.
.fi
.if n .RE
.sp
.if n .RS 4
.nf
In IO mode, every bar has two charts: upper and lower.
Upper bar shows incoming events (disk reads, ingress network packets).
Lower bar shows outgoing events (disk writes, egress network packets).
There are also poll bars which show how much time application spent
in poll/epoll/select syscalls.
.fi
.if n .RE
.SH "TIMECHART OPTIONS"
.sp
\-o, \-\-output=
.RS 4
Select the output file (default: output.svg)
.RE
.sp
\-i, \-\-input=
.RS 4
Select the input file (default: perf.data unless stdin is a fifo)
.RE
.sp
\-w, \-\-width=
.RS 4
Select the width of the SVG file (default: 1000)
.RE
.sp
\-P, \-\-power\-only
.RS 4
Only output the CPU power section of the diagram
.RE
.sp
\-T, \-\-tasks\-only
.RS 4
Don\(cqt output processor state transitions
.RE
.sp
\-p, \-\-process
.RS 4
Select the processes to display, by name or PID
.RE
.sp
\-f, \-\-force
.RS 4
Don\(cqt complain, do it.
.RE
.sp
\-\-symfs=<directory>
.RS 4
Look for files with symbols relative to this directory.
.RE
.sp
\-n, \-\-proc\-num
.RS 4
Print task info for at least given number of tasks.
.RE
.sp
\-t, \-\-topology
.RS 4
Sort CPUs according to topology.
.RE
.sp
\-\-highlight=<duration_nsecs|task_name>
.RS 4
Highlight tasks (using different color) that run more than given
duration or tasks with given name. If number is given it\(cqs interpreted
as number of nanoseconds. If non\-numeric string is given it\(cqs
interpreted as task name.
.RE
.sp
\-\-io\-skip\-eagain
.RS 4
Don\(cqt draw EAGAIN IO events.
.RE
.sp
\-\-io\-min\-time=<nsecs>
.RS 4
Draw small events as if they lasted min\-time. Useful when you need
to see very small and fast IO. It\(cqs possible to specify ms or us
suffix to specify time in milliseconds or microseconds.
Default value is 1ms.
.RE
.sp
\-\-io\-merge\-dist=<nsecs>
.RS 4
Merge events that are merge\-dist nanoseconds apart.
Reduces number of figures on the SVG and makes it more render\-friendly.
It\(cqs possible to specify ms or us suffix to specify time in
milliseconds or microseconds.
Default value is 1us.
.RE
.SH "RECORD OPTIONS"
.sp
\-P, \-\-power\-only
.RS 4
Record only power\-related events
.RE
.sp
\-T, \-\-tasks\-only
.RS 4
Record only tasks\-related events
.RE
.sp
\-I, \-\-io\-only
.RS 4
Record only io\-related events
.RE
.sp
\-g, \-\-callchain
.RS 4
Do call\-graph (stack chain/backtrace) recording
.RE
.SH "EXAMPLES"
.sp
$ perf timechart record git pull
.sp
.if n .RS 4
.nf
[ perf record: Woken up 13 times to write data ]
[ perf record: Captured and wrote 4.253 MB perf.data (~185801 samples) ]
.fi
.if n .RE
.sp
$ perf timechart
.sp
.if n .RS 4
.nf
Written 10.2 seconds of trace to output.svg.
.fi
.if n .RE
.sp
Record system\-wide timechart:
.sp
.if n .RS 4
.nf
$ perf timechart record
.fi
.if n .RE
.sp
.if n .RS 4
.nf
then generate timechart and highlight \(aqgcc\(aq tasks:
.fi
.if n .RE
.sp
.if n .RS 4
.nf
$ perf timechart \-\-highlight gcc
.fi
.if n .RE
.sp
Record system\-wide IO events:
.sp
.if n .RS 4
.nf
$ perf timechart record \-I
.fi
.if n .RE
.sp
.if n .RS 4
.nf
then generate timechart:
.fi
.if n .RE
.sp
.if n .RS 4
.nf
$ perf timechart
.fi
.if n .RE
.SH "SEE ALSO"
.sp
perf\-record(1)