A man page, describing trace-cmd agent sub command. Signed-off-by: Tzvetomir Stoyanov (VMware) <tz.stoyanov@xxxxxxxxx> --- Documentation/trace-cmd-agent.1.txt | 75 +++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 Documentation/trace-cmd-agent.1.txt diff --git a/Documentation/trace-cmd-agent.1.txt b/Documentation/trace-cmd-agent.1.txt new file mode 100644 index 0000000..a803d36 --- /dev/null +++ b/Documentation/trace-cmd-agent.1.txt @@ -0,0 +1,75 @@ +TRACE-CMD-AGENT(1) +================== + +NAME +---- +trace-cmd-agent - run trace-cmd in an agent mode + +SYNOPSIS +-------- +*trace-cmd agent* ['OPTIONS'] + +DESCRIPTION +----------- +The trace-cmd(1) can be used to gather simultaneously tracing information from +host and guests virtual machines, running on that host. The trace-cmd(1) agent +runs in the guest context, listening for incoming tracing requests from +the host. When a request is received, the agent starts the tracing, reads the +tracing data and streams them to the host. The host gathers tracing data from +all guests and stores it in trace.dat files, one for each guest. +The communication between host and guest is through VSOCKs, so the OS must +support for it. + +OPTIONS +------- +*-p* 'port':: + Listen for incoming tracing requests on the specified port. The option is + not mandatory, by default the agent listens on port 823. + +*-D*:: + Run the agent in daemon mode. + +*--debug*:: + Run the agent in debug mode: + - no fork(), the tracing is performed in the main process + - no timeout when waiting for an incoming control message, wait forever + - print information about every sent and received control messages + +EXAMPLES +-------- + +Run the agent on the guest: +------------------------------ + # trace-cmd agend -D +------------------------------ + +Run the tracing on the host for kvm and sched events and reguest guest tracing +for all events. The guest is addressed by its name, GuestName in this example: +------------------------------ +# trace-cmd record -e kvm -e sched -A GuestName -e all +------------------------------ + +As a result of this tracing session, two trace files will be generated: +------------------------------ +trace.dat - host tracing data +trace-GuestName.dat - guest tracing data +------------------------------ + + +SEE ALSO +-------- +trace-cmd(1), trace-cmd-record(1), trace-cmd-listen(1) + +AUTHOR +------ +Written by Steven Rostedt, <rostedt@xxxxxxxxxxx> + +RESOURCES +--------- +git://git.kernel.org/pub/scm/linux/kernel/git/rostedt/trace-cmd.git + +COPYING +------- +Copyright \(C) 2010 Red Hat, Inc. Free use of this software is granted under +the terms of the GNU Public License (GPL). + -- 2.24.1
|