xref: /aosp_15_r20/external/trace-cmd/Documentation/trace-cmd/trace-cmd-agent.1.txt (revision 58e6ee5f017f6a8912852c892d18457e4bafb554)
1*58e6ee5fSAndroid Build Coastguard WorkerTRACE-CMD-AGENT(1)
2*58e6ee5fSAndroid Build Coastguard Worker==================
3*58e6ee5fSAndroid Build Coastguard Worker
4*58e6ee5fSAndroid Build Coastguard WorkerNAME
5*58e6ee5fSAndroid Build Coastguard Worker----
6*58e6ee5fSAndroid Build Coastguard Workertrace-cmd-agent - Run as an agent on a machine (to be controlled by another machine)
7*58e6ee5fSAndroid Build Coastguard Worker
8*58e6ee5fSAndroid Build Coastguard WorkerSYNOPSIS
9*58e6ee5fSAndroid Build Coastguard Worker--------
10*58e6ee5fSAndroid Build Coastguard Worker*trace-cmd agent* ['OPTIONS']
11*58e6ee5fSAndroid Build Coastguard Worker
12*58e6ee5fSAndroid Build Coastguard WorkerDESCRIPTION
13*58e6ee5fSAndroid Build Coastguard Worker-----------
14*58e6ee5fSAndroid Build Coastguard WorkerThe trace-cmd(1) agent listens over a vsocket (for virtual machines) or a TCP port
15*58e6ee5fSAndroid Build Coastguard Workerfor connections to control the tracing of the machine. The agent will then start
16*58e6ee5fSAndroid Build Coastguard Workertracing on the local machine and pass the data to the controlling connection.
17*58e6ee5fSAndroid Build Coastguard Worker
18*58e6ee5fSAndroid Build Coastguard WorkerOPTIONS
19*58e6ee5fSAndroid Build Coastguard Worker-------
20*58e6ee5fSAndroid Build Coastguard Worker*-N* 'client'::
21*58e6ee5fSAndroid Build Coastguard Worker    Listen over TCP instead of a vsocket. Must pass in a client host name or IP address
22*58e6ee5fSAndroid Build Coastguard Worker    to allow connection to. It will only connect to the specified client. Note, any process
23*58e6ee5fSAndroid Build Coastguard Worker    on that client can control the agent.
24*58e6ee5fSAndroid Build Coastguard Worker
25*58e6ee5fSAndroid Build Coastguard Worker    *This is a very insecure setting. Only use on a trusted network*
26*58e6ee5fSAndroid Build Coastguard Worker    *Only use if the client machine is totally trusted*
27*58e6ee5fSAndroid Build Coastguard Worker
28*58e6ee5fSAndroid Build Coastguard Worker*-p* 'port'::
29*58e6ee5fSAndroid Build Coastguard Worker    This option will specify the port to listen to.
30*58e6ee5fSAndroid Build Coastguard Worker
31*58e6ee5fSAndroid Build Coastguard Worker*-D*::
32*58e6ee5fSAndroid Build Coastguard Worker    This options causes trace-cmd agent to go into a daemon mode and run in
33*58e6ee5fSAndroid Build Coastguard Worker    the background.
34*58e6ee5fSAndroid Build Coastguard Worker
35*58e6ee5fSAndroid Build Coastguard Worker*--verbose*[='level']::
36*58e6ee5fSAndroid Build Coastguard Worker     Set the log level. Supported log levels are "none", "critical", "error", "warning",
37*58e6ee5fSAndroid Build Coastguard Worker     "info", "debug", "all" or their identifiers "0", "1", "2", "3", "4", "5", "6". Setting the log
38*58e6ee5fSAndroid Build Coastguard Worker     level to specific value enables all logs from that and all previous levels.
39*58e6ee5fSAndroid Build Coastguard Worker     The level will default to "info" if one is not specified.
40*58e6ee5fSAndroid Build Coastguard Worker
41*58e6ee5fSAndroid Build Coastguard Worker     Example: enable all critical, error and warning logs
42*58e6ee5fSAndroid Build Coastguard Worker
43*58e6ee5fSAndroid Build Coastguard Worker      trace-cmd listen --verbose=warning
44*58e6ee5fSAndroid Build Coastguard Worker
45*58e6ee5fSAndroid Build Coastguard WorkerSEE ALSO
46*58e6ee5fSAndroid Build Coastguard Worker--------
47*58e6ee5fSAndroid Build Coastguard Workertrace-cmd(1), trace-cmd-record(1), trace-cmd-report(1), trace-cmd-start(1),
48*58e6ee5fSAndroid Build Coastguard Workertrace-cmd-stop(1), trace-cmd-extract(1), trace-cmd-reset(1),
49*58e6ee5fSAndroid Build Coastguard Workertrace-cmd-split(1), trace-cmd-list(1)
50*58e6ee5fSAndroid Build Coastguard Worker
51*58e6ee5fSAndroid Build Coastguard WorkerAUTHOR
52*58e6ee5fSAndroid Build Coastguard Worker------
53*58e6ee5fSAndroid Build Coastguard WorkerWritten by Steven Rostedt, <[email protected]>
54*58e6ee5fSAndroid Build Coastguard Worker
55*58e6ee5fSAndroid Build Coastguard WorkerRESOURCES
56*58e6ee5fSAndroid Build Coastguard Worker---------
57*58e6ee5fSAndroid Build Coastguard Workerhttps://git.kernel.org/pub/scm/utils/trace-cmd/trace-cmd.git/
58*58e6ee5fSAndroid Build Coastguard Worker
59*58e6ee5fSAndroid Build Coastguard WorkerCOPYING
60*58e6ee5fSAndroid Build Coastguard Worker-------
61*58e6ee5fSAndroid Build Coastguard WorkerCopyright \(C) 2010 Red Hat, Inc. Free use of this software is granted under
62*58e6ee5fSAndroid Build Coastguard Workerthe terms of the GNU Public License (GPL).
63