Backport: Man: --group-output-by-session

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

diff --git a/doc/man/lttng-relayd.8.txt b/doc/man/lttng-relayd.8.txt
index 218526a1a3f9abe206c8a8275ea953289f107141..e3dd3d9a4cfaab7e8c1627523aec85d3806a4841 100644 (file)
--- a/doc/man/lttng-relayd.8.txt
+++ b/doc/man/lttng-relayd.8.txt
@@ -13,6 +13,7 @@ SYNOPSIS
 *lttng-relayd* [option:--background | option:--daemonize]
              [option:--control-port='URL'] [option:--data-port='URL'] [option:--live-port='URL']
              [option:--output='PATH'] [option:-v | option:-vv | option:-vvv]
+             [option:--working-directory='PATH']
 
 
 DESCRIPTION
@@ -48,7 +49,8 @@ file system.
 [[output-directory]]
 Output directory
 ~~~~~~~~~~~~~~~~
-By default, the relay daemon writes the traces to:
+By default (option:--group-output-by-host), the relay daemon writes the traces
+to:
 
 [verse]
 $LTTNG_HOME/lttng-traces/'HOSTNAME'/'SESSION'/'DOMAIN'
@@ -64,11 +66,19 @@ with:
 'DOMAIN'::
     Tracing domain.
 
+You can group the output per session instead of per hostname with the
+option:--group-output-by-session option. This result in the following:
+
+[verse]
+
+$LTTNG_HOME/lttng-traces/'SESSION'/'HOST'/'DOMAIN'
+
 You can override the default output directory prefix
 (`$LTTNG_HOME/lttng-traces`) with the option:--output option. The other
 parts depend on the remote configuration.
 
 
+
 [[url-format]]
 URL format
 ~~~~~~~~~~
@@ -114,8 +124,23 @@ option:-o 'PATH', option:--output='PATH'::
 See the <<output-directory,Output directory>> section above for more
 information.
 
+option:-p, option:--group-output-by-host::
+    Organize the output directory by host. Default behavior.
++
+See the <<output-directory,Output directory>> section above for more
+information.
+
+option:-s, option:--group-output-by-session::
+    Organize the output directory by session.
++
+See the <<output-directory,Output directory>> section above for more
+information.
+
 option:-v, option:--verbose::
     Increase verbosity.
+
+option:-w 'PATH', option:--working-directory='PATH'::
+    Set the working directory of the processes this relay daemon creates.
 +
 Three levels of verbosity are available, which are triggered by
 appending additional `v` letters to the option
@@ -162,6 +187,60 @@ ENVIRONMENT VARIABLES
 `LTTNG_RELAYD_HEALTH`::
     Path to relay daemon health's socket.
 
+`LTTNG_RELAYD_TCP_KEEP_ALIVE`::
+    Set to 1 to enable TCP keep-alive.
++
+The TCP keep-alive mechanism allows the detection of dead peers
+(man:lttng-sessiond(8)) in cases of unclean termination
+(for example, a hard reset) of a peer.
++
+Supported on Linux and Solaris only. The default behaviour of the TCP
+keep-alive mechanism is OS-specific.
++
+Search for `tcp_keepalive` in man:tcp(7) for more information.
+
+`LTTNG_RELAYD_TCP_KEEP_ALIVE_ABORT_THRESHOLD`::
+   The time threshold in seconds to abort a TCP connection after the keep-alive
+   probing mechanism has failed.
++
+Set to 0 or -1 to use the value chosen by the operating system (default).
++
+Supported on Solaris 11 only.
++
+Search for `tcp_keepalive_abort_threshold` in man:tcp(7) for more information.
+
+`LTTNG_RELAYD_TCP_KEEP_ALIVE_IDLE_TIME`::
+    Number of seconds a connection needs to be idle before TCP begins
+    sending out keep-alive probes.
++
+Set to 0 or -1 to use the value chosen by the operating system (default).
++
+Supported on Linux and Solaris 11 only.
++
+On Solaris{nbsp}11, the accepted values are -1, 0, and 10 to 864000.
++
+Search for `tcp_keepalive_time` and `tcp_keepalive_interval`
+in man:tcp(7) on Solaris 11 for more information.
+
+`LTTNG_RELAYD_TCP_KEEP_ALIVE_MAX_PROBE_COUNT`::
+    Maximum number of TCP keep-alive probes to send before giving up and
+    killing the connection if no response is obtained from the other end.
++
+Set to 0 or -1 to use the value chosen by the operating system (default).
++
+Supported on Linux only.
++
+Search for `tcp_keepalive_probes` in man:tcp(7) for more information.
+
+`LTTNG_RELAYD_TCP_KEEP_ALIVE_PROBE_INTERVAL`::
+    Number of seconds between TCP keep-alive probes.
++
+Set to 0 or -1 to use the value chosen by the operating system (default).
++
+Supported on Linux only.
++
+Search for `tcp_keepalive_intvl` in man:tcp(7) for more information.
+
 
 FILES
 -----