projects / lttng-tools.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
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 3f6759e166110a731b586c772ced9fbd8e9cfdf9..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.
 
@@ -37,7 +39,8 @@ The relay daemon does not require any particular permissions, as long as
 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_
 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 `--live-port=tcp://0.0.0.0:5344`.
+network interfaces by specifying
++--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
@@ -47,10 +50,11 @@ 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]
 
 [verse]
-$HOME/lttng-traces/'HOSTNAME'/'SESSION'/'DOMAIN'
+$LTTNG_HOME/lttng-traces/'HOSTNAME'/'SESSION'/'DOMAIN'
 
 with:
 
 
 with:
 
@@ -63,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
 You can override the default output directory prefix
-(`$HOME/lttng-traces`) with the option:--output option. The other
+(`$LTTNG_HOME/lttng-traces`) with the option:--output option. The other
 parts depend on the remote configuration.
 
 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
@@ -104,15 +121,36 @@ 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:-g, option:--group='GROUP'::
+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`).
 
     Use 'GROUP' as Unix tracing group (default: `tracing`).
 
-option:-o, option:--output='PATH'::
+option:-o 'PATH', option:--output='PATH'::
     Set base directory of written trace data to 'PATH'.
 +
 See the <<output-directory,Output directory>> section above for more
 information.
 
     Set base directory of written trace data to '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:-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.
 +
@@ -126,15 +164,18 @@ Ports
 See the <<url-format,URL format>> section above for more information
 about the syntax of the following options' 'URL' argument.
 
 See the <<url-format,URL format>> section above for more information
 about the syntax of the following options' 'URL' argument.
 
-option:-C, option:--control-port='URL'::
-    Listen to control data on URL 'URL' (default: `tcp://0.0.0.0:5342`).
+option:-C 'URL', option:--control-port='URL'::
+    Listen to control data on URL 'URL' (default:
+    +tcp://{default_network_control_bind_address}:{default_network_control_port}+).
 
 
-option:-D, option:--data-port='URL'::
-    Listen to trace data on URL 'URL' (default: `tcp://0.0.0.0:5343`).
+option:-D 'URL', option:--data-port='URL'::
+    Listen to trace data on URL 'URL' (default:
+    +tcp://{default_network_data_bind_address}:{default_network_data_port}+).
 
 
-option:-L, option:--live-port='URL'::
+option:-L 'URL', option:--live-port='URL'::
     Listen to LTTng live connections on URL 'URL'
     Listen to LTTng live connections on URL 'URL'
-    (default: `tcp://0.0.0.0:5344`).
+    (default:
+    +tcp://{default_network_viewer_bind_address}:{default_network_viewer_port}+).
 
 
 Program information
 
 
 Program information
@@ -148,13 +189,79 @@ option:-V, option:--version::
 
 ENVIRONMENT VARIABLES
 ---------------------
 
 ENVIRONMENT VARIABLES
 ---------------------
+`LTTNG_ABORT_ON_ERROR`::
+    Set to 1 to abort the process after the first error is encountered.
+
 `LTTNG_NETWORK_SOCKET_TIMEOUT`::
     Socket connection, receive and send timeout (milliseconds). A value
     of 0 or -1 uses the timeout of the operating system (default).
 
 `LTTNG_NETWORK_SOCKET_TIMEOUT`::
     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.
 
+`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.
+
+`LTTNG_RELAYD_WORKING_DIRECTORY`::
+    Working directory of the processes this relay daemon creates.
++
+The option:--working-directory option overrides this variable.
+
 
 FILES
 -----
 
 FILES
 -----
@@ -198,8 +305,8 @@ include::common-footer.txt[]
 
 SEE ALSO
 --------
 
 SEE ALSO
 --------
-linklttng:lttng(1),
-linklttng:lttng-sessiond(8),
-linklttng:lttng-crash(1),
-linklttng:lttng-ust(3),
-linklttng:babeltrace(1)
+man:lttng(1),
+man:lttng-sessiond(8),
+man:lttng-crash(1),
+man:lttng-ust(3),
+man:babeltrace(1)
LTTng tools - Deliverables
This page took 0.02942 seconds and 5 git commands to generate.