xref: /linux/tools/perf/Documentation/perf-daemon.txt (revision 23c5831e2e040f7a044743a2e6e060426d579d7f)
1d450bc50SJiri Olsaperf-daemon(1)
2d450bc50SJiri Olsa==============
3d450bc50SJiri Olsa
4d450bc50SJiri Olsa
5d450bc50SJiri OlsaNAME
6d450bc50SJiri Olsa----
7d450bc50SJiri Olsaperf-daemon - Run record sessions on background
8d450bc50SJiri Olsa
9d450bc50SJiri Olsa
10d450bc50SJiri OlsaSYNOPSIS
11d450bc50SJiri Olsa--------
12d450bc50SJiri Olsa[verse]
13d450bc50SJiri Olsa'perf daemon'
14d450bc50SJiri Olsa'perf daemon' [<options>]
15d450bc50SJiri Olsa'perf daemon start'  [<options>]
1623c5831eSJiri Olsa'perf daemon stop'   [<options>]
172d6914cdSJiri Olsa'perf daemon signal' [<options>]
18d450bc50SJiri Olsa
19d450bc50SJiri Olsa
20d450bc50SJiri OlsaDESCRIPTION
21d450bc50SJiri Olsa-----------
22d450bc50SJiri OlsaThis command allows to run simple daemon process that starts and
23d450bc50SJiri Olsamonitors configured record sessions.
24d450bc50SJiri Olsa
25c0666261SJiri OlsaYou can imagine 'perf daemon' of background process with several
26c0666261SJiri Olsa'perf record' child tasks, like:
27c0666261SJiri Olsa
28c0666261SJiri Olsa  # ps axjf
29c0666261SJiri Olsa  ...
30c0666261SJiri Olsa       1  916507 ... perf daemon start
31c0666261SJiri Olsa  916507  916508 ...  \_ perf record --control=fifo:control,ack -m 10M -e cycles --overwrite --switch-output -a
32c0666261SJiri Olsa  916507  916509 ...  \_ perf record --control=fifo:control,ack -m 20M -e sched:* --overwrite --switch-output -a
33c0666261SJiri Olsa
34c0666261SJiri OlsaNot every 'perf record' session is suitable for running under daemon.
35c0666261SJiri OlsaUser need perf session that either produces data on query, like the
36c0666261SJiri Olsaflight recorder sessions in above example or session that is configured
37c0666261SJiri Olsato produce data periodically, like with --switch-output configuration
38c0666261SJiri Olsafor time and size.
39d450bc50SJiri Olsa
40d450bc50SJiri OlsaOPTIONS
41d450bc50SJiri Olsa-------
42d450bc50SJiri Olsa-v::
43d450bc50SJiri Olsa--verbose::
44d450bc50SJiri Olsa	Be more verbose.
45d450bc50SJiri Olsa
46fc1dcb1eSJiri Olsa--config=<PATH>::
47fc1dcb1eSJiri Olsa	Config file path. If not provided, perf will check system and default
48fc1dcb1eSJiri Olsa	locations (/etc/perfconfig, $HOME/.perfconfig).
49fc1dcb1eSJiri Olsa
505631d100SJiri Olsa--base=<PATH>::
515631d100SJiri Olsa	Base directory path. Each daemon instance is running on top
525631d100SJiri Olsa	of base directory.
535631d100SJiri Olsa
54d450bc50SJiri OlsaAll generic options are available also under commands.
55d450bc50SJiri Olsa
56d450bc50SJiri Olsa
57d450bc50SJiri OlsaSTART COMMAND
58d450bc50SJiri Olsa-------------
59d450bc50SJiri OlsaThe start command creates the daemon process.
60d450bc50SJiri Olsa
6188adb119SJiri Olsa-f::
6288adb119SJiri Olsa--foreground::
6388adb119SJiri Olsa	Do not put the process in background.
6488adb119SJiri Olsa
65d450bc50SJiri Olsa
6623c5831eSJiri OlsaSTOP COMMAND
6723c5831eSJiri Olsa------------
6823c5831eSJiri OlsaThe stop command stops all the session and the daemon process.
6923c5831eSJiri Olsa
7023c5831eSJiri Olsa
712d6914cdSJiri OlsaSIGNAL COMMAND
722d6914cdSJiri Olsa--------------
732d6914cdSJiri OlsaThe signal command sends signal to configured sessions.
742d6914cdSJiri Olsa
752d6914cdSJiri Olsa--session::
762d6914cdSJiri Olsa	Send signal to specific session.
772d6914cdSJiri Olsa
782d6914cdSJiri Olsa
79c0666261SJiri OlsaCONFIG FILE
80c0666261SJiri Olsa-----------
81c0666261SJiri OlsaThe daemon is configured within standard perf config file by
82c0666261SJiri Olsafollowing new variables:
83c0666261SJiri Olsa
84c0666261SJiri Olsadaemon.base:
85c0666261SJiri Olsa	Base path for daemon data. All sessions data are
86c0666261SJiri Olsa	stored under this path.
87c0666261SJiri Olsa
88c0666261SJiri Olsasession-<NAME>.run:
89c0666261SJiri Olsa	Defines new record session. The value is record's command
90c0666261SJiri Olsa	line without the 'record' keyword.
91c0666261SJiri Olsa
92c0666261SJiri OlsaEach perf record session is run in daemon.base/<NAME> directory.
93c0666261SJiri Olsa
94c0666261SJiri Olsa
95d450bc50SJiri OlsaSEE ALSO
96d450bc50SJiri Olsa--------
97d450bc50SJiri Olsalinkperf:perf-record[1], linkperf:perf-config[1]
98