From efacf910532303b8208a2e68a002e54c8b810f6b Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Wed, 12 May 2021 22:52:25 -0400 Subject: [PATCH] lttng(1)/lttng-create(1): document `--relayd-path` MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau Change-Id: I83d65e13834593c97e296db2505dc97f6a8e4568 --- doc/man/lttng-create.1.txt | 39 +++++++++++++++++++++++++++++++------ doc/man/lttng.1.txt | 40 +++++++++++++++++++++++++++++++------- 2 files changed, 66 insertions(+), 13 deletions(-) diff --git a/doc/man/lttng-create.1.txt b/doc/man/lttng-create.1.txt index 5b5f7b62e..6ebdcb78a 100644 --- a/doc/man/lttng-create.1.txt +++ b/doc/man/lttng-create.1.txt @@ -1,6 +1,6 @@ lttng-create(1) =============== -:revdate: 3 May 2021 +:revdate: 12 May 2021 NAME @@ -55,11 +55,38 @@ Specifying a location on an NVRAM file system makes it possible to recover the latest recorded trace data when the system reboots after a crash with the man:lttng-crash(1) utility. -By default, the `create` command automatically spawns a session daemon -for your Unix user if none is currently running. Override the path of -the session daemon binary to spawn with the general -genoption:--sessiond-path option. Avoid automatically spawning a session -daemon with the general genoption:--no-sessiond option. +By default, the `create` command automatically spawns: + +* A session daemon for your Unix user if none is currently running. ++ +Override the path of the session daemon binary to spawn with the +general genoption:--sessiond-path option. ++ +Avoid automatically spawning a session daemon with the general +genoption:--no-sessiond option. + +* A relay daemon (see man:lttng-relayd(8)) if all the following + statements are true: ++ +-- +* You specify the option:--live option. + +* You don't specify any of the option:--set-url, option:--ctrl-url, or + option:--data-url options. + +* No relay daemon is currently listening for TCP connections on + +127.0.0.1:{default_network_viewer_port}+ (default LTTng live reader + connection address and port). +-- ++ +In this case, the `create` command spawns a relay daemon as such: ++ +[verse] +*lttng-relayd* nloption:--live-port=**tcp://localhost:{default_network_viewer_port}** +{nbsp} ++ +Override the path of the relay daemon binary to spawn with the general +genoption:--relayd-path option. On success, the `create` command sets the current tracing session (see man:lttng-concepts(7) to learn more) to the created tracing session. diff --git a/doc/man/lttng.1.txt b/doc/man/lttng.1.txt index 0f8f24b9c..fff757a49 100644 --- a/doc/man/lttng.1.txt +++ b/doc/man/lttng.1.txt @@ -1,6 +1,6 @@ lttng(1) ======== -:revdate: 3 May 2021 +:revdate: 12 May 2021 NAME @@ -12,7 +12,8 @@ SYNOPSIS -------- [verse] *lttng* [option:--group='GROUP'] [option:--mi=**xml**] [option:--no-sessiond | option:--sessiond-path='PATH'] - [option:--quiet | option:-verbose...] '<>' ['COMMAND OPTIONS'] + [option:--relayd-path='PATH'] [option:--quiet | option:-verbose...] + '<>' ['COMMAND OPTIONS'] DESCRIPTION @@ -32,11 +33,32 @@ daemon: * Sends asynchronous notifications to user applications. -By default, the man:lttng-create(1) command automatically spawns a -session daemon for your Unix user if none is currently running. Override -the path of the session daemon binary to spawn with the -option:--sessiond-path option. Avoid automatically spawning a session -daemon with the option:--no-sessiond option. +By default, the man:lttng-create(1) command automatically spawns: + +* A session daemon for your Unix user if none is currently running. ++ +Override the path of the session daemon binary to spawn with the +option:--sessiond-path option. ++ +Avoid automatically spawning a session daemon with the +option:--no-sessiond option. + +* A relay daemon (see man:lttng-relayd(8)) if all the following + statements are true: ++ +-- +* You specify the nloption:--live option. + +* You don't specify any of the nloption:--set-url, nloption:--ctrl-url, + or nloption:--data-url options. + +* No relay daemon is currently listening for TCP connections on + +127.0.0.1:{default_network_viewer_port}+ (default LTTng live reader + connection address and port). +-- ++ +Override the path of the relay daemon binary to spawn with the +option:--relayd-path option. NOTE: The LTTng project recommends that you start the session daemon at boot time for stable and long-term tracing. @@ -134,6 +156,10 @@ option:--sessiond-path='PATH':: + You may :not: use this option with the option:--no-sessiond option. +option:--relayd-path='PATH':: + Set the absolute path of the relay daemon binary to spawn from the + man:lttng-create(1) command to 'PATH'. + option:-v, option:--verbose:: Increase verbosity. + -- 2.34.1