[lttng-tools,v2,2/2] man: document dead-peer detection for relayd
diff mbox series

Message ID 20171005220645.11734-2-jonathan.rajotte-julien@efficios.com
State Superseded
Headers show
Series
  • [lttng-tools,v2,1/2] lttng-relayd: use tcp keep-alive mechanism to detect dead-peer
Related show

Commit Message

Jonathan Rajotte Oct. 5, 2017, 10:06 p.m. UTC
Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien at efficios.com>
---
 doc/man/lttng-relayd.8.txt | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

Patch
diff mbox series

diff --git a/doc/man/lttng-relayd.8.txt b/doc/man/lttng-relayd.8.txt
index 218526a1..e37ce845 100644
--- a/doc/man/lttng-relayd.8.txt
+++ b/doc/man/lttng-relayd.8.txt
@@ -162,6 +162,25 @@  ENVIRONMENT VARIABLES
 `LTTNG_RELAYD_HEALTH`::
     Path to relay daemon health's socket.
 
+`LTTNG_RELAYD_TCP_KEEP_ALIVE_ENABLE`::
+    Set to 1 to enable the use of tcp keep-alive allowing the detection of dead
+    peers.
+
+`LTTNG_RELAYD_TCP_KEEP_ALIVE_TIME`::
+    See tcp(7) tcp_keepalive_time or tcp_keepalive_interval on Solaris 11.
+    A value of -1 lets the operating system manage this parameter (default).
+
+`LTTNG_RELAYD_TCP_KEEP_ALIVE_PROBES`::
+    See tcp(7) tcp_keepalive_probes.
+    A value of -1 lets the operating system manage this parameter (default).
+
+NOTE: Not supported on Solaris.
+
+`LTTNG_RELAYD_TCP_KEEP_ALIVE_INTVL`::
+    See tcp(7) tcp_keepalive_intvl.
+    A value of -1 lets the operating system manage this parameter (default).
+
+NOTE: Not supported on Solaris.
 
 FILES
 -----