LTTNG-RELAYD(8): document the --fd-pool-size option

[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 a4ac4343122eb31a60b9712db20fb7e21f4d3169..e70242d46170ff779487d800fd010e14e1ca07bf 100644 (file)
--- a/doc/man/lttng-relayd.8.txt
+++ b/doc/man/lttng-relayd.8.txt
@@ -1,5 +1,6 @@
 lttng-relayd(8)
 ===============
 lttng-relayd(8)
 ===============

+:revdate: 5 June 2018

 
 
 NAME
 
 
 NAME


@@ -11,13 +12,14 @@ SYNOPSIS
 --------
 [verse]
 *lttng-relayd* [option:--background | option:--daemonize]
 --------
 [verse]
 *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:--control-port='URL'] [option:--data-port='URL'] [option:--fd-pool-size='COUNT']
+             [option:--live-port='URL'] [option:--output='PATH']
+             [option:-v | option:-vv | option:-vvv] [option:--working-directory='PATH']
+             [option:--group-output-by-session | option:--group-output-by-host]

 
 DESCRIPTION
 -----------
 
 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.
 
 source software package used for correlated tracing of the Linux kernel,
 user applications, and user libraries.
 


@@ -38,7 +40,7 @@ it can write to the output directory and listen on the configured ports.
 If a user is within a secured network and/or has proper firewall
 settings, `lttng-relayd` can listen to LTTng live connections from _all_
 network interfaces by specifying
 If a user is within a secured network and/or has proper firewall
 settings, `lttng-relayd` can listen to LTTng live connections from _all_
 network interfaces by specifying

-+--live-port=tcp://{default_network_viewer_bind_address}:{default_network_viewer_port}+.
++--live-port=tcp://0.0.0.0:{default_network_viewer_port}+.

 
 Once a trace has been streamed completely, the trace can be processed by
 any tool that can process an LTTng trace located on the local
 
 Once a trace has been streamed completely, the trace can be processed by
 any tool that can process an LTTng trace located on the local


@@ -48,7 +50,8 @@ file system.
 [[output-directory]]
 Output directory
 ~~~~~~~~~~~~~~~~
 [[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'
 
 [verse]
 $LTTNG_HOME/lttng-traces/'HOSTNAME'/'SESSION'/'DOMAIN'


@@ -64,10 +67,23 @@ with:
 'DOMAIN'::
     Tracing domain.
 
 '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.
 
 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.
 

+Grouping by session is not supported for peers with version inferior to 2.4.
+In such cases, the grouping of output for that particular peer will be per host
+(default).
+
+A best effort backward compatibility is done for peers version greater or equal to
+2.4 and smaller than 2.11.

 
 [[url-format]]
 URL format
 
 [[url-format]]
 URL format


@@ -105,6 +121,12 @@ option:-d, option:--daemonize::
     option:--background option instead to keep the file descriptors
     open.
 
     option:--background option instead to keep the file descriptors
     open.
 

+option:--fd-pool-size='SIZE'::
+    Set the size of the file descriptor pool. This effectively sets a
+    limit on the number of file descriptors that may be kept open
+    simultaneously by the daemon (default: the soft `RLIMIT_NOFILE` resource
+    limit of the process).
+

 option:-g 'GROUP', option:--group='GROUP'::
     Use 'GROUP' as Unix tracing group (default: `tracing`).
 
 option:-g 'GROUP', option:--group='GROUP'::
     Use 'GROUP' as Unix tracing group (default: `tracing`).
 


@@ -114,6 +136,21 @@ option:-o 'PATH', option:--output='PATH'::
 See the <<output-directory,Output directory>> section above for more
 information.
 
 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:-w 'PATH', option:--working-directory='PATH'::
+    Set the working directory of the processes this relay daemon creates.
+

 option:-v, option:--verbose::
     Increase verbosity.
 +
 option:-v, option:--verbose::
     Increase verbosity.
 +


@@ -159,6 +196,10 @@ ENVIRONMENT VARIABLES
     Socket connection, receive and send timeout (milliseconds). A value
     of 0 or -1 uses the timeout of the operating system (default).
 
     Socket connection, receive and send timeout (milliseconds). A value
     of 0 or -1 uses the timeout of the operating system (default).
 

+`LTTNG_RELAYD_DISALLOW_CLEAR`::
+    Set to 1 to disallow the use of lttng-clear(1) on sessions collected by
+    this relay daemon.
+

 `LTTNG_RELAYD_HEALTH`::
     Path to relay daemon health's socket.
 
 `LTTNG_RELAYD_HEALTH`::
     Path to relay daemon health's socket.
 


@@ -216,6 +257,11 @@ Supported on Linux only.
 +
 Search for `tcp_keepalive_intvl` in man:tcp(7) for more information.
 
 +
 Search for `tcp_keepalive_intvl` in man:tcp(7) for more information.
 

+`LTTNG_RELAYD_WORKING_DIRECTORY`::
+    Working directory of the processes this relay daemon creates.
++
+The option:--working-directory option overrides this variable.
+

 
 FILES
 -----
 
 FILES
 -----