X-Git-Url: http://git.efficios.com/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-relayd.8.txt;h=e70242d46170ff779487d800fd010e14e1ca07bf;hp=218526a1a3f9abe206c8a8275ea953289f107141;hb=89751b0293d364dca2e6a89d85ab9e7c9cda8bf6;hpb=59b19c3c82a824b602b4e3cd70e1cb22448fcb9d diff --git a/doc/man/lttng-relayd.8.txt b/doc/man/lttng-relayd.8.txt index 218526a1a..e70242d46 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 @@ -11,13 +12,14 @@ SYNOPSIS -------- [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 ----------- -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. @@ -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 -+--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 @@ -48,7 +50,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,10 +67,23 @@ 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. +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 @@ -105,6 +121,12 @@ option:-d, option:--daemonize:: 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`). @@ -114,6 +136,21 @@ option:-o 'PATH', option:--output='PATH':: See the <> section above for more information. +option:-p, option:--group-output-by-host:: + Organize the output directory by host. Default behavior. ++ +See the <> section above for more +information. + +option:-s, option:--group-output-by-session:: + Organize the output directory by session. ++ +See the <> 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. + @@ -159,9 +196,72 @@ ENVIRONMENT VARIABLES 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_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 -----