From e765105490394ee9f663c7c25d343b9146a023da Mon Sep 17 00:00:00 2001 From: David Goulet Date: Sun, 17 Jul 2011 20:21:45 -0400 Subject: [PATCH] Add quick start tracing guide First draft of a quick start guide. For now, there is only the kernel tracing guide since ust 2.0 is not released at this point. Signed-off-by: David Goulet --- doc/quickstart.txt | 82 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 doc/quickstart.txt diff --git a/doc/quickstart.txt b/doc/quickstart.txt new file mode 100644 index 000000000..e5e1f1705 --- /dev/null +++ b/doc/quickstart.txt @@ -0,0 +1,82 @@ +QUICKSTART +-------------- + +This is a quick start guide for the complete LTTng tool chain. This is divided +in three sections respectively Kernel tracing, user-space tracing and reading a +trace. + +See the README file for installation procedure or use the various Linux +distribution packages. + +In order to trace the Kernel, you'll need the lttng-modules >= 2.0 compiled and +installed. See http://lttng.org/content/lttng-kernel-tracer for more +instructions for that part. For user-space tracing, you'll need an instrumented +application, please see http://lttng.org/ust + +lttng-tools provide a session daemon (ltt-sessiond) that acts as a tracing +registry. To trace any instrumented applications or the kernel, a registered +tracing session is needed. + +To interact with the session daemon and a tracing session, you can use the +lttng command line UI (lttng). + +The next sections explain how to do tracing :) + +Kernel Tracing +-------------- + +You have to modprobe the lttng-modules manually or the session daemon will do +it for you if they can be found on your system. + +You can then start the session daemon by hand or the lttng command line tool +will do it for you. + +List possible kernel events: + +# lttng list -k + +1) Create a tracing session. A .lttngrc will be created in $HOME containing +the session name (here 'mysession') you are working on. + +# lttng create mysession + +2) Enable event(s). Here for example, we want only 'sched_switch' and +'sys_enter' events for the kernel (-k/--kernel). + +# lttng enable-event sched_switch,sys_enter -k + +or enable ALL events (-a/--all): + +# lttng enable-event -a -k + +3) Start tracing: + +# lttng start + +Tracing is in progress at this point and will be written in +$HOME/lttng-traces/mysession--