X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-relayd.8;h=3a51877a6aaa2a14f24b15c7f0917036cc81fd23;hp=e75711a6d069ee0f6dffb2fbf5b86efa37d97938;hb=c0fdca17a0132494a6750ddcbf4f8e076f7366ea;hpb=0210bba27680d0bc4278b926cad8b77eaa1b61ae diff --git a/doc/man/lttng-relayd.8 b/doc/man/lttng-relayd.8 index e75711a6d..3a51877a6 100644 --- a/doc/man/lttng-relayd.8 +++ b/doc/man/lttng-relayd.8 @@ -17,12 +17,18 @@ It's tracers help tracking down performance issues and debugging problems involving multiple concurrent processes and threads. Tracing across multiple systems is also possible. -The relay daemon listens on the network and receives traces streamed by a -remote consumer. This daemon does not require any particular permissions as -long as it can write in the output folder and listen on the ports. - -Once a trace has been streamed completely, the trace can be processed by any -tool that can process a local LTTng CTF trace. +The relay daemon listens by default on all network interfaces to gather +trace data, but only on localhost for viewer connections. This daemon +does not require any particular permissions as long as it can write in +the output folder and listen on the ports. If a user is within a secured +network and/or has proper firewall settings, lttng-relayd can listen to +viewer connections from all network interfaces by specifying '-L +tcp://0.0.0.0:5344'. + +Traces can be either viewed "live" (as they are produced) by attaching +to the live viewer port using LTTng live protocol, or after tracing has +been stopped. Once a trace has been streamed completely, the trace can +be processed by any tool that can process a local LTTng CTF trace. By default, the relayd outputs the traces in : ~/lttng-traces/hostname/session-name/domain-name @@ -33,14 +39,17 @@ sessiond side. .SH "OPTIONS" .PP -This program follow the usual GNU command line syntax with long options starting with -two dashes. Below is a summary of the available options. +This program follows the usual GNU command line syntax with long options starting +with two dashes. Below is a summary of the available options. .PP .TP .BR "-h, --help" Show summary of possible options and commands .TP +.BR "\-V, \-\-version" +Show version. +.TP .BR "-v, --verbose" Increase verbosity @@ -63,7 +72,7 @@ Control port URL (tcp://0.0.0.0:5342 is the default) Data port URL (tcp://0.0.0.0:5343 is the default) .TP .BR "-L, --live-port URL" -Live view port URL (tcp://0.0.0.0:5344 is the default). +Live view port URL (tcp://localhost:5344 is the default). .TP .BR "-o, --output" Output base directory. Must use an absolute path (~/lttng-traces is the default)