Commit | Line | Data |
---|---|---|
30ec772c PP |
1 | lttng-start(1) |
2 | ============== | |
e9711845 | 3 | :revdate: 14 June 2021 |
30ec772c PP |
4 | |
5 | ||
6 | NAME | |
7 | ---- | |
e9711845 | 8 | lttng-start - Start an LTTng recording session |
30ec772c PP |
9 | |
10 | ||
11 | SYNOPSIS | |
12 | -------- | |
13 | [verse] | |
eaa8ef76 | 14 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *start* [option::--all | option::--glob 'SESSION' | 'SESSION' ] |
30ec772c PP |
15 | |
16 | ||
17 | DESCRIPTION | |
18 | ----------- | |
e9711845 | 19 | The `lttng start` command starts a recording session, that is, it |
484b2a0c | 20 | activates the LTTng tracers for: |
30ec772c | 21 | |
484b2a0c | 22 | With the 'SESSION' argument:: |
e9711845 | 23 | The recording session named 'SESSION'. |
30ec772c | 24 | |
484b2a0c | 25 | Without the 'SESSION' argument:: |
e9711845 PP |
26 | The current recording session (see man:lttng-concepts(7) to learn |
27 | more about the current recording session). | |
26f0c779 | 28 | |
e9711845 | 29 | See man:lttng-concepts(7) to learn more about recording sessions. |
30ec772c | 30 | |
e9711845 | 31 | The selected recording session must be inactive (stopped). A recording |
484b2a0c PP |
32 | session is inactive on creation (see man:lttng-create(1)). |
33 | ||
e9711845 | 34 | A `start-session` trigger action can also start a recording session |
484b2a0c PP |
35 | (see man:lttng-add-trigger(1)). |
36 | ||
da39b67c | 37 | See the ``<<examples,EXAMPLES>>'' section below for usage examples. |
29545453 | 38 | |
e9711845 | 39 | Stop an active recording session with the man:lttng-stop(1) command. |
30ec772c PP |
40 | |
41 | ||
f5511eea | 42 | include::common-lttng-cmd-options-head.txt[] |
30ec772c PP |
43 | |
44 | ||
f5511eea | 45 | include::common-lttng-cmd-help-options.txt[] |
30ec772c | 46 | |
eaa8ef76 OD |
47 | option:-a, option:--all:: |
48 | Start all sessions. | |
49 | ||
50 | option:-g, option:--glob:: | |
51 | Interpret SESSION as a globbing pattern. | |
30ec772c | 52 | |
f5511eea PP |
53 | include::common-lttng-cmd-after-options.txt[] |
54 | ||
55 | ||
29545453 PP |
56 | [[examples]] |
57 | EXAMPLES | |
58 | -------- | |
e9711845 | 59 | .Start the current recording session. |
29545453 PP |
60 | ==== |
61 | [role="term"] | |
62 | ---- | |
63 | $ lttng start | |
64 | ---- | |
65 | ==== | |
66 | ||
e9711845 | 67 | .Start a specific recording session. |
29545453 PP |
68 | ==== |
69 | [role="term"] | |
70 | ---- | |
71 | $ lttng start my-session | |
72 | ---- | |
73 | ==== | |
74 | ||
eaa8ef76 OD |
75 | .Start all sessions. |
76 | ==== | |
77 | See the option::--all option. | |
78 | ||
79 | [role="term"] | |
80 | ---- | |
81 | $ lttng start --all | |
82 | ---- | |
83 | ==== | |
84 | ||
85 | .Start all sessions with the suffix foo. | |
86 | ==== | |
87 | See the option::--glob option. | |
88 | ||
89 | [role="term"] | |
90 | ---- | |
91 | $ lttng start --glob '*foo' | |
92 | ---- | |
93 | ==== | |
94 | ||
29545453 | 95 | |
f5511eea | 96 | include::common-footer.txt[] |
30ec772c PP |
97 | |
98 | ||
99 | SEE ALSO | |
100 | -------- | |
484b2a0c PP |
101 | man:lttng(1), |
102 | man:lttng-add-trigger(1), | |
103 | man:lttng-create(1), | |
104 | man:lttng-enable-event(1), | |
af1c4164 PP |
105 | man:lttng-stop(1), |
106 | man:lttng-concepts(7) |