tools/perf/Documentation/perf-daemon.txt

   1 perf-daemon(1)
   2 ==============
   3
   4
   5 NAME
   6 ----
   7 perf-daemon - Run record sessions on background
   8
   9
  10 SYNOPSIS
  11 --------
  12 [verse]
  13 'perf daemon'
  14 'perf daemon' [<options>]
  15 'perf daemon start'  [<options>]
  16 'perf daemon stop'   [<options>]
  17 'perf daemon signal' [<options>]
  18
  19
  20 DESCRIPTION
  21 -----------
  22 This command allows to run simple daemon process that starts and
  23 monitors configured record sessions.
  24
  25 You can imagine 'perf daemon' of background process with several
  26 'perf record' child tasks, like:
  27
  28   # ps axjf
  29   ...
  30        1  916507 ... perf daemon start
  31   916507  916508 ...  \_ perf record --control=fifo:control,ack -m 10M -e cycles --overwrite --switch-output -a
  32   916507  916509 ...  \_ perf record --control=fifo:control,ack -m 20M -e sched:* --overwrite --switch-output -a
  33
  34 Not every 'perf record' session is suitable for running under daemon.
  35 User need perf session that either produces data on query, like the
  36 flight recorder sessions in above example or session that is configured
  37 to produce data periodically, like with --switch-output configuration
  38 for time and size.
  39
  40 OPTIONS
  41 -------
  42 -v::
  43 --verbose::
  44         Be more verbose.
  45
  46 --config=<PATH>::
  47         Config file path. If not provided, perf will check system and default
  48         locations (/etc/perfconfig, $HOME/.perfconfig).
  49
  50 --base=<PATH>::
  51         Base directory path. Each daemon instance is running on top
  52         of base directory.
  53
  54 All generic options are available also under commands.
  55
  56
  57 START COMMAND
  58 -------------
  59 The start command creates the daemon process.
  60
  61 -f::
  62 --foreground::
  63         Do not put the process in background.
  64
  65
  66 STOP COMMAND
  67 ------------
  68 The stop command stops all the session and the daemon process.
  69
  70
  71 SIGNAL COMMAND
  72 --------------
  73 The signal command sends signal to configured sessions.
  74
  75 --session::
  76         Send signal to specific session.
  77
  78
  79 CONFIG FILE
  80 -----------
  81 The daemon is configured within standard perf config file by
  82 following new variables:
  83
  84 daemon.base:
  85         Base path for daemon data. All sessions data are
  86         stored under this path.
  87
  88 session-<NAME>.run:
  89         Defines new record session. The value is record's command
  90         line without the 'record' keyword.
  91
  92 Each perf record session is run in daemon.base/<NAME> directory.
  93
  94
  95 SEE ALSO
  96 --------
  97 linkperf:perf-record[1], linkperf:perf-config[1]