From ebbd679f2e8b43e48ac97d76a7fe13fc4f44e576 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Mon, 17 May 2021 14:04:31 -0400 Subject: [PATCH] lttng-create(1): add usage examples 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: I2371a84eac9310b6725462ea4278d01497c3e7f4 --- doc/man/lttng-create.1.txt | 110 ++++++++++++++++++++++++++++++++++++- 1 file changed, 109 insertions(+), 1 deletion(-) diff --git a/doc/man/lttng-create.1.txt b/doc/man/lttng-create.1.txt index 6ebdcb78a..a1bf9d80e 100644 --- a/doc/man/lttng-create.1.txt +++ b/doc/man/lttng-create.1.txt @@ -1,6 +1,6 @@ lttng-create(1) =============== -:revdate: 12 May 2021 +:revdate: 17 May 2021 NAME @@ -91,6 +91,8 @@ 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. +See the <> section below for usage examples. + Show the status of the current tracing session with the man:lttng-status(1) command. @@ -392,6 +394,112 @@ include::common-lttng-cmd-help-options.txt[] include::common-lttng-cmd-after-options.txt[] +[[examples]] +EXAMPLES +-------- +.Create a normal mode tracing session with a generated name. +==== +[role="term"] +---- +$ lttng create +---- +==== + +.Create a normal mode tracing session with a custom name. +==== +[role="term"] +---- +$ lttng create my-session +---- +==== + +.Create a normal mode tracing session with a specific output directory. +==== +See the option:--output option. + +[role="term"] +---- +$ lttng create --output=/path/to/traces +---- +==== + +.Create a network streaming mode tracing session. +==== +See the ``Output directory'' section of man:lttng-relayd(8) to +understand where the relay daemon to connect to (`10.0.0.242`) writes +the received traces. + +See the option:--set-url option. + +[role="term"] +---- +$ lttng create --set-url=net://10.0.0.242/inv4 +---- +==== + +.Create a snapshot mode tracing session with a default snapshot output. +==== +See the option:--snapshot option. + +[role="term"] +---- +$ lttng create --snapshot +---- +==== + +.Create a snapshot mode tracing session with a custom snapshot output. +==== +See the option:--snapshot and option:--set-url options. + +[role="term"] +---- +$ lttng create --snapshot \ + --set-url=tcp://192.168.1.102:1234:5678/my-snapshots +---- +==== + +.Create a snapshot mode tracing session with no snapshot output. +==== +See the option:--snapshot and option:--no-output options. + +[role="term"] +---- +$ lttng create --snapshot --no-output +---- +==== + +.Create an LTTng live mode tracing session with a default relay daemon URL. +==== +See the option:--live option. + +[role="term"] +---- +$ lttng create --live +---- +==== + +.Create an LTTng live mode tracing session with a custom live timer period and relay daemon URL. +==== +See the option:--live and option:--set-url options. + +[role="term"] +---- +$ lttng create --live=250000 \ + --set-url=tcp://relayd34:4885:4886 +---- +==== + +.Create a normal mode tracing session with a custom directory containing the ring buffer shared memory files. +==== +See the option:--shm-path option. + +[role="term"] +---- +$ lttng create my-session --shm-path=/mnt/nvram2/lttng +---- +==== + + include::common-footer.txt[] -- 2.34.1