tracing-the-linux-kernel: minor fixes
[lttng-docs.git] / contents / getting-started / tracing-the-linux-kernel.md
CommitLineData
5e0cbfb0
PP
1---
2id: tracing-the-linux-kernel
3---
4
5Make sure LTTng-tools and LTTng-modules packages
6[are installed](#doc-installing-lttng).
7
8Since you're about to trace the Linux kernel itself, let's look at the
9available kernel events using the `lttng` tool, which has a
08060fc1 10Git-like command line structure:
5e0cbfb0
PP
11
12<pre class="term">
13lttng list --kernel
14</pre>
15
f7929219
PP
16Before tracing, you need to create a session:
17
18<pre class="term">
a5f17bf9 19sudo lttng create
f7929219
PP
20</pre>
21
5e0cbfb0
PP
22<div class="tip">
23<p>
24 <span class="t">Tip:</span>You can avoid using <code>sudo</code> in
08060fc1 25 the previous and following commands if your user is a member of the
a5f17bf9 26 <a href="#doc-lttng-sessiond" class="int"><code>tracing</code>
f7929219 27 group</a>.
5e0cbfb0
PP
28</p>
29</div>
30
5e0cbfb0
PP
31Let's now enable some events for this session:
32
33<pre class="term">
34sudo lttng enable-event --kernel sched_switch,sched_process_fork
35</pre>
36
a5f17bf9 37Or you might want to simply enable all available kernel events (beware
47bfcb75 38that trace files grow rapidly when doing this):
5e0cbfb0
PP
39
40<pre class="term">
41sudo lttng enable-event --kernel --all
42</pre>
43
44Start tracing:
45
46<pre class="term">
47sudo lttng start
48</pre>
49
50By default, traces are saved in
51<code>~/lttng-traces/<em>name</em>-<em>date</em>-<em>time</em></code>,
52where <code><em>name</em></code> is the session name.
53
54When you're done tracing:
55
56<pre class="term">
57sudo lttng stop
58sudo lttng destroy
59</pre>
60
61Although `destroy` looks scary here, it doesn't actually destroy the
a5f17bf9 62written trace files: it only destroys the tracing session.
5e0cbfb0
PP
63
64What's next? Have a look at
65[Viewing and analyzing your traces](#doc-viewing-and-analyzing-your-traces)
66to view and analyze the trace you just recorded.
This page took 0.025182 seconds and 4 git commands to generate.