Docs: clarify cross-version tracer compatibility
[lttng-tools.git] / README.md
1 LTTng-tools
2 ===========
3
4 LTTng-tools is a set of tools to control [LTTng](https://lttng.org/)
5 tracing. The project includes the LTTng session daemon, consumer damon
6 and relay daemon, as well as `liblttng-ctl`, a C library used to
7 communicate with the session daemon, and `lttng`, a command line
8 interface to `liblttng-ctl`.
9
10
11 Requirements and optional dependencies
12 --------------------------------------
13
14 The following items are _required_ to build and run LTTng-tools
15 components:
16
17 - **Linux kernel >= 2.6.27**: for `epoll()` support, at least this
18 version is needed. However, `poll()` is also supported by
19 configuring LTTng-tools with the `--disable-epoll` option. Using
20 that, the kernel version may probably be older, but we can't provide
21 any guarantee. Please let us know if you are able to go lower
22 without any problems.
23 - **[`liburcu`](http://www.liburcu.org/) >= 0.8.0**: userspace RCU library,
24 by Mathieu Desnoyers and Paul E. McKenney.
25 - **`libpopt` >= 1.13**: command line arguments parsing library.
26 - Debian/Ubuntu package: `libpopt-dev`
27 - **`libuuid`**: universally unique ID library
28 - Debian/Ubuntu package: `uuid-dev`
29 - **`libxml2` >= 2.7.6**: XML document parsing library. Needed for
30 tracing session configuration saving/loading and machine interface
31 output support.
32 - Debian/Ubuntu package: `libxml2-dev`
33
34
35 The following items are _optional_ dependencies:
36
37 - **[Babeltrace](https://lttng.org/babeltrace)**: trace viewer.
38 Enables the use of `lttng view` command.
39 - Debian/Ubuntu package: `babeltrace`
40 - **[LTTng UST](https://lttng.org) (same minor version as LTTng Tools)**:
41 userspace tracer. Enables the tracing of userspace applications.
42 - Debian/Ubuntu package: `liblttng-ust-dev`
43 - **Perl**: needed for `make check` and tests.
44 - **Python >= 3.0**: needed for `make check` and tests.
45 - Debian/Ubuntu package: `python3`
46 - **SWIG >= 2.0** and **Python 3 development headers**: needed for
47 Python bindings
48 (enabled at configure time with the `--enable-python-bindings` option).
49 - Debian/Ubuntu packages: `swig2.0` and `python3-dev`
50 - **modprobe**: needed for automatic LTTng kernel modules loading
51 (kernel tracing).
52 - **bash**: needed for running `make check`.
53
54 LTTng-tools supports both the [LTTng Linux Kernel tracer](https://lttng.org)
55 and [LTTng user space tracer](https://lttng.org) released as part of the same
56 **minor** release series. While some releases do not change the tracer ABIs and
57 should work with, no testing is performed to ensure cross-version compatibility
58 is maintained.
59
60 Note that applications instrumented with older versions of the LTTng UST project
61 do not have to be rebuilt or modified to work with the latest LTTng-tools.
62 For more information on versioning, please refer to the
63 [LTTng documentation](https://lttng.org/docs).
64
65 Building
66 --------
67
68 This source tree is based on the Autotools suite from GNU to simplify
69 portability. Here are some things you should have on your system in
70 order to compile the Git repository tree:
71
72 - GNU Autotools (Automake >= 1.10, Autoconf >= 2.64,
73 Autoheader >= 2.50; make sure your system-wide `automake` points to
74 a recent version!)
75 - [GNU Libtool](http://www.gnu.org/software/autoconf/) >= 2.2
76 - Flex >= 2.5.35
77 - Bison >= 2.4
78
79 If you use GNU gold, which is _not_ mandatory, make sure you have this
80 version:
81
82 - GNU gold >= 2.22
83
84 Before this version of GNU gold, we hit a
85 [known bug](http://sourceware.org/bugzilla/show_bug.cgi?id=11317).
86 Be advised that with GNU gold, you might have to specify
87 `-L/usr/local/lib` in `LDFLAGS`.
88
89 If you get the tree from the Git repository, you will need to run
90
91 ./bootstrap
92
93 in its root. It calls all the GNU tools needed to prepare the tree
94 configuration.
95
96 To build LTTng-tools, do:
97
98 ./configure
99 make
100 sudo make install
101 sudo ldconfig
102
103 If you want Python bindings, add the `--enable-python-bindings` option
104 to `configure`. Please note that some distributions will need the
105 following environment variables set before running configure:
106
107 export PYTHON="python3"
108 export PYTHON_CONFIG="/usr/bin/python3-config"
109
110
111 Using
112 -----
113
114 Please see [`doc/quickstart.txt`](doc/quickstart.txt) to get started
115 with LTTng tracing. You can also use the `-h` or `--help` option of
116 any `lttng` command, e.g.:
117
118 lttng enable-event --help
119
120 A network streaming HOWTO can be found in
121 [`doc/streaming-howto.txt`](doc/streaming-howto.txt) which quickly
122 helps you understand how to stream a LTTng 2.x trace.
123
124 A Python binding HOWTO can be found in
125 [`doc/python-howto.txt`](doc/python-howto.txt) which quickly helps you
126 understand how to use the Python module to control LTTng.
127
128
129 Contact
130 -------
131
132 Maintainer: [Jérémie Galarneau](mailto:jeremie.galarneau@efficios.com)
133
134 Mailing list: [`lttng-dev@lists.lttng.org`](https://lttng.org/cgi-bin/mailman/listinfo/lttng-dev)
135
136
137 Package contents
138 ----------------
139
140 This package contains the following elements:
141
142 - `doc`: LTTng-tools documentation.
143 - `include`: the public header files that will be installed on the system.
144 - `src/bin`: source code of LTTng-tools programs.
145 - `lttng-consumerd`: consumer daemon.
146 - `lttng-relayd`: relay daemon.
147 - `lttng-sessiond`: session daemon.
148 - `lttng`: command line interface for LTTng tracing control.
149 - `src/common`: common LTTng-tools source code.
150 - `compat`: compatibility library mostly for FreeBSD and Linux.
151 - `config`: tracing session configuration saving/loading.
152 - `hashtable`: library wrapper over Userspace RCU hashtables.
153 - `health`: health check subsytem.
154 - `index`: CTF index utilities.
155 - `kernel-consumer`: Linux kernel consumer.
156 - `kernel-ctl`: Linux kernel tracer control.
157 - `relayd`: relay daemon control.
158 - `sessiond-comm`: session daemon communication.
159 - `ust-consumer`: user space consumer.
160 - `src/lib`: source code of LTTng-tools libraries.
161 - `lttng-ctl`: LTTng control library.
162 - `tests`: various test programs.
This page took 0.047859 seconds and 5 git commands to generate.