X-Git-Url: http://git.efficios.com/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-relayd.8.txt;h=2f41ec29bfae082b84ea0ccc5b3aa2961d41f918;hp=218526a1a3f9abe206c8a8275ea953289f107141;hb=4605890e0a926f1c88355051dcd6d8a8dd135c58;hpb=59b19c3c82a824b602b4e3cd70e1cb22448fcb9d diff --git a/doc/man/lttng-relayd.8.txt b/doc/man/lttng-relayd.8.txt index 218526a1a..2f41ec29b 100644 --- a/doc/man/lttng-relayd.8.txt +++ b/doc/man/lttng-relayd.8.txt @@ -1,5 +1,6 @@ lttng-relayd(8) =============== +:revdate: 5 June 2018 NAME @@ -17,7 +18,7 @@ SYNOPSIS DESCRIPTION ----------- -The http://lttng.org/[_Linux Trace Toolkit: next generation_] is an open +The https://lttng.org/[_Linux Trace Toolkit: next generation_] is an open source software package used for correlated tracing of the Linux kernel, user applications, and user libraries. @@ -162,6 +163,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 -----