lttng-live: fix diagram
[lttng-docs.git] / contents / using-lttng / controlling-tracing / lttng-live.md
1 ---
2 id: lttng-live
3 ---
4
5 We have seen how trace files may be produced by LTTng out of generated
6 application and Linux kernel events. We have seen that those trace files
7 may be either recorded locally by consumer daemons or remotely using
8 a relay daemon. And we have seen that the maximum size and count of
9 trace files is configurable for each channel. With all those features,
10 it's still not possible to read a trace file as it is being written
11 because it could be incomplete and appear corrupted to the viewer.
12 There is a way to view events as they arrive, however: using
13 _LTTng live_.
14
15 LTTng live is implemented, in LTTng, solely on the relay daemon side.
16 As trace data is sent over the network to a relay daemon by a (possibly
17 remote) consumer daemon, a _tee_ is created: trace data is recorded to
18 trace files _as well as_ being transmitted to a connected live viewer:
19
20 <div class="img img-100">
21 <img src="/images/docs26/lttng-live.png" alt="LTTng live">
22 </div>
23
24 In order to use this feature, a tracing session must created in live
25 mode on the target system:
26
27 <pre class="term">
28 lttng create --live
29 </pre>
30
31 An optional parameter may be passed to `--live` to set the period
32 (in microseconds) between flushes to the network
33 (1&nbsp;second is the default). With:
34
35 <pre class="term">
36 lttng create --live 100000
37 </pre>
38
39 the daemons flush their data every 100&nbsp;ms.
40
41 If no network output is specified to the `create` command, a local
42 relay daemon is spawned. In this very common case, viewing a live
43 trace is easy: enable events and start tracing as usual, then use
44 `lttng view` to start the default live viewer:
45
46 <pre class="term">
47 lttng view
48 </pre>
49
50 The correct arguments are passed to the live viewer so that it
51 may connect to the local relay daemon and start reading live events.
52
53 You may also wish to use a live viewer not running on the target
54 system. In this case, you should specify a network output when using
55 the `create` command (`--set-url` or `--ctrl-url`/`--data-url` options).
56 A distant LTTng relay daemon should also be started to receive control
57 and trace data. By default, `lttng-relayd` listens on 127.0.0.1:5344
58 for an LTTng live connection. Otherwise, the desired URL may be
59 specified using its `--live-port` option.
60
61 The
62 <a href="http://www.efficios.com/babeltrace" class="ext">`babeltrace`</a>
63 viewer supports LTTng live as one of its input formats. `babeltrace` is
64 the default viewer when using `lttng view`. To use it manually, first
65 list active tracing sessions by doing the following (assuming the relay
66 daemon to connect to runs on the same host):
67
68 <pre class="term">
69 babeltrace --input-format lttng-live net://localhost
70 </pre>
71
72 Then, choose a tracing session and start viewing events as they arrive
73 using LTTng live:
74
75 <pre class="term">
76 babeltrace --input-format lttng-live net://localhost/host/hostname/my-session
77 </pre>
This page took 0.032348 seconds and 4 git commands to generate.