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