The LTTng Documentation
=======================
Philippe Proulx <pproulx@efficios.com>
-v2.9, 25 July 2017
+v2.9, 22 January 2018
include::../common/copyright.txt[]
applications.
[role="growable"]
-.Availability of LTTng{nbsp}{revision} for major Linux distributions as of 25 July 2017.
+.Availability of LTTng{nbsp}{revision} for major Linux distributions as of 22 January 2018.
|====
|Distribution |Available in releases |Alternatives
|https://www.ubuntu.com/[Ubuntu]
-|<<ubuntu,Ubuntu{nbsp}17.04 _Zesty Zapus_>>.
+|<<ubuntu,Ubuntu{nbsp}17.04 _Zesty Zapus_ and Ubuntu{nbsp}17.10 _Artful Aardvark_>>.
Ubuntu{nbsp}14.04 _Trusty Tahr_ and Ubuntu{nbsp}16.04 _Xenial Xerus_:
<<ubuntu-ppa,use the LTTng Stable{nbsp}{revision} PPA>>.
|https://getfedora.org/[Fedora]
|<<fedora,Fedora{nbsp}26>>.
-|link:/docs/v2.8#doc-fedora[LTTng{nbsp}2.8 for Fedora 25].
+|link:/docs/v2.10#doc-fedora[LTTng{nbsp}2.10 for Fedora{nbsp}27].
<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
other Fedora releases.
|https://www.debian.org/[Debian]
-|xref:debian[Debian "stretch" (stable), Debian "buster" (testing),
+|<<debian,Debian "stretch" (stable)>>.
+|link:/docs/v2.10#doc-debian[LTTng{nbsp}2.10 for Debian "buster" (testing)
and Debian "sid" (unstable)].
-|<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
+
+
+<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
other Debian releases.
|https://www.archlinux.org/[Arch Linux]
-|<<arch-linux,Latest AUR packages>>.
-|
+|_Not available_
+|link:/docs/v2.10#doc-arch-linux[LTTng{nbsp}2.10 for the current Arch Linux build].
+
+<<building-from-source,Build LTTng{nbsp}{revision} from source>>.
|https://alpinelinux.org/[Alpine Linux]
-|<<alpine-linux,Alpine Linux "edge">>.
-|<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
-other Alpine Linux releases.
+|_Not available_
+|link:/docs/v2.10#doc-alpine-linux[LTTng{nbsp}2.10 for Alpine Linux{nbsp}3.7
+and Alpine Linux{nbsp}"edge"].
+
+<<building-from-source,Build LTTng{nbsp}{revision} from source>>.
|https://www.redhat.com/[RHEL] and https://www.suse.com/[SLES]
|See http://packages.efficios.com/[EfficiOS Enterprise Packages].
|
|https://buildroot.org/[Buildroot]
-|<<buildroot,Buildroot{nbsp}2017.02 and Buildroot{nbsp}2017.05>>.
-|link:/docs/v2.8#doc-buildroot[LTTng{nbsp}2.8 for Buildroot{nbsp}2016.11].
-
-<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
+|<<"buildroot", "Buildroot{nbsp}2017.02, Buildroot{nbsp}2017.05, Buildroot{nbsp}2017.08, and Buildroot{nbsp}2017.11">>.
+|<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
other Buildroot releases.
|http://www.openembedded.org/wiki/Main_Page[OpenEmbedded] and
https://www.yoctoproject.org/[Yocto]
-|<<oe-yocto,Yocto Project{nbsp}2.3 _Pyro_>> (`openembedded-core` layer).
-|link:/docs/v2.8#doc-oe-yocto[LTTng{nbsp}2.8 for Yocto Project{nbsp}2.2 _Morty_]
+|<<oe-yocto,Yocto Project{nbsp}2.3 _Pyro_ and Yocto Project{nbsp}2.4 _Rocko_>>
(`openembedded-core` layer).
-
-<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
-other OpenEmbedded releases.
+|<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
+other Yocto/OpenEmbedded releases.
|====
[[ubuntu]]
=== [[ubuntu-official-repositories]]Ubuntu
-LTTng{nbsp}{revision} is available on Ubuntu{nbsp}17.04 _Zesty Zapus_.
-For previous releases of Ubuntu, <<ubuntu-ppa,use the LTTng
-Stable{nbsp}{revision} PPA>>.
+LTTng{nbsp}{revision} is available on Ubuntu{nbsp}17.04 _Zesty Zapus_
+and Ubuntu{nbsp}17.10 _Artful Aardvark_. For previous releases of
+Ubuntu, <<ubuntu-ppa,use the LTTng Stable{nbsp}{revision} PPA>>.
To install LTTng{nbsp}{revision} on Ubuntu{nbsp}17.04 _Zesty Zapus_:
[[debian]]
=== Debian
-To install LTTng{nbsp}{revision} on Debian "stretch" (stable),
-Debian "buster" (testing), or Debian "sid" (unstable):
+To install LTTng{nbsp}{revision} on Debian "stretch" (stable):
. Install the main LTTng{nbsp}{revision} packages:
+
--
-[[arch-linux]]
-=== Arch Linux
-
-To install LTTng{nbsp}{revision} on Arch Linux using
-https://github.com/rmarquis/pacaur[pacaur]:
-
-. Install the main LTTng{nbsp}{revision} packages:
-+
---
-[role="term"]
-----
-$ pacaur -Sy lttng-tools
-$ pacaur -Sy lttng-ust
-$ pacaur -Sy lttng-modules
-----
---
-
-. **If you need to instrument and trace <<python-application,Python
- applications>>**, install the LTTng-UST Python agent:
-+
---
-[role="term"]
-----
-$ pacaur -Sy python-lttngust
-$ pacaur -Sy python2-lttngust
-----
---
-
-
-[[alpine-linux]]
-=== Alpine Linux
-
-To install LTTng-tools{nbsp}{revision} and LTTng-UST{nbsp}{revision} on
-Alpine Linux "edge":
-
-. Make sure your system is
- https://wiki.alpinelinux.org/wiki/Edge[configured for "edge"].
-. Enable the _testing_ repository by uncommenting the corresponding
- line in path:{/etc/apk/repositories}.
-. Add the LTTng packages:
-+
---
-[role="term"]
-----
-# apk add lttng-tools
-# apk add lttng-ust-dev
-----
---
-
-To install LTTng-modules{nbsp}{revision} (Linux kernel tracing support)
-on Alpine Linux "edge":
-
-. Add the vanilla Linux kernel:
-+
---
-[role="term"]
-----
-# apk add linux-vanilla linux-vanilla-dev
-----
---
-
-. Reboot with the vanilla Linux kernel.
-. Download, build, and install the latest LTTng-modules{nbsp}{revision}:
-+
---
-[role="term"]
-----
-$ cd $(mktemp -d) &&
-wget http://lttng.org/files/lttng-modules/lttng-modules-latest-2.9.tar.bz2 &&
-tar -xf lttng-modules-latest-2.9.tar.bz2 &&
-cd lttng-modules-2.9.* &&
-make &&
-sudo make modules_install &&
-sudo depmod -a
-----
---
-
-
[[enterprise-distributions]]
=== RHEL, SUSE, and other enterprise distributions
[[buildroot]]
=== Buildroot
-To install LTTng{nbsp}{revision} on Buildroot{nbsp}2017.02 or
-Buildroot{nbsp}2017.05:
+To install LTTng{nbsp}{revision} on Buildroot{nbsp}2017.02,
+Buildroot{nbsp}2017.05, Buildroot{nbsp}2017.08, or
+Buildroot{nbsp}2017.11:
. Launch the Buildroot configuration tool:
+
LTTng{nbsp}{revision} recipes are available in the
http://layers.openembedded.org/layerindex/branch/master/layer/openembedded-core/[`openembedded-core`]
-layer for Yocto Project{nbsp}2.3 _Pyro_ under the following names:
+layer for Yocto Project{nbsp}2.3 _Pyro_ and Yocto Project{nbsp}2.4 _Rocko_
+under the following names:
* `lttng-tools`
* `lttng-modules`
discard mode, the tracer only discards the event record that doesn't
fit.
-In discard mode, LTTng increments a count of lost event records when
-an event record is lost and saves this count to the trace. In
-overwrite mode, LTTng keeps no information when it overwrites a
-sub-buffer before consuming it.
+In discard mode, LTTng increments a count of lost event records when an
+event record is lost and saves this count to the trace. In overwrite
+mode, since LTTng 2.8, LTTng increments a count of lost sub-buffers when
+a sub-buffer is lost and saves this count to the trace. In this mode,
+the exact number of lost event records in those lost sub-buffers is not
+saved to the trace. Trace analyses can use the trace's saved discarded
+event record and sub-buffer counts to decide whether or not to perform
+the analyses even if trace data is known to be missing.
There are a few ways to decrease your probability of losing event
records.
* **LTTng-tools**: Libraries and command-line interface to
control tracing sessions.
** <<lttng-sessiond,Session daemon>> (man:lttng-sessiond(8)).
-** <<lttng-consumerd,Consumer daemon>> (man:lttng-consumerd(8)).
+** <<lttng-consumerd,Consumer daemon>> (cmd:lttng-consumerd).
** <<lttng-relayd,Relay daemon>> (man:lttng-relayd(8)).
** <<liblttng-ctl-lttng,Tracing control library>> (`liblttng-ctl`).
** <<lttng-cli,Tracing control command-line tool>> (man:lttng(1)).
.The consumer daemon.
image::plumbing-consumerd.png[]
-The _consumer daemon_, man:lttng-consumerd(8), is a daemon which shares
+The _consumer daemon_, cmd:lttng-consumerd, is a daemon which shares
ring buffers with user applications or with the LTTng kernel modules to
collect trace data and send it to some location (on disk or to a
<<lttng-relayd,relay daemon>> over the network). The consumer daemon
.PIDs 3, 7, 10, and 13 are removed from the whitelist.
image::track-1-4-15-16.png[]
-LTTng can track all possible PIDs again using the opt:track(1):--all
-option:
+LTTng can track all possible PIDs again using the
+opt:lttng-track(1):--all option:
[role="term"]
----