File: lttng-stop.1.txt

package info (click to toggle)
ltt-control 2.14.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 21,860 kB
  • sloc: cpp: 192,012; sh: 28,777; ansic: 10,960; python: 7,108; makefile: 3,520; java: 109; xml: 46
file content (152 lines) | stat: -rw-r--r-- 3,473 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
lttng-stop(1)
=============
:revdate: 1 April 2025


NAME
----
lttng-stop - Stop one or more LTTng recording sessions


SYNOPSIS
--------
[verse]
*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *stop* [option:--no-wait]
      [option:--all | option:--glob='PATTERN' | 'SESSION']


DESCRIPTION
-----------
The `lttng stop` command stops one or more recording sessions, that is,
it deactivates the LTTng tracers for:

With the 'SESSION' argument::
    The recording session named 'SESSION'.

With the option:--glob='PATTERN' option::
    The recording sessions of which the globbing pattern
    'PATTERN' matches the name.

With the option:--all option::
    *All* the recording sessions of the connected session daemon for
    your Unix user, or for all users if your Unix user is `root`, as
    listed in the output of `lttng list` (see man:lttng-list(1)).
+
See the ``Session daemon connection'' section of man:lttng(1) to learn
how a user application connects to a session daemon.

Otherwise::
    The current recording session.
+
See man:lttng-concepts(7) to learn more about
the current recording session.

See man:lttng-concepts(7) to learn more about recording sessions.

The selected recording session(s) must be active (started; see
man:lttng-start(1)). A recording session is inactive on creation (see
man:lttng-create(1)).

A `stop-session` trigger action can also stop a recording session (see
man:lttng-add-trigger(1)).

Start one or more inactive recording sessions with the
man:lttng-start(1) command.

By default, the `stop` command ensures that the trace data of the
selected recording session(s) is valid before it exits. Make the command
exit immediately with the option:--no-wait option. In this case,
however, the traces(s) might not be valid when the command exits, and
there's no way to know when it/they becomes valid.

See the ``<<examples,EXAMPLES>>'' section below for usage examples.


include::common-lttng-cmd-options-head.txt[]


option:-a, option:--all::
    Stop all the recording sessions of your Unix user, or of all
    users if your Unix user is `root`, as listed in the output of
    man:lttng-list(1).

option:-g 'PATTERN', option:--glob='PATTERN'::
    Stop the recording sessions of which the
    globbing pattern 'PATTERN' matches the name.
+
In 'PATTERN', the `*` character means ``match anything''. To match
a literal `*` character, use :escwc:.

option:-n, option:--no-wait::
    Do :not: ensure that the trace data of the selected recording
    session(s) is valid before exiting.


include::common-lttng-cmd-help-options.txt[]


include::common-lttng-cmd-after-options.txt[]


[[examples]]
EXAMPLES
--------
.Stop the current recording session.
====
[role="term"]
----
$ lttng stop
----
====

.Stop a specific recording session.
====
[role="term"]
----
$ lttng stop my-session
----
====

.Stop the current recording session without waiting for completion.
====
See the option:--no-wait option.

[role="term"]
----
$ lttng stop --no-wait
----
====

.Stop all the recording sessions.
====
See the option:--all option.

[role="term"]
----
$ lttng stop --all
----
====

.Stop all the recording sessions of which the name starts with `bar`.
====
See the option:--glob option.

[role="term"]
----
$ lttng stop --glob='bar*'
----
====


include::common-footer.txt[]


SEE ALSO
--------
man:lttng(1),
man:lttng-add-trigger(1),
man:lttng-create(1),
man:lttng-enable-event(1),
man:lttng-rotate(1),
man:lttng-start(1),
man:lttng-concepts(7)