From a840460a657e2369ec3b520b9243e5f9166447b8 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Mon, 17 May 2021 16:01:05 -0400 Subject: [PATCH] lttng-snapshot(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: I686f3c8a0e82952a5b673780eef830dea888044d --- doc/man/lttng-snapshot.1.txt | 60 +++++++++++++++++++++++++++++++++++- 1 file changed, 59 insertions(+), 1 deletion(-) diff --git a/doc/man/lttng-snapshot.1.txt b/doc/man/lttng-snapshot.1.txt index a65156f9c..b81adbc9d 100644 --- a/doc/man/lttng-snapshot.1.txt +++ b/doc/man/lttng-snapshot.1.txt @@ -1,6 +1,6 @@ lttng-snapshot(1) ================= -:revdate: 3 May 2021 +:revdate: 17 May 2021 NAME @@ -69,6 +69,8 @@ to use the `snapshot` command. A `snapshot-session` trigger action can also take a tracing session snapshot (see man:lttng-add-trigger(1)). +See the <> section below for usage examples. + If you want, instead, to keep all the trace data, but divide it into archived chunks which are then, like snapshots, ready to be processed, see the tracing session rotation feature in man:lttng-concepts(7). Trace @@ -190,6 +192,62 @@ include::common-lttng-cmd-help-options.txt[] include::common-lttng-cmd-after-options.txt[] +[[examples]] +EXAMPLES +-------- +.Take a snapshot of the current tracing session, sending the trace files to its snapshot output. +==== +[role="term"] +---- +$ lttng snapshot record +---- +==== + +.Take a snapshot of a specific tracing session, giving it a custom name. +==== +See the option:--session and option:--name options. + +[role="term"] +---- +$ lttng snapshot record --session=my-session --name=SNAP +---- +==== + +.Take a snapshot of the current tracing session, sending the trace files to a custom location. +==== +See the ``Output directory'' section of man:lttng-relayd(8) to +understand where the relay daemon to connect to (`3.96.87.215`) writes +the received traces. + +[role="term"] +---- +$ lttng snapshot record net://3.96.87.215 +---- +==== + +.Replace the snapshot output of a specific tracing session with a local file system path. +==== +See the option:--session option. + +[role="term"] +---- +$ lttng snapshot del-output --session=monk 1 +$ lttng snapshot add-output --session=monk \ + file:///path/to/snapshots +---- +==== + +.Take a snapshot of the current tracing session, making sure its size is not over 4{nbsp}MiB. +==== +See the option:--max-size option. + +[role="term"] +---- +$ lttng snapshot record --max-size=4M +---- +==== + + include::common-footer.txt[] -- 2.34.1