Cleanup: Remove unnecessary newline
[lttng-tools.git] / README.md
CommitLineData
adf4e918
PP
1LTTng-tools
2===========
3
4LTTng-tools is a set of tools to control [LTTng](https://lttng.org/)
5tracing. The project includes the LTTng session daemon, consumer damon
6and relay daemon, as well as `liblttng-ctl`, a C library used to
7communicate with the session daemon, and `lttng`, a command line
8interface to `liblttng-ctl`.
9
10
11Requirements and optional dependencies
12--------------------------------------
13
14The following items are _required_ to build and run LTTng-tools
15components:
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.
99ad3285 23 - **[`liburcu`](http://www.liburcu.org/) >= 0.8.0**: userspace RCU library,
adf4e918
PP
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`
2199563c
JG
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
adf4e918
PP
34
35The 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`
213ff7c7
JG
40 - **[LTTng UST](https://lttng.org) (same version as LTTng Tools)**: userspace tracer.
41 Enables the tracing of userspace applications.
42 - Debian/Ubuntu package: `liblttng-ust-dev`
adf4e918
PP
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
55Building
56--------
57
58This source tree is based on the Autotools suite from GNU to simplify
59portability. Here are some things you should have on your system in
60order to compile the Git repository tree:
61
5d5baaa3 62 - GNU Autotools (Automake >= 1.10, Autoconf >= 2.64,
adf4e918
PP
63 Autoheader >= 2.50; make sure your system-wide `automake` points to
64 a recent version!)
65 - [GNU Libtool](http://www.gnu.org/software/autoconf/) >= 2.2
66 - Flex >= 2.5.35
67 - Bison >= 2.4
68
69If you use GNU gold, which is _not_ mandatory, make sure you have this
70version:
71
72 - GNU gold >= 2.22
73
74Before this version of GNU gold, we hit a
75[known bug](http://sourceware.org/bugzilla/show_bug.cgi?id=11317).
76Be advised that with GNU gold, you might have to specify
77`-L/usr/local/lib` in `LDFLAGS`.
78
79If you get the tree from the Git repository, you will need to run
80
81 ./bootstrap
82
83in its root. It calls all the GNU tools needed to prepare the tree
84configuration.
85
86To build LTTng-tools, do:
87
88 ./configure
89 make
90 sudo make install
91 sudo ldconfig
92
93If you want Python bindings, add the `--enable-python-bindings` option
94to `configure`. Please note that some distributions will need the
95following environment variables set before running configure:
96
97 export PYTHON="python3"
98 export PYTHON_CONFIG="/usr/bin/python3-config"
99
100
101Using
102-----
103
104Please see [`doc/quickstart.txt`](doc/quickstart.txt) to get started
105with LTTng tracing. You can also use the `-h` or `--help` option of
106any `lttng` command, e.g.:
107
108 lttng enable-event --help
109
110A network streaming HOWTO can be found in
111[`doc/streaming-howto.txt`](doc/streaming-howto.txt) which quickly
112helps you understand how to stream a LTTng 2.x trace.
113
114A Python binding HOWTO can be found in
115[`doc/python-howto.txt`](doc/python-howto.txt) which quickly helps you
116understand how to use the Python module to control LTTng.
117
118
119Contact
120-------
121
04814575 122Maintainer: [Jérémie Galarneau](mailto:jeremie.galarneau@efficios.com)
adf4e918
PP
123
124Mailing list: [`lttng-dev@lists.lttng.org`](https://lttng.org/cgi-bin/mailman/listinfo/lttng-dev)
125
126
127Package contents
128----------------
129
130This package contains the following elements:
131
132 - `doc`: LTTng-tools documentation.
133 - `include`: the public header files that will be installed on the system.
134 - `src/bin`: source code of LTTng-tools programs.
135 - `lttng-consumerd`: consumer daemon.
136 - `lttng-relayd`: relay daemon.
137 - `lttng-sessiond`: session daemon.
138 - `lttng`: command line interface for LTTng tracing control.
139 - `src/common`: common LTTng-tools source code.
140 - `compat`: compatibility library mostly for FreeBSD and Linux.
141 - `config`: tracing session configuration saving/loading.
142 - `hashtable`: library wrapper over Userspace RCU hashtables.
143 - `health`: health check subsytem.
144 - `index`: CTF index utilities.
145 - `kernel-consumer`: Linux kernel consumer.
146 - `kernel-ctl`: Linux kernel tracer control.
147 - `relayd`: relay daemon control.
148 - `sessiond-comm`: session daemon communication.
149 - `ust-consumer`: user space consumer.
150 - `src/lib`: source code of LTTng-tools libraries.
151 - `lttng-ctl`: LTTng control library.
152 - `tests`: various test programs.
This page took 0.040729 seconds and 4 git commands to generate.