The LTTng Documentation
=======================
Philippe Proulx <pproulx@efficios.com>
-v2.11, 6 April 2020
+v2.11, 5 August 2020
include::../common/copyright.txt[]
applications.
[role="growable"]
-.Availability of LTTng{nbsp}{revision} for major Linux distributions as of 30 March 2020.
+.Availability of LTTng{nbsp}{revision} for major Linux distributions as
+of 5{nbsp}August{nbsp}2020.
|====
|Distribution |Available in releases
|https://www.ubuntu.com/[Ubuntu]
-|Ubuntu{nbsp}16.04 _Xenial Xerus_ and Ubuntu{nbsp}18.04 _Bionic Beaver_:
-<<ubuntu-ppa,use the LTTng Stable{nbsp}{revision} PPA>>.
-
-|https://www.debian.org/[Debian]
-|<<debian,Debian "bullseye" (testing)>>.
+|<<ubuntu,Ubuntu{nbsp}20.04 _Focal Fossa_>>.
-|https://www.archlinux.org/[Arch Linux]
-|<<arch-linux,_Community_ repository and AUR>>.
+Ubuntu{nbsp}16.04 _Xenial Xerus_ and Ubuntu{nbsp}18.04 _Bionic Beaver_:
+<<ubuntu-ppa,use the LTTng Stable{nbsp}{revision} PPA>>.
|https://getfedora.org/[Fedora]
-|xref:fedora[Fedora{nbsp}32 and Fedora{nbsp}33].
+|<<fedora,Fedora{nbsp}32>>.
|https://www.redhat.com/[RHEL] and https://www.suse.com/[SLES]
|See http://packages.efficios.com/[EfficiOS Enterprise Packages].
|https://buildroot.org/[Buildroot]
-|xref:buildroot[Buildroot{nbsp}2019.11 and Buildroot{nbsp}2020.02].
+|xref:buildroot[Buildroot{nbsp}2019.11, Buildroot{nbsp}2020.02, and
+Buildroot{nbsp}2020.05].
+
+|https://www.openembedded.org/wiki/Main_Page[OpenEmbedded] and
+https://www.yoctoproject.org/[Yocto]
+|<<oe-yocto,Yocto Project{nbsp}3.1 _Dunfell_>>
+(`openembedded-core` layer).
|====
-[[ubuntu-ppa]]
-=== Ubuntu: noch:{LTTng} Stable {revision} PPA
+[[ubuntu]]
+=== [[ubuntu-official-repositories]]Ubuntu
-The https://launchpad.net/~lttng/+archive/ubuntu/stable-{revision}[LTTng
-Stable{nbsp}{revision} PPA] offers the latest stable
-LTTng{nbsp}{revision} packages for Ubuntu{nbsp}16.04 _Xenial Xerus_ and
-Ubuntu{nbsp}18.04 _Bionic Beaver_.
-
-To install LTTng{nbsp}{revision} from the LTTng Stable{nbsp}{revision}
-PPA:
+LTTng{nbsp}{revision} is available on Ubuntu{nbsp}20.04 _Focal Fossa_.
+For previous supported releases of Ubuntu,
+<<ubuntu-ppa,use the LTTng Stable{nbsp}{revision} PPA>>.
-. Add the LTTng Stable{nbsp}{revision} PPA repository and update the
- list of packages:
-+
---
-[role="term"]
-----
-# apt-add-repository ppa:lttng/stable-2.11
-# apt-get update
-----
---
+To install LTTng{nbsp}{revision} on Ubuntu{nbsp}20.04 _Focal Fossa_:
. Install the main LTTng{nbsp}{revision} packages:
+
----
--
+[[ubuntu-ppa]]
+=== Ubuntu: noch:{LTTng} Stable {revision} PPA
-[[debian]]
-=== Debian
-
-To install LTTng{nbsp}{revision} on Debian "bullseye" (testing):
+The https://launchpad.net/~lttng/+archive/ubuntu/stable-{revision}[LTTng
+Stable{nbsp}{revision} PPA] offers the latest stable
+LTTng{nbsp}{revision} packages for Ubuntu{nbsp}16.04 _Xenial Xerus_ and
+Ubuntu{nbsp}18.04 _Bionic Beaver_.
-. Install the main LTTng{nbsp}{revision} packages:
-+
---
-[role="term"]
-----
-# apt-get install lttng-modules-dkms
-# apt-get install liblttng-ust-dev
-# apt-get install lttng-tools
-----
---
+To install LTTng{nbsp}{revision} from the LTTng Stable{nbsp}{revision}
+PPA:
-. **If you need to instrument and trace <<java-application,Java
- applications>>**, install the LTTng-UST Java agent:
+. Add the LTTng Stable{nbsp}{revision} PPA repository and update the
+ list of packages:
+
--
[role="term"]
----
-# apt-get install liblttng-ust-agent-java
+# apt-add-repository ppa:lttng/stable-2.11
+# apt-get update
----
--
-. **If you need to instrument and trace <<python-application,Python
- applications>>**, install the LTTng-UST Python agent:
+. Install the main LTTng{nbsp}{revision} packages:
+
--
[role="term"]
----
-# apt-get install python3-lttngust
+# apt-get install lttng-tools
+# apt-get install lttng-modules-dkms
+# apt-get install liblttng-ust-dev
----
--
-
-[[arch-linux]]
-=== Arch Linux
-
-LTTng-UST{nbsp}{revision} is available in Arch Linux's _community_
-repository, while LTTng-tools{nbsp}{revision} and
-LTTng-modules{nbsp}{revision} are available in the
-https://aur.archlinux.org/[AUR].
-
-To install LTTng{nbsp}{revision} on Arch Linux, using
-https://github.com/Jguer/yay[yay] for the AUR packages:
-
-. Install the main LTTng{nbsp}{revision} packages:
+. **If you need to instrument and trace
+ <<java-application,Java applications>>**, install the LTTng-UST
+ Java agent:
+
--
[role="term"]
----
-# pacman -Sy lttng-ust
-$ yay -Sy lttng-tools
-$ yay -Sy lttng-modules
+# apt-get install liblttng-ust-agent-java
----
--
-. **If you need to instrument and trace <<python-application,Python
- applications>>**, install the LTTng-UST Python agent:
+. **If you need to instrument and trace
+ <<python-application,Python{nbsp}3 applications>>**, install the
+ LTTng-UST Python agent:
+
--
[role="term"]
----
-# pacman -Sy python-lttngust
-# pacman -Sy python2-lttngust
+# apt-get install python3-lttngust
----
--
[[fedora]]
=== Fedora
-To install LTTng{nbsp}{revision} on Fedora{nbsp}32 and Fedora{nbsp}33:
+To install LTTng{nbsp}{revision} on Fedora{nbsp}32:
. Install the LTTng-tools{nbsp}{revision} and LTTng-UST{nbsp}{revision}
packages:
[[buildroot]]
=== Buildroot
-To install LTTng{nbsp}{revision} on Buildroot{nbsp}2019.11 and
-Buildroot{nbsp}2020.02:
+To install LTTng{nbsp}{revision} on Buildroot{nbsp}2019.11,
+Buildroot{nbsp}2020.02, or Buildroot{nbsp}2020.05:
. Launch the Buildroot configuration tool:
+
**Other**, check **lttng-libust**.
+[[oe-yocto]]
+=== OpenEmbedded and Yocto
+
+LTTng{nbsp}{revision} recipes are available in the
+https://layers.openembedded.org/layerindex/branch/master/layer/openembedded-core/[`openembedded-core`]
+layer for Yocto Project{nbsp}3.1 _Dunfell_ under the following names:
+
+* `lttng-tools`
+* `lttng-modules`
+* `lttng-ust`
+
+With BitBake, the simplest way to include LTTng recipes in your target
+image is to add them to `IMAGE_INSTALL_append` in path:{conf/local.conf}:
+
+----
+IMAGE_INSTALL_append = " lttng-tools lttng-modules lttng-ust"
+----
+
+If you use Hob:
+
+. Select a machine and an image recipe.
+. Click **Edit image recipe**.
+. Under the **All recipes** tab, search for **lttng**.
+. Check the desired LTTng recipes.
+
+
[[building-from-source]]
=== Build from source