4 Please visit https://lttng.org for more information. The current maintainer is
5 David Goulet <dgoulet@efficios.com>.
7 Latest development can be found at:
9 * Gitweb : https://git.lttng.org/?p=lttng-tools.git;a=summary
10 * Git : git://git.lttng.org/lttng-tools.git
14 - Linux kernel >= 2.6.27
15 For epoll() support, at least this version is needed. However, poll() is
16 also supported by running "./configure --disable-epoll". Using that, the
17 kernel version can probably be older but we can't provide any guarantee.
18 Please let us know if you are able to go lower without any problems.
21 Userspace RCU library, by Mathieu Desnoyers and Paul E. McKenney
23 -> Tested with liburcu 0.7.x stable.
25 * Debian/Ubuntu package: liburcu-dev
26 * Git : git://git.lttng.org/userspace-rcu.git
27 * Website: https://lttng.org/urcu
30 Library for parsing command line parameters
32 * Debian/Ubuntu package: libpopt-dev
35 Needed for make check and tests.
37 - Python >= 3.0 (optional)
38 Needed for make check and tests.
40 * Debian/Ubuntu package: python3
42 - SWIG >= 2.0 (optional)
43 Needed for Python bindings (--enable-python-bindings).
45 * Debian/Ubuntu package: swig2.0
47 - python-dev (optional)
50 * Debian/Ubuntu package: python3-dev
52 - For kernel tracing: modprobe
55 Needed for running "make check".
57 For developers using the git tree:
59 This source tree is based on the autotools suite from GNU to simplify
60 portability. Here are some things you should have on your system in order to
61 compile the git repository tree :
63 - GNU autotools (automake >=1.10, autoconf >=2.50, autoheader >=2.50)
64 (make sure your system wide "automake" points to a recent version!)
66 (for more information, go to https://www.gnu.org/software/autoconf/)
70 If you use GNU gold, which is NOT mandatory, make sure you have this version:
72 (Before this version we hit a known bug documented at:
73 http://sourceware.org/bugzilla/show_bug.cgi?id=11317)
74 Be advise that with GNU gold, you'll might have to specify -L/usr/local/lib in
77 If you get the tree from the repository, you will need to use the "bootstrap"
78 script in the root of the tree. It calls all the GNU tools needed to prepare
79 the tree configuration.
81 INSTALLATION INSTRUCTIONS:
83 - Download, compile and install the prerequisites.
91 If compiling from the git repository, run ./bootstrap before running
92 the configure script, to generate it.
94 If you want Python bindings, run ./configure --enable-python-bindings.
95 Please note that some distributions will need the following
96 environment variables set before running configure:
98 export PYTHON="python3"
99 export PYTHON_CONFIG="/usr/bin/python3-config"
103 Please see doc/quickstart.txt to help you start tracing. You can also use the
104 -h/--help command on 'lttng' and all other commands offered in this tool (Ex:
105 lttng enable-event -h).
107 A network streaming HOWTO can be found in doc/streaming-howto.txt which quickly
108 helps you understand how to stream a LTTng 2.0 trace.
110 A Python HOWTO can be found in doc/python-howto.txt which quickly
111 helps you understand how to use the Python module to control the LTTng API.
115 This package contains the following elements:
117 - liblttng-ctl (public API)
118 The LTTng tracing control library.
120 - libsessiond-comm (internal)
121 The lttng-sessiond communication library. In order to talk with
122 lttng-sessiond, this library must be used.
124 - libkernel-ctl (internal)
125 Kernel tracer control and ioctl definitions.
127 - libconsumer (internal)
128 Library for Kernel and (optionally) UST trace consumer.
130 - libkernel-consumer (internal)
131 Library for Kernel consumer control
133 - libust-consumer (internal)
134 Library for UST consumer control
136 - libhashtable (internal)
137 Library wrapper over URCU hashtables.
139 - libcommon (internal)
140 Contains multiple useful function call used by the whole tree.
142 - libcompat (internal)
143 Compatibility library mostly for FreeBSD and Linux.
145 - librelayd (internal)
146 Library for all relayd interactions over the network.
149 The relay daemon used for network streaming
152 The consumer daemon which uses libconsumer.
155 The LTTng session daemon binary.
158 The LTTng tracer command line control tool.
160 - include (installed in $(includedir)/lttng/)
161 The liblttngctl API header file.
164 Various test programs.
167 Various documentations and quickstart guide.
170 Contains extra data such as bash completion file. Python bindings for
171 liblttng-ctl are also available there.