Fix: relayd should listen for viewers on localhost only by default

[lttng-tools.git] / doc / man / lttng-relayd.8

diff --git a/doc/man/lttng-relayd.8 b/doc/man/lttng-relayd.8
index 4c9217a9c46e4871fa48a66de4341f5913c8e376..1e1e66407172269d9c83c3fe195b7f36e50da5d2 100644 (file)
--- 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.
 
 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
 
 By default, the relayd outputs the traces in :
 ~/lttng-traces/hostname/session-name/domain-name


@@ -53,6 +59,9 @@ Start as a daemon
 .BR "-b, --background"
 Start as a daemon, keeping console open
 .TP
 .BR "-b, --background"
 Start as a daemon, keeping console open
 .TP

+.BR "-g, --group NAME"
+Specify the tracing group name. (default: tracing)
+.TP

 .BR "-C, --control-port"
 Control port URL (tcp://0.0.0.0:5342 is the default)
 .TP
 .BR "-C, --control-port"
 Control port URL (tcp://0.0.0.0:5342 is the default)
 .TP


@@ -60,7 +69,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"
 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)
 .TP
 .BR "-o, --output"
 Output base directory. Must use an absolute path (~/lttng-traces is the default)