From: Jiri Olsa <jolsa@kernel.org>
To: Arnaldo Carvalho de Melo <acme@kernel.org>
Cc: lkml <linux-kernel@vger.kernel.org>,
Peter Zijlstra <a.p.zijlstra@chello.nl>,
Ingo Molnar <mingo@kernel.org>,
Mark Rutland <mark.rutland@arm.com>,
Namhyung Kim <namhyung@kernel.org>,
Alexander Shishkin <alexander.shishkin@linux.intel.com>,
Michael Petlan <mpetlan@redhat.com>,
Ian Rogers <irogers@google.com>,
Alexei Budankov <abudankov@huawei.com>
Subject: [PATCH 18/24] perf daemon: Add examples to man page
Date: Mon, 8 Feb 2021 21:09:02 +0100 [thread overview]
Message-ID: <20210208200908.1019149-19-jolsa@kernel.org> (raw)
In-Reply-To: <20210208200908.1019149-1-jolsa@kernel.org>
Adding usage examples to the man page.
Signed-off-by: Jiri Olsa <jolsa@kernel.org>
---
tools/perf/Documentation/perf-daemon.txt | 98 ++++++++++++++++++++++++
1 file changed, 98 insertions(+)
diff --git a/tools/perf/Documentation/perf-daemon.txt b/tools/perf/Documentation/perf-daemon.txt
index 90b20bea6356..f558f8e4bc9b 100644
--- a/tools/perf/Documentation/perf-daemon.txt
+++ b/tools/perf/Documentation/perf-daemon.txt
@@ -41,6 +41,10 @@ for time and size.
Each session is started with control setup (with perf record --control
options).
+Sessions are configured through config file, see CONFIG FILE section
+with EXAMPLES.
+
+
OPTIONS
-------
-v::
@@ -105,6 +109,100 @@ session-<NAME>.run:
Each perf record session is run in daemon.base/<NAME> directory.
+EXAMPLES
+--------
+Example with 2 record sessions:
+
+ # cat ~/.perfconfig
+ [daemon]
+ base=/opt/perfdata
+
+ [session-cycles]
+ run = -m 10M -e cycles --overwrite --switch-output -a
+
+ [session-sched]
+ run = -m 20M -e sched:* --overwrite --switch-output -a
+
+
+Starting the daemon:
+
+ # perf daemon start
+
+
+Check sessions:
+
+ # perf daemon
+ [603349:daemon] base: /opt/perfdata
+ [603350:cycles] perf record -m 10M -e cycles --overwrite --switch-output -a
+ [603351:sched] perf record -m 20M -e sched:* --overwrite --switch-output -a
+
+First line is daemon process info with configured daemon base.
+
+
+Check sessions with more info:
+
+ # perf daemon -v
+ [603349:daemon] base: /opt/perfdata
+ output: /opt/perfdata/output
+ lock: /opt/perfdata/lock
+ up: 1 minutes
+ [603350:cycles] perf record -m 10M -e cycles --overwrite --switch-output -a
+ base: /opt/perfdata/session-cycles
+ output: /opt/perfdata/session-cycles/output
+ control: /opt/perfdata/session-cycles/control
+ ack: /opt/perfdata/session-cycles/ack
+ up: 1 minutes
+ [603351:sched] perf record -m 20M -e sched:* --overwrite --switch-output -a
+ base: /opt/perfdata/session-sched
+ output: /opt/perfdata/session-sched/output
+ control: /opt/perfdata/session-sched/control
+ ack: /opt/perfdata/session-sched/ack
+ up: 1 minutes
+
+The 'base' path is daemon/session base.
+The 'lock' file is daemon's lock file guarding that no other
+daemon is running on top of the base.
+The 'output' file is perf record output for specific session.
+The 'control' and 'ack' files are perf control files.
+The 'up' number shows minutes daemon/session is running.
+
+
+Make sure control session is online:
+
+ # perf daemon ping
+ OK cycles
+ OK sched
+
+
+Send USR2 signal to session 'cycles' to generate perf.data file:
+
+ # perf daemon signal --session cycles
+ signal 12 sent to session 'cycles [603452]'
+
+ # tail -2 /opt/perfdata/session-cycles/output
+ [ perf record: dump data: Woken up 1 times ]
+ [ perf record: Dump perf.data.2020123017013149 ]
+
+
+Send USR2 signal to all sessions:
+
+ # perf daemon signal
+ signal 12 sent to session 'cycles [603452]'
+ signal 12 sent to session 'sched [603453]'
+
+ # tail -2 /opt/perfdata/session-cycles/output
+ [ perf record: dump data: Woken up 1 times ]
+ [ perf record: Dump perf.data.2020123017024689 ]
+ # tail -2 /opt/perfdata/session-sched/output
+ [ perf record: dump data: Woken up 1 times ]
+ [ perf record: Dump perf.data.2020123017024713 ]
+
+
+Stop daemon:
+
+ # perf daemon stop
+
+
SEE ALSO
--------
linkperf:perf-record[1], linkperf:perf-config[1]
--
2.29.2
next prev parent reply other threads:[~2021-02-08 21:18 UTC|newest]
Thread overview: 35+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-08 20:08 [PATCHv4 00/24] perf tools: Add daemon command Jiri Olsa
2021-02-08 20:08 ` [PATCH 01/24] perf daemon: " Jiri Olsa
2021-02-08 20:08 ` [PATCH 02/24] perf daemon: Add config option Jiri Olsa
2021-02-08 20:08 ` [PATCH 03/24] perf daemon: Add base option Jiri Olsa
2021-02-08 20:08 ` [PATCH 04/24] perf daemon: Add server socket support Jiri Olsa
2021-02-08 20:08 ` [PATCH 05/24] perf daemon: Add client " Jiri Olsa
2021-02-11 12:52 ` Arnaldo Carvalho de Melo
2021-02-11 16:35 ` Jiri Olsa
2021-02-08 20:08 ` [PATCH 06/24] perf daemon: Add config file support Jiri Olsa
2021-02-11 6:01 ` Namhyung Kim
2021-02-11 16:45 ` Jiri Olsa
2021-02-11 17:10 ` Arnaldo Carvalho de Melo
2021-02-11 22:52 ` Jiri Olsa
2021-02-08 20:08 ` [PATCH 07/24] perf daemon: Add config file change check Jiri Olsa
2021-02-08 20:08 ` [PATCH 08/24] perf daemon: Add background support Jiri Olsa
2021-02-08 20:08 ` [PATCH 09/24] perf daemon: Add signalfd support Jiri Olsa
2021-02-08 20:08 ` [PATCH 10/24] perf daemon: Add list command Jiri Olsa
2021-02-08 20:08 ` [PATCH 11/24] perf daemon: Add signal command Jiri Olsa
2021-02-08 20:08 ` [PATCH 12/24] perf daemon: Add stop command Jiri Olsa
2021-02-08 20:08 ` [PATCH 13/24] perf daemon: Allow only one daemon over base directory Jiri Olsa
2021-02-11 13:20 ` Arnaldo Carvalho de Melo
2021-02-11 16:35 ` Jiri Olsa
2021-02-08 20:08 ` [PATCH 14/24] perf daemon: Set control fifo for session Jiri Olsa
2021-02-08 20:08 ` [PATCH 15/24] perf daemon: Add ping command Jiri Olsa
2021-02-10 12:51 ` Arnaldo Carvalho de Melo
2021-02-10 13:27 ` Jiri Olsa
2021-02-08 20:09 ` [PATCH 16/24] perf daemon: Use control to stop session Jiri Olsa
2021-02-08 20:09 ` [PATCH 17/24] perf daemon: Add up time for daemon/session list Jiri Olsa
2021-02-08 20:09 ` Jiri Olsa [this message]
2021-02-08 20:09 ` [PATCH 19/24] perf tests: Add daemon list command test Jiri Olsa
2021-02-08 20:09 ` [PATCH 20/24] perf tests: Add daemon reconfig test Jiri Olsa
2021-02-08 20:09 ` [PATCH 21/24] perf tests: Add daemon stop command test Jiri Olsa
2021-02-08 20:09 ` [PATCH 22/24] perf tests: Add daemon signal " Jiri Olsa
2021-02-08 20:09 ` [PATCH 23/24] perf tests: Add daemon ping " Jiri Olsa
2021-02-08 20:09 ` [PATCH 24/24] perf tests: Add daemon lock test 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=20210208200908.1019149-19-jolsa@kernel.org \
--to=jolsa@kernel.org \
--cc=a.p.zijlstra@chello.nl \
--cc=abudankov@huawei.com \
--cc=acme@kernel.org \
--cc=alexander.shishkin@linux.intel.com \
--cc=irogers@google.com \
--cc=linux-kernel@vger.kernel.org \
--cc=mark.rutland@arm.com \
--cc=mingo@kernel.org \
--cc=mpetlan@redhat.com \
--cc=namhyung@kernel.org \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.