projects / lttng-tools.git / blame
| Commit | Line | Data |
|---|---|---|
| 30ec772c PP |
1 | lttng-start(1) |
| 2 | ============== | |
| aaae4813 | 3 | :revdate: 14 June 2021 |
| 30ec772c PP |
4 | |
| 5 | ||
| 6 | NAME | |
| 7 | ---- | |
| aaae4813 | 8 | lttng-start - Start an LTTng recording session |
| 30ec772c PP |
9 | |
| 10 | ||
| 11 | SYNOPSIS | |
| 12 | -------- | |
| 13 | [verse] | |
| ce19b9ed | 14 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *start* ['SESSION'] |
| 30ec772c PP |
15 | |
| 16 | ||
| 17 | DESCRIPTION | |
| 18 | ----------- | |
| aaae4813 | 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:: |
| aaae4813 | 23 | The recording session named 'SESSION'. |
| 30ec772c | 24 | |
| 484b2a0c | 25 | Without the 'SESSION' argument:: |
| aaae4813 PP |
26 | The current recording session (see man:lttng-concepts(7) to learn |
| 27 | more about the current recording session). | |
| 188419c4 | 28 | |
| aaae4813 | 29 | See man:lttng-concepts(7) to learn more about recording sessions. |
| 30ec772c | 30 | |
| aaae4813 | 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 | ||
| aaae4813 | 34 | A `start-session` trigger action can also start a recording session |
| 484b2a0c PP |
35 | (see man:lttng-add-trigger(1)). |
| 36 | ||
| 7d259724 | 37 | See the ``<<examples,EXAMPLES>>'' section below for usage examples. |
| 2be25270 | 38 | |
| aaae4813 | 39 | Stop an active recording session with the man:lttng-stop(1) command. |
| 30ec772c PP |
40 | |
| 41 | ||
| 55e06994 | 42 | include::common-lttng-cmd-options-head.txt[] |
| 30ec772c PP |
43 | |
| 44 | ||
| 55e06994 | 45 | include::common-lttng-cmd-help-options.txt[] |
| 30ec772c PP |
46 | |
| 47 | ||
| 55e06994 PP |
48 | include::common-lttng-cmd-after-options.txt[] |
| 49 | ||
| 50 | ||
| 2be25270 PP |
51 | [[examples]] |
| 52 | EXAMPLES | |
| 53 | -------- | |
| aaae4813 | 54 | .Start the current recording session. |
| 2be25270 PP |
55 | ==== |
| 56 | [role="term"] | |
| 57 | ---- | |
| 58 | $ lttng start | |
| 59 | ---- | |
| 60 | ==== | |
| 61 | ||
| aaae4813 | 62 | .Start a specific recording session. |
| 2be25270 PP |
63 | ==== |
| 64 | [role="term"] | |
| 65 | ---- | |
| 66 | $ lttng start my-session | |
| 67 | ---- | |
| 68 | ==== | |
| 69 | ||
| 70 | ||
| 55e06994 | 71 | include::common-footer.txt[] |
| 30ec772c PP |
72 | |
| 73 | ||
| 74 | SEE ALSO | |
| 75 | -------- | |
| 484b2a0c PP |
76 | man:lttng(1), |
| 77 | man:lttng-add-trigger(1), | |
| 78 | man:lttng-create(1), | |
| 79 | man:lttng-enable-event(1), | |
| 21b35b3a PP |
80 | man:lttng-stop(1), |
| 81 | man:lttng-concepts(7) |