From: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Date: Wed, 27 Jun 2018 00:48:24 +0000 (-0400)
Subject: Docs: RELAYD(8): document the --group-output-by-session/host options
X-Git-Tag: v2.12.0-rc1~247
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=04dedfc0d1355fb579409fc3f27e84120f359a62;p=lttng-tools.git

Docs: RELAYD(8): document the --group-output-by-session/host options

Add the description of the newly-introduced --group-output-by-session
and --group-output-by-host options.

Signed-off-by: Jonathan Rajotte <jonathan.rajotte-julien@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

diff --git a/doc/man/lttng-relayd.8.txt b/doc/man/lttng-relayd.8.txt
index 61ff26773..87135c4eb 100644
--- a/doc/man/lttng-relayd.8.txt
+++ b/doc/man/lttng-relayd.8.txt
@@ -15,7 +15,7 @@ SYNOPSIS
              [option:--control-port='URL'] [option:--data-port='URL'] [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
 -----------
@@ -50,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'
@@ -66,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
@@ -116,6 +130,18 @@ option:-o 'PATH', option:--output='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.