[[installing-lttng]]
== Installation
+include::../common/warning-no-installation.txt[]
+
**LTTng** is a set of software <<plumbing,components>> which interact to
<<instrumenting,instrument>> the Linux kernel and user applications, and
to <<controlling-tracing,control tracing>> (start and stop
trace user applications.
Most distributions mark the LTTng-modules and LTTng-UST packages as
-optional when installing LTTng-tools (which is always required). In the
-following sections, we always provide the steps to install all three,
-but note that:
+optional when installing LTTng-tools (which is always required). Note
+that:
* You only need to install LTTng-modules if you intend to trace the
Linux kernel.
* You only need to install LTTng-UST if you intend to trace user
applications.
-[role="growable"]
-.Availability of LTTng{nbsp}{revision} for major Linux distributions as of 18 October 2019.
-|====
-|Distribution |Available in releases
-
-|https://www.ubuntu.com/[Ubuntu]
-|xref:ubuntu[Ubuntu{nbsp}18.04 _Bionic Beaver_,
-Ubuntu{nbsp}19.04 _Disco Dingo_, and
-Ubuntu{nbsp}19.10 _Eoan Ermine_].
-
-Ubuntu{nbsp}16.04 _Xenial Xerus_:
-<<ubuntu-ppa,use the LTTng Stable{nbsp}{revision} PPA>>.
-
-|https://getfedora.org/[Fedora]
-|xref:fedora[Fedora{nbsp}29, Fedora{nbsp}30, Fedora{nbsp}31,
-and Fedora{nbsp}32].
-
-|https://www.debian.org/[Debian]
-|<<debian,Debian "buster" (stable) and Debian "bullseye" (testing)>>.
-
-|https://alpinelinux.org/[Alpine Linux]
-|xref:alpine-linux[Alpine Linux{nbsp}3.7, Alpine Linux{nbsp}3.8,
-Alpine Linux{nbsp}3.9, and Alpine Linux{nbsp}3.10].
-
-|https://www.opensuse.org/[openSUSE]
-|<<opensuse,openSUSE Leap{nbsp}15.1>>.
-
-|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}2018.02, Buildroot{nbsp}2018.05,
-Buildroot{nbsp}2018.08, Buildroot{nbsp}2018.11, Buildroot{nbsp}2019.02,
-Buildroot{nbsp}2018.05, Buildroot{nbsp}2018.08, and
-Buildroot{nbsp}2018.11].
-
-|http://www.openembedded.org/wiki/Main_Page[OpenEmbedded] and
-https://www.yoctoproject.org/[Yocto]
-|<<oe-yocto,Yocto Project{nbsp}2.7 _Warrior_ and
-Yocto Project{nbsp}3.0 _Zeus_>>.
-|====
-
-
-[[ubuntu]]
-=== [[ubuntu-official-repositories]]Ubuntu
-
-LTTng{nbsp}{revision} is available on:
-
-* Ubuntu{nbsp}18.04 _Bionic Beaver_
-* Ubuntu{nbsp}19.04 _Disco Dingo_
-* Ubuntu{nbsp}19.10 _Eoan Ermine_
-
-For other releases of Ubuntu, <<ubuntu-ppa,use the LTTng
-Stable{nbsp}{revision} PPA>>.
-
-To install LTTng{nbsp}{revision} on Ubuntu{nbsp}18.04 _Bionic Beaver_,
-Ubuntu{nbsp}19.04 _Disco Dingo_, or
-Ubuntu{nbsp}19.10 _Eoan Ermine_:
-
-. Install the main LTTng{nbsp}{revision} packages:
-+
---
-[role="term"]
-----
-# apt-get install lttng-tools
-# apt-get install lttng-modules-dkms
-# apt-get install liblttng-ust-dev
-----
---
-
-. **If you need to instrument and trace
- <<java-application,Java applications>>**, install the LTTng-UST
- Java agent:
-+
---
-[role="term"]
-----
-# apt-get install liblttng-ust-agent-java
-----
---
-
-. **If you need to instrument and trace
- <<python-application,Python{nbsp}3 applications>>**, install the
- LTTng-UST Python agent:
-+
---
-[role="term"]
-----
-# apt-get install python3-lttngust
-----
---
-
-
-[[ubuntu-ppa]]
-==== noch:{LTTng} Stable {revision} PPA
-
-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}18.04 _Bionic Beaver_.
-
-To install LTTng{nbsp}{revision} from 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.10
-# apt-get update
-----
---
-
-. Install the main LTTng{nbsp}{revision} packages:
-+
---
-[role="term"]
-----
-# apt-get install lttng-tools
-# apt-get install lttng-modules-dkms
-# apt-get install liblttng-ust-dev
-----
---
-
-. **If you need to instrument and trace
- <<java-application,Java applications>>**, install the LTTng-UST
- Java agent:
-+
---
-[role="term"]
-----
-# apt-get install liblttng-ust-agent-java
-----
---
-
-. **If you need to instrument and trace
- <<python-application,Python{nbsp}3 applications>>**, install the
- LTTng-UST Python agent:
-+
---
-[role="term"]
-----
-# apt-get install python3-lttngust
-----
---
-
-
-[[fedora]]
-=== Fedora
-
-To install LTTng{nbsp}{revision} on Fedora{nbsp}29, Fedora{nbsp}30,
-Fedora{nbsp}31, or Fedora{nbsp}32:
-
-. Install the LTTng-tools{nbsp}{revision} and LTTng-UST{nbsp}{revision}
- packages:
-+
---
-[role="term"]
-----
-# yum install lttng-tools
-# yum install lttng-ust
-----
---
-
-. 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.10.tar.bz2 &&
-tar -xf lttng-modules-latest-2.10.tar.bz2 &&
-cd lttng-modules-2.10.* &&
-make &&
-sudo make modules_install &&
-sudo depmod -a
-----
---
-
-[IMPORTANT]
-.Java and Python application instrumentation and tracing
-====
-If you need to instrument and trace <<java-application,Java
-applications>> on Fedora, you need to build and install
-LTTng-UST{nbsp}{revision} <<building-from-source,from source>> and pass
-the `--enable-java-agent-jul`, `--enable-java-agent-log4j`, or
-`--enable-java-agent-all` options to the `configure` script, depending
-on which Java logging framework you use.
-
-If you need to instrument and trace <<python-application,Python
-applications>> on Fedora, you need to build and install
-LTTng-UST{nbsp}{revision} from source and pass the
-`--enable-python-agent` option to the `configure` script.
-====
-
-
-[[debian]]
-=== Debian
-
-To install LTTng{nbsp}{revision} on Debian "buster" (stable) or
-Debian "bullseye" (testing):
-
-. 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
-----
---
-
-. **If you need to instrument and trace <<java-application,Java
- applications>>**, install the LTTng-UST Java agent:
-+
---
-[role="term"]
-----
-# apt-get install liblttng-ust-agent-java
-----
---
-
-. **If you need to instrument and trace <<python-application,Python
- applications>>**, install the LTTng-UST Python agent:
-+
---
-[role="term"]
-----
-# apt-get install python3-lttngust
-----
---
-
-
-[[alpine-linux]]
-=== Alpine Linux
-
-To install LTTng-tools{nbsp}{revision} and LTTng-UST{nbsp}{revision} on
-Alpine Linux{nbsp}3.7, Alpine Linux{nbsp}3.8, Alpine Linux{nbsp}3.9, or
-Alpine Linux{nbsp}3.10:
-
-. Add the LTTng packages:
-+
---
-[role="term"]
-----
-# apk add lttng-tools
-# apk add lttng-ust-dev
-----
---
-
-. 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.10.tar.bz2 &&
-tar -xf lttng-modules-latest-2.10.tar.bz2 &&
-cd lttng-modules-2.10.* &&
-make &&
-sudo make modules_install &&
-sudo depmod -a
-----
---
-
-
-[[opensuse]]
-=== noch:{openSUSE}
-
-To install LTTng{nbsp}{revision} on openSUSE Leap{nbsp}15.1:
-
-* Install the main LTTng{nbsp}{revision} packages:
-+
---
-[role="term"]
-----
-sudo zypper install lttng-tools
-sudo zypper install lttng-modules
-sudo zypper install lttng-ust-devel
-----
---
-
-[IMPORTANT]
-.Java and Python application instrumentation and tracing
-====
-If you need to instrument and trace <<java-application,Java
-applications>> on openSUSE, you need to build and install
-LTTng-UST{nbsp}{revision} <<building-from-source,from source>> and pass
-the `--enable-java-agent-jul`, `--enable-java-agent-log4j`, or
-`--enable-java-agent-all` options to the `configure` script, depending
-on which Java logging framework you use.
-
-If you need to instrument and trace <<python-application,Python
-applications>> on openSUSE, you need to build and install
-LTTng-UST{nbsp}{revision} from source and pass the
-`--enable-python-agent` option to the `configure` script.
-====
-
-
-[[enterprise-distributions]]
-=== RHEL, SUSE, and other enterprise distributions
-
-To install LTTng on enterprise Linux distributions, such as Red Hat
-Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SUSE), please
-see http://packages.efficios.com/[EfficiOS Enterprise Packages].
-
-
-[[buildroot]]
-=== Buildroot
-
-To install LTTng{nbsp}{revision} on Buildroot{nbsp}2018.02,
-Buildroot{nbsp}2018.05, Buildroot{nbsp}2018.08,
-Buildroot{nbsp}2018.11, Buildroot{nbsp}2019.02,
-Buildroot{nbsp}2019.05, Buildroot{nbsp}2019.08, or
-Buildroot{nbsp}2019.11:
-
-. Launch the Buildroot configuration tool:
-+
---
-[role="term"]
-----
-$ make menuconfig
-----
---
-
-. In **Kernel**, check **Linux kernel**.
-. In **Toolchain**, check **Enable WCHAR support**.
-. In **Target packages**{nbsp}→ **Debugging, profiling and benchmark**,
- check **lttng-modules** and **lttng-tools**.
-. In **Target packages**{nbsp}→ **Libraries**{nbsp}→
- **Other**, check **lttng-libust**.
-
-
-[[oe-yocto]]
-=== OpenEmbedded and Yocto
-
-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.7 _Warrior_ and
-Yocto Project{nbsp}3.0 _Zeus_ 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.
-
-[IMPORTANT]
-.Java and Python application instrumentation and tracing
-====
-If you need to instrument and trace <<java-application,Java
-applications>> on Yocto/OpenEmbedded, you need to build and install
-LTTng-UST{nbsp}{revision} <<building-from-source,from source>> and pass
-the `--enable-java-agent-jul`, `--enable-java-agent-log4j`, or
-`--enable-java-agent-all` options to the `configure` script, depending
-on which Java logging framework you use.
-
-If you need to instrument and trace <<python-application,Python
-applications>> on Yocto/OpenEmbedded, you need to build and install
-LTTng-UST{nbsp}{revision} from source and pass the
-`--enable-python-agent` option to the `configure` script.
-====
-
[[building-from-source]]
=== Build from source
[[installing-lttng]]
== Installing LTTng
-include::../common/warning-installation-outdated.txt[]
+include::../common/warning-no-installation.txt[]
**LTTng** is a set of software components which interact to allow
instrumenting the Linux kernel and user applications and controlling
User space tracing library.
Most distributions mark the LTTng-modules and LTTng-UST packages as
-optional. In the following sections, we always provide the steps to
-install all three, but be aware that LTTng-modules is only required if
-you intend to trace the Linux kernel and LTTng-UST is only required if
-you intend to trace user space applications.
-
-This chapter shows how to install the above packages on a Linux system.
-The easiest way is to use the package manager of the system's
-distribution (<<desktop-distributions,desktop>> or
-<<embedded-distributions,embedded>>). Support is also available for
-<<enterprise-distributions,enterprise distributions>>, such as Red Hat
-Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES).
-Otherwise, you can
-<<building-from-source,build the LTTng packages from source>>.
-
-
-[[desktop-distributions]]
-=== Desktop distributions
-
-Official LTTng {revision} packages are available for <<ubuntu,Ubuntu>> and
-<<debian,Debian>>.
-
-More recent versions of LTTng are available for Fedora, openSUSE,
-as well as Arch Linux.
-
-Should any issue arise when following the procedures below, please
-inform the http://lttng.org/community[community] about it.
-
-
-[[ubuntu]]
-==== Ubuntu
-
-LTTng {revision} is packaged in Ubuntu 15.04 _Vivid Vervet_. For other
-releases of Ubuntu, you need to build and install LTTng
-<<building-from-source,from source>>. Ubuntu 15.10 _Wily Werewolf_
-ships with link:/docs/v2.6/[LTTng 2.6].
-
-To install LTTng {revision} from the official Ubuntu repositories,
-simply use `apt-get`:
-
-[role="term"]
-----
-sudo apt-get install lttng-tools
-sudo apt-get install lttng-modules-dkms
-sudo apt-get install liblttng-ust-dev
-----
-
-
-[[debian]]
-==== Debian
-
-Debian "jessie" has official packages of LTTng {revision}:
-
-[role="term"]
-----
-sudo apt-get install lttng-tools
-sudo apt-get install lttng-modules-dkms
-sudo apt-get install liblttng-ust-dev
-----
-
-
-[[embedded-distributions]]
-=== Embedded distributions
-
-Some developers may be interested in tracing the Linux kernel and user space
-applications running on embedded systems. LTTng is packaged by two popular
-embedded Linux distributions: <<buildroot,Buildroot>> and
-<<oe-yocto,OpenEmbedded/Yocto>>.
-
-
-[[buildroot]]
-==== Buildroot
-
-LTTng {revision} packages in Buildroot 2014.11 and 2015.02 are named
-`lttng-tools`, `lttng-modules`, and `lttng-libust`.
-
-To enable them, start the Buildroot configuration menu as usual:
-
-[role="term"]
-----
-make menuconfig
-----
-
-In:
-
-* _Kernel_: make sure _Linux kernel_ is enabled
-* _Toolchain_: make sure the following options are enabled:
-** _Enable large file (files > 2GB) support_
-** _Enable WCHAR support_
-
-In _Target packages_/_Debugging, profiling and benchmark_, enable
-_lttng-modules_ and _lttng-tools_. In
-_Target packages_/_Libraries_/_Other_, enable _lttng-libust_.
-
-
-[[oe-yocto]]
-==== OpenEmbedded/Yocto
-
-LTTng {revision} recipes are available in the `openembedded-core` layer of
-OpenEmbedded from August 15th, 2014 to February 8th, 2015 under the
-following names:
-
-* `lttng-tools`
-* `lttng-modules`
-* `lttng-ust`
-
-Using 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're using Hob, click _Edit image recipe_ once you have selected
-a machine and an image recipe. Then, in the _All recipes_ tab, search
-for `lttng` and you should find and be able to include the three LTTng
-recipes.
-
-
-[[enterprise-distributions]]
-=== Enterprise distributions (RHEL, SLES)
-
-To install LTTng on enterprise Linux distributions
-(such as RHEL and SLES), please see
-http://packages.efficios.com/[EfficiOS Enterprise Packages].
-
-
-[[building-from-source]]
-=== Building from source
-
-As <<installing-lttng,previously stated>>, LTTng is shipped as three
-packages: LTTng-tools, LTTng-modules and LTTng-UST. LTTng-tools contains
-everything needed to control tracing sessions, while LTTng-modules is
-only needed for Linux kernel tracing and LTTng-UST is only needed for
-user space tracing.
-
-The tarballs are available in the
-http://lttng.org/download#build-from-source[Download section]
-of the LTTng website.
-
-Please refer to the path:{README.md} files provided by each package to
-properly build and install them.
-
-TIP: The aforementioned path:{README.md} files are rendered as
-rich text when https://github.com/lttng[viewed on GitHub].
+optional. Note that LTTng-modules is only required if you intend to
+trace the Linux kernel and LTTng-UST is only required if you intend to
+trace user space applications.
[[getting-started]]
[[installing-lttng]]
== Installing LTTng
-include::../common/warning-installation-outdated.txt[]
+include::../common/warning-no-installation.txt[]
**LTTng** is a set of software components which interact to allow
instrumenting the Linux kernel and user applications as well as
User space tracing library.
Most distributions mark the LTTng-modules and LTTng-UST packages as
-optional. In the following sections, the steps to install all three are
-always provided, but note that LTTng-modules is only required if
-you intend to trace the Linux kernel and LTTng-UST is only required if
-you intend to trace user space applications.
-
-This chapter shows how to install the above packages on a Linux system.
-The easiest way is to use the package manager of the system's
-distribution (<<desktop-distributions,desktop>> or
-<<embedded-distributions,embedded>>). Support is also available for
-<<enterprise-distributions,enterprise distributions>>, such as Red Hat
-Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES).
-Otherwise, you can
-<<building-from-source,build the LTTng packages from source>>.
-
-
-[[desktop-distributions]]
-=== Desktop distributions
-
-Official LTTng {revision} packages are available for
-<<ubuntu,Ubuntu>>, <<fedora,Fedora>>, and
-<<opensuse,openSUSE>> (and other RPM-based distributions).
-
-More recent versions of LTTng are available for Debian and Arch Linux.
-
-Should any issue arise when
-following the procedures below, please inform the
-link:/community[community] about it.
-
-
-[[ubuntu]]
-==== Ubuntu
-
-LTTng {revision} is packaged in Ubuntu 15.10 _Wily Werewolf_. For other
-releases of Ubuntu, you need to build and install LTTng {revision}
-<<building-from-source,from source>>. Ubuntu 15.04 _Vivid Vervet_
-ships with link:/docs/v2.5/[LTTng 2.5], whilst
-Ubuntu 16.04 _Xenial Xerus_ ships with
-link:/docs/v2.7/[LTTng 2.7].
-
-To install LTTng {revision} from the official Ubuntu repositories,
-simply use `apt-get`:
-
-[role="term"]
-----
-sudo apt-get install lttng-tools
-sudo apt-get install lttng-modules-dkms
-sudo apt-get install liblttng-ust-dev
-----
-
-If you need to trace
-<<java-application,Java applications>>,
-you need to install the LTTng-UST Java agent also:
-
-[role="term"]
-----
-sudo apt-get install liblttng-ust-agent-java
-----
-
-
-[[fedora]]
-==== Fedora
-
-Fedora 22 and Fedora 23 ship with official LTTng-tools {revision} and
-LTTng-UST {revision} packages. Simply use `yum`:
-
-[role="term"]
-----
-sudo yum install lttng-tools
-sudo yum install lttng-ust
-sudo yum install lttng-ust-devel
-----
-
-LTTng-modules {revision} still needs to be built and installed from
-source. For that, make sure that the `kernel-devel` package is
-already installed beforehand:
-
-[role="term"]
-----
-sudo yum install kernel-devel
-----
-
-Proceed on to fetch
-<<building-from-source,LTTng-modules {revision}'s source>>. Build and
-install it as follows:
-
-[role="term"]
-----
-KERNELDIR=/usr/src/kernels/$(uname -r) make
-sudo make modules_install
-----
-
-NOTE: If you need to trace <<java-application,Java applications>> on
-Fedora, you need to build and install LTTng-UST {revision}
-<<building-from-source,from source>> and use the
-`--enable-java-agent-jul`, `--enable-java-agent-log4j`, or
-`--enable-java-agent-all` options.
-
-
-[[opensuse]]
-==== openSUSE/RPM
-
-openSUSE 13.1 and openSUSE 13.2 have LTTng {revision} packages. To install
-LTTng {revision}, you first need to add an entry to your repository
-configuration. All LTTng repositories are available
-http://download.opensuse.org/repositories/devel:/tools:/lttng/[here].
-For example, the following commands adds the LTTng repository for
-openSUSE{nbsp}13.1:
-
-[role="term"]
-----
-sudo zypper addrepo http://download.opensuse.org/repositories/devel:/tools:/lttng/openSUSE_13.1/devel:tools:lttng.repo
-----
-
-Then, refresh the package database:
-
-[role="term"]
-----
-sudo zypper refresh
-----
-
-and install `lttng-tools`, `lttng-modules` and `lttng-ust-devel`:
-
-[role="term"]
-----
-sudo zypper install lttng-tools
-sudo zypper install lttng-modules
-sudo zypper install lttng-ust-devel
-----
-
-NOTE: If you need to trace <<java-application,Java applications>> on
-openSUSE, you need to build and install LTTng-UST {revision}
-<<building-from-source,from source>> and use the
-`--enable-java-agent-jul`, `--enable-java-agent-log4j`, or
-`--enable-java-agent-all` options.
-
-
-[[embedded-distributions]]
-=== Embedded distributions
-
-LTTng is packaged by two popular
-embedded Linux distributions: <<buildroot,Buildroot>> and
-<<oe-yocto,OpenEmbedded/Yocto>>.
-
-
-[[buildroot]]
-==== Buildroot
-
-LTTng {revision} is available in Buildroot since Buildroot 2015.05. The
-LTTng packages are named `lttng-tools`, `lttng-modules`, and `lttng-libust`.
-
-To enable them, start the Buildroot configuration menu as usual:
-
-[role="term"]
-----
-make menuconfig
-----
-
-In:
-
-* _Kernel_: make sure _Linux kernel_ is enabled
-* _Toolchain_: make sure the following options are enabled:
-** _Enable large file (files > 2GB) support_
-** _Enable WCHAR support_
-
-In _Target packages_/_Debugging, profiling and benchmark_, enable
-_lttng-modules_ and _lttng-tools_. In
-_Target packages_/_Libraries_/_Other_, enable _lttng-libust_.
-
-NOTE: If you need to trace <<java-application,Java applications>> on
-Buildroot, you need to build and install LTTng-UST {revision}
-<<building-from-source,from source>> and use the
-`--enable-java-agent-jul`, `--enable-java-agent-log4j`, or
-`--enable-java-agent-all` options.
-
-
-[[oe-yocto]]
-==== OpenEmbedded/Yocto
-
-LTTng {revision} recipes are available in the
-http://layers.openembedded.org/layerindex/branch/master/layer/openembedded-core/[`openembedded-core`]
-layer of OpenEmbedded since February 8th, 2015 under the following names:
-
-* `lttng-tools`
-* `lttng-modules`
-* `lttng-ust`
-
-Using 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're using Hob, click _Edit image recipe_ once you have selected
-a machine and an image recipe. Then, under the _All recipes_ tab, search
-for `lttng` and include the three LTTng recipes.
-
-NOTE: If you need to trace <<java-application,Java applications>> on
-OpenEmbedded/Yocto, you need to build and install LTTng-UST {revision}
-<<building-from-source,from source>> and use the
-`--enable-java-agent-jul`, `--enable-java-agent-log4j`, or
-`--enable-java-agent-all` options.
-
-
-[[enterprise-distributions]]
-=== Enterprise distributions (RHEL, SLES)
-
-To install LTTng on enterprise Linux distributions
-(such as RHEL and SLES), please see
-http://packages.efficios.com/[EfficiOS Enterprise Packages].
-
-
-[[building-from-source]]
-=== Building from source
-
-As <<installing-lttng,previously stated>>, LTTng is shipped as
-three packages: LTTng-tools, LTTng-modules, and LTTng-UST. LTTng-tools
-contains everything needed to control tracing sessions, while
-LTTng-modules is only needed for Linux kernel tracing and LTTng-UST is
-only needed for user space tracing.
-
-The tarballs are available in the
-http://lttng.org/download#build-from-source[Download section]
-of the LTTng website.
-
-Please refer to the path:{README.md} files provided by each package to
-properly build and install them.
-
-TIP: The aforementioned path:{README.md} files
-are rendered as rich text when https://github.com/lttng[viewed on GitHub].
+optional. Note that LTTng-modules is only required if you intend to
+trace the Linux kernel and LTTng-UST is only required if you intend to
+trace user space applications.
[[getting-started]]
[[installing-lttng]]
== Installation
-include::../common/warning-installation-outdated.txt[]
+include::../common/warning-no-installation.txt[]
**LTTng** is a set of software <<plumbing,components>> which interact to
<<instrumenting,instrument>> the Linux kernel and user applications, and
trace user applications.
Most distributions mark the LTTng-modules and LTTng-UST packages as
-optional when installing LTTng-tools (which is always required). In the
-following sections, we always provide the steps to install all three,
-but note that:
+optional when installing LTTng-tools (which is always required). Note
+that:
* You only need to install LTTng-modules if you intend to trace the
Linux kernel.
* You only need to install LTTng-UST if you intend to trace user
applications.
-[role="growable"]
-.Availability of LTTng{nbsp}{revision} for major Linux distributions.
-|====
-|Distribution |Available in releases |Alternatives
-
-|Ubuntu
-|<<ubuntu,Ubuntu{nbsp}16.04 _Xenial Xerus_>>
-|LTTng{nbsp}2.8 for Ubuntu{nbsp}16.10 _Yakkety Yak_.
-
-LTTng{nbsp}{revision} for Ubuntu{nbsp}12.04 _Precise Pangolin_,
-Ubuntu{nbsp}14.04 _Trusty Tahr_, and Ubuntu{nbsp}16.04 _Xenial Xerus_:
-<<ubuntu-ppa,use the LTTng Stable{nbsp}{revision} PPA>>.
-
-<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
-other Ubuntu releases.
-
-|Fedora
-|_Not available_
-|LTTng-tools{nbsp}{revision} and LTTng-UST{nbsp}{revision} for
-Fedora{nbsp}25 and Fedora{nbsp}26 (both are not released yet).
-
-<<building-from-source,Build LTTng-modules{nbsp}{revision} from
-source>>.
-
-<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
-other Fedora releases.
-
-|Debian
-|_Not available_
-|LTTng{nbsp}2.8 for Debian "stretch" (testing).
-
-<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
-other Debian releases.
-
-|openSUSE
-|<<opensuse,openSUSE Leap{nbsp}42.1>>
-|<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
-other openSUSE releases.
-
-|Arch Linux
-|_Not available_
-|
-LTTng{nbsp}2.8 on the AUR.
-
-<<building-from-source,Build LTTng{nbsp}{revision} from source>>.
-
-|Alpine Linux
-|_Not available_
-|LTTng{nbsp}2.8 for Alpine Linux "edge".
-
-LTTng{nbsp}2.8 for Alpine Linux{nbsp}3.5 (not released yet).
-
-<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
-other Alpine Linux releases.
-
-|RHEL and SLES
-|See http://packages.efficios.com/[EfficiOS Enterprise Packages].
-|
-
-|Buildroot
-|<<"buildroot","Buildroot{nbsp}2016.02, Buildroot{nbsp}2016.05,
-and Buildroot{nbsp}2016.08">>
-|LTTng{nbsp}2.8 for Buildroot{nbsp}2016.11 (not released yet).
-
-<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
-other Buildroot releases.
-
-|OpenEmbedded and Yocto
-|<<oe-yocto,Yocto Project{nbsp}2.1 _Krogoth_>> (`openembedded-core` layer)
-|LTTng{nbsp}2.8 for Yocto Project{nbsp}2.2 _Morty_.
-
-<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
-other Yocto releases.
-|====
-
-
-[[ubuntu]]
-=== [[ubuntu-official-repositories]]Ubuntu
-
-LTTng{nbsp}{revision} is available on Ubuntu{nbsp}16.04 _Xenial Xerus_.
-For previous releases of Ubuntu, <<ubuntu-ppa,use the LTTng
-Stable{nbsp}{revision} PPA>>.
-
-To install LTTng{nbsp}{revision} on Ubuntu{nbsp}16.04 _Xenial Xerus_:
-
-. Install the main LTTng{nbsp}{revision} packages:
-+
---
-[role="term"]
-----
-sudo apt-get install lttng-tools
-sudo apt-get install lttng-modules-dkms
-sudo apt-get install liblttng-ust-dev
-----
---
-
-. **If you need to instrument and trace
- <<java-application,Java applications>>**, install the LTTng-UST
- Java agent:
-+
---
-[role="term"]
-----
-sudo apt-get install liblttng-ust-agent-java
-----
---
-
-. **If you need to instrument and trace
- <<python-application,Python{nbsp}3 applications>>**, install the
- LTTng-UST Python agent:
-+
---
-[role="term"]
-----
-sudo apt-get install python3-lttngust
-----
---
-
-
-[[ubuntu-ppa]]
-==== noch:{LTTng} Stable {revision} PPA
-
-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}12.04 _Precise Pangolin_
-* Ubuntu{nbsp}14.04 _Trusty Tahr_
-* Ubuntu{nbsp}16.04 _Xenial Xerus_
-
-To install LTTng{nbsp}{revision} from the LTTng Stable{nbsp}{revision}
-PPA:
-
-. Add the LTTng Stable{nbsp}{revision} PPA repository and update the
- list of packages:
-+
---
-[role="term"]
-----
-sudo apt-add-repository ppa:lttng/stable-2.7
-sudo apt-get update
-----
---
-
-. Install the main LTTng{nbsp}{revision} packages:
-+
---
-[role="term"]
-----
-sudo apt-get install lttng-tools
-sudo apt-get install lttng-modules-dkms
-sudo apt-get install liblttng-ust-dev
-----
---
-
-. **If you need to instrument and trace
- <<java-application,Java applications>>**, install the LTTng-UST
- Java agent:
-+
---
-[role="term"]
-----
-sudo apt-get install liblttng-ust-agent-java
-----
---
-
-. **If you need to instrument and trace
- <<python-application,Python{nbsp}3 applications>>**, install the
- LTTng-UST Python agent:
-+
---
-[role="term"]
-----
-sudo apt-get install python3-lttngust
-----
---
-
-
-[[opensuse]]
-=== noch:{openSUSE}/RPM
-
-To install LTTng{nbsp}{revision} on openSUSE Leap{nbsp}42.1:
-
-* Install the main LTTng{nbsp}{revision} packages:
-+
---
-[role="term"]
-----
-sudo zypper install lttng-tools
-sudo zypper install lttng-modules
-sudo zypper install lttng-ust-devel
-----
---
-
-[IMPORTANT]
-.Java and Python application instrumentation and tracing
-====
-If you need to instrument and trace <<java-application,Java
-applications>> on openSUSE, you need to build and install
-LTTng-UST{nbsp}{revision} <<building-from-source,from source>> and pass
-the `--enable-java-agent-jul`, `--enable-java-agent-log4j`, or
-`--enable-java-agent-all` options to the `configure` script, depending
-on which Java logging framework you use.
-
-If you need to instrument and trace <<python-application,Python
-applications>> on openSUSE, you need to build and install
-LTTng-UST{nbsp}{revision} from source and pass the
-`--enable-python-agent` option to the `configure` script.
-====
-
-
-[[buildroot]]
-=== Buildroot
-
-To install LTTng{nbsp}{revision} on Buildroot{nbsp}2016.02,
-Buildroot{nbsp}2016.05, or Buildroot{nbsp}2016.08:
-
-. Launch the Buildroot configuration tool:
-+
---
-[role="term"]
-----
-make menuconfig
-----
---
-
-. In **Kernel**, check **Linux kernel**.
-. In **Toolchain**, check **Enable WCHAR support**.
-. In **Target packages**{nbsp}→ **Debugging, profiling and benchmark**,
- check **lttng-modules** and **lttng-tools**.
-. In **Target packages**{nbsp}→ **Libraries**{nbsp}→
- **Other**, check **lttng-libust**.
-
-
-[[oe-yocto]]
-=== OpenEmbedded and Yocto
-
-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.1 _Krogoth_ 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.
-
-[IMPORTANT]
-.Java and Python application instrumentation and tracing
-====
-If you need to instrument and trace <<java-application,Java
-applications>> on openSUSE, you need to build and install
-LTTng-UST{nbsp}{revision} <<building-from-source,from source>> and pass
-the `--enable-java-agent-jul`, `--enable-java-agent-log4j`, or
-`--enable-java-agent-all` options to the `configure` script, depending
-on which Java logging framework you use.
-
-If you need to instrument and trace <<python-application,Python
-applications>> on openSUSE, you need to build and install
-LTTng-UST{nbsp}{revision} from source and pass the
-`--enable-python-agent` option to the `configure` script.
-====
-
-
-[[enterprise-distributions]]
-=== RHEL, SUSE, and other enterprise distributions
-
-To install LTTng on enterprise Linux distributions, such as Red Hat
-Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SUSE), please
-see http://packages.efficios.com/[EfficiOS Enterprise Packages].
-
[[building-from-source]]
=== Build from source
[[installing-lttng]]
== Installation
-include::../common/warning-installation-outdated.txt[]
+include::../common/warning-no-installation.txt[]
**LTTng** is a set of software <<plumbing,components>> which interact to
<<instrumenting,instrument>> the Linux kernel and user applications, and
trace user applications.
Most distributions mark the LTTng-modules and LTTng-UST packages as
-optional when installing LTTng-tools (which is always required). In the
-following sections, we always provide the steps to install all three,
-but note that:
+optional when installing LTTng-tools (which is always required). Note
+that:
* You only need to install LTTng-modules if you intend to trace the
Linux kernel.
* You only need to install LTTng-UST if you intend to trace user
applications.
-[role="growable"]
-.Availability of LTTng{nbsp}{revision} for major Linux distributions as of 14 March 2017.
-|====
-|Distribution |Available in releases |Alternatives
-
-|https://www.ubuntu.com/[Ubuntu]
-|<<ubuntu,Ubuntu{nbsp}16.10 _Yakkety Yak_>>.
-|LTTng{nbsp}{revision} for Ubuntu{nbsp}14.04 _Trusty Tahr_
-and Ubuntu{nbsp}16.04 _Xenial Xerus_:
-<<ubuntu-ppa,use the LTTng Stable{nbsp}{revision} PPA>>.
-
-LTTng{nbsp}2.9 for Ubuntu{nbsp}14.04 _Trusty Tahr_
-and Ubuntu{nbsp}16.04 _Xenial Xerus_:
-link:/docs/v2.9#doc-ubuntu-ppa[use the LTTng Stable{nbsp}2.9 PPA].
-
-LTTng{nbsp}2.9 for Ubuntu{nbsp}17.04 _Zesty Zapus_ (not released
-yet).
-
-<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
-other Ubuntu releases.
-
-|https://getfedora.org/[Fedora]
-|<<fedora,Fedora{nbsp}25>>.
-|<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
-other Fedora releases.
-
-|https://www.debian.org/[Debian]
-|_Not available_
-|link:/docs/v2.9#doc-debian[LTTng{nbsp}2.9 for Debian "stretch" (testing)
-and Debian "sid" (unstable)].
-
-<<building-from-source,Build LTTng{nbsp}{revision} from source>>.
-
-|https://www.opensuse.org/[openSUSE]
-|_Not available_
-|<<building-from-source,Build LTTng{nbsp}{revision} from source>>.
-
-|https://www.archlinux.org/[Arch Linux]
-|_Not available_
-|link:/docs/v2.9#doc-arch-linux[LTTng{nbsp}2.9 from the AUR].
-
-<<building-from-source,Build LTTng{nbsp}{revision} from source>>.
-
-|https://alpinelinux.org/[Alpine Linux]
-|_Not available_
-|link:/docs/v2.9#doc-alpine-linux[LTTng{nbsp}2.9 for Alpine Linux "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 2016.11>>.
-|link:/docs/v2.9#doc-buildroot[LTTng{nbsp}2.9 for Buildroot 2017.02].
-
-<<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.2 _Morty_>> (`openembedded-core` layer).
-|LTTng{nbsp}2.9 for Yocto Project{nbsp}2.3 _Pyro_
-(`openembedded-core` layer) (not released yet).
-
-<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
-other OpenEmbedded releases.
-|====
-
-
-[[ubuntu]]
-=== [[ubuntu-official-repositories]]Ubuntu
-
-LTTng{nbsp}{revision} is available on Ubuntu{nbsp}16.10 _Yakkety Yak_.
-For previous releases of Ubuntu, <<ubuntu-ppa,use the LTTng
-Stable{nbsp}{revision} PPA>>.
-
-To install LTTng{nbsp}{revision} on Ubuntu{nbsp}16.10 _Yakkety Yak_:
-
-. Install the main LTTng{nbsp}{revision} packages:
-+
---
-[role="term"]
-----
-# apt-get install lttng-tools
-# apt-get install lttng-modules-dkms
-# apt-get install liblttng-ust-dev
-----
---
-
-. **If you need to instrument and trace
- <<java-application,Java applications>>**, install the LTTng-UST
- Java agent:
-+
---
-[role="term"]
-----
-# apt-get install liblttng-ust-agent-java
-----
---
-
-. **If you need to instrument and trace
- <<python-application,Python{nbsp}3 applications>>**, install the
- LTTng-UST Python agent:
-+
---
-[role="term"]
-----
-# apt-get install python3-lttngust
-----
---
-
-
-[[ubuntu-ppa]]
-==== noch:{LTTng} Stable {revision} PPA
-
-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}14.04 _Trusty Tahr_
-* Ubuntu{nbsp}16.04 _Xenial Xerus_
-
-To install LTTng{nbsp}{revision} from 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.8
-# apt-get update
-----
---
-
-. Install the main LTTng{nbsp}{revision} packages:
-+
---
-[role="term"]
-----
-# apt-get install lttng-tools
-# apt-get install lttng-modules-dkms
-# apt-get install liblttng-ust-dev
-----
---
-
-. **If you need to instrument and trace
- <<java-application,Java applications>>**, install the LTTng-UST
- Java agent:
-+
---
-[role="term"]
-----
-# apt-get install liblttng-ust-agent-java
-----
---
-
-. **If you need to instrument and trace
- <<python-application,Python{nbsp}3 applications>>**, install the
- LTTng-UST Python agent:
-+
---
-[role="term"]
-----
-# apt-get install python3-lttngust
-----
---
-
-
-[[fedora]]
-=== Fedora
-
-To install LTTng{nbsp}{revision} on Fedora{nbsp}25:
-
-. Install the LTTng-tools{nbsp}{revision} and LTTng-UST{nbsp}{revision}
- packages:
-+
---
-[role="term"]
-----
-# yum install lttng-tools
-# yum install lttng-ust
-----
---
-
-. 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.8.tar.bz2 &&
-tar -xf lttng-modules-latest-2.8.tar.bz2 &&
-cd lttng-modules-2.8.* &&
-make &&
-sudo make modules_install &&
-sudo depmod -a
-----
---
-
-[IMPORTANT]
-.Java and Python application instrumentation and tracing
-====
-If you need to instrument and trace <<java-application,Java
-applications>> on Fedora, you need to build and install
-LTTng-UST{nbsp}{revision} <<building-from-source,from source>> and pass
-the `--enable-java-agent-jul`, `--enable-java-agent-log4j`, or
-`--enable-java-agent-all` options to the `configure` script, depending
-on which Java logging framework you use.
-
-If you need to instrument and trace <<python-application,Python
-applications>> on Fedora, you need to build and install
-LTTng-UST{nbsp}{revision} from source and pass the
-`--enable-python-agent` option to the `configure` script.
-====
-
-
-[[enterprise-distributions]]
-=== RHEL, SUSE, and other enterprise distributions
-
-To install LTTng on enterprise Linux distributions, such as Red Hat
-Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SUSE), please
-see http://packages.efficios.com/[EfficiOS Enterprise Packages].
-
-
-[[buildroot]]
-=== Buildroot
-
-To install LTTng{nbsp}{revision} on Buildroot{nbsp}2016.11:
-
-. Launch the Buildroot configuration tool:
-+
---
-[role="term"]
-----
-$ make menuconfig
-----
---
-
-. In **Kernel**, check **Linux kernel**.
-. In **Toolchain**, check **Enable WCHAR support**.
-. In **Target packages**{nbsp}→ **Debugging, profiling and benchmark**,
- check **lttng-modules** and **lttng-tools**.
-. In **Target packages**{nbsp}→ **Libraries**{nbsp}→
- **Other**, check **lttng-libust**.
-
-
-[[oe-yocto]]
-=== OpenEmbedded and Yocto
-
-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.2 _Morty_ 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.
-
-[IMPORTANT]
-.Java and Python application instrumentation and tracing
-====
-If you need to instrument and trace <<java-application,Java
-applications>> on Yocto/OpenEmbedded, you need to build and install
-LTTng-UST{nbsp}{revision} <<building-from-source,from source>> and pass
-the `--enable-java-agent-jul`, `--enable-java-agent-log4j`, or
-`--enable-java-agent-all` options to the `configure` script, depending
-on which Java logging framework you use.
-
-If you need to instrument and trace <<python-application,Python
-applications>> on Yocto/OpenEmbedded, you need to build and install
-LTTng-UST{nbsp}{revision} from source and pass the
-`--enable-python-agent` option to the `configure` script.
-====
-
[[building-from-source]]
=== Build from source
[[installing-lttng]]
== Installation
+include::../common/warning-no-installation.txt[]
+
**LTTng** is a set of software <<plumbing,components>> which interact to
<<instrumenting,instrument>> the Linux kernel and user applications, and
to <<controlling-tracing,control tracing>> (start and stop
trace user applications.
Most distributions mark the LTTng-modules and LTTng-UST packages as
-optional when installing LTTng-tools (which is always required). In the
-following sections, we always provide the steps to install all three,
-but note that:
+optional when installing LTTng-tools (which is always required). Note
+that:
* You only need to install LTTng-modules if you intend to trace the
Linux kernel.
* You only need to install LTTng-UST if you intend to trace user
applications.
-[role="growable"]
-.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_ 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>>.
-|<<building-from-source,Build LTTng{nbsp}{revision} from source>> for
-other Ubuntu releases.
-
-|https://getfedora.org/[Fedora]
-|<<fedora,Fedora{nbsp}26>>.
-|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]
-|<<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
-other Debian releases.
-
-|https://www.archlinux.org/[Arch Linux]
-|_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]
-|_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, 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_ and Yocto Project{nbsp}2.4 _Rocko_>>
-(`openembedded-core` layer).
-|<<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_
-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_:
-
-. Install the main LTTng{nbsp}{revision} packages:
-+
---
-[role="term"]
-----
-# apt-get install lttng-tools
-# apt-get install lttng-modules-dkms
-# apt-get install liblttng-ust-dev
-----
---
-
-. **If you need to instrument and trace
- <<java-application,Java applications>>**, install the LTTng-UST
- Java agent:
-+
---
-[role="term"]
-----
-# apt-get install liblttng-ust-agent-java
-----
---
-
-. **If you need to instrument and trace
- <<python-application,Python{nbsp}3 applications>>**, install the
- LTTng-UST Python agent:
-+
---
-[role="term"]
-----
-# apt-get install python3-lttngust
-----
---
-
-
-[[ubuntu-ppa]]
-==== noch:{LTTng} Stable {revision} PPA
-
-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}14.04 _Trusty Tahr_
-* Ubuntu{nbsp}16.04 _Xenial Xerus_
-
-To install LTTng{nbsp}{revision} from 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.9
-# apt-get update
-----
---
-
-. Install the main LTTng{nbsp}{revision} packages:
-+
---
-[role="term"]
-----
-# apt-get install lttng-tools
-# apt-get install lttng-modules-dkms
-# apt-get install liblttng-ust-dev
-----
---
-
-. **If you need to instrument and trace
- <<java-application,Java applications>>**, install the LTTng-UST
- Java agent:
-+
---
-[role="term"]
-----
-# apt-get install liblttng-ust-agent-java
-----
---
-
-. **If you need to instrument and trace
- <<python-application,Python{nbsp}3 applications>>**, install the
- LTTng-UST Python agent:
-+
---
-[role="term"]
-----
-# apt-get install python3-lttngust
-----
---
-
-
-[[fedora]]
-=== Fedora
-
-To install LTTng{nbsp}{revision} on Fedora{nbsp}26:
-
-. Install the LTTng-tools{nbsp}{revision} and LTTng-UST{nbsp}{revision}
- packages:
-+
---
-[role="term"]
-----
-# yum install lttng-tools
-# yum install lttng-ust
-----
---
-
-. 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
-----
---
-
-[IMPORTANT]
-.Java and Python application instrumentation and tracing
-====
-If you need to instrument and trace <<java-application,Java
-applications>> on Fedora, you need to build and install
-LTTng-UST{nbsp}{revision} <<building-from-source,from source>> and pass
-the `--enable-java-agent-jul`, `--enable-java-agent-log4j`, or
-`--enable-java-agent-all` options to the `configure` script, depending
-on which Java logging framework you use.
-
-If you need to instrument and trace <<python-application,Python
-applications>> on Fedora, you need to build and install
-LTTng-UST{nbsp}{revision} from source and pass the
-`--enable-python-agent` option to the `configure` script.
-====
-
-
-[[debian]]
-=== Debian
-
-To install LTTng{nbsp}{revision} on Debian "stretch" (stable):
-
-. 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
-----
---
-
-. **If you need to instrument and trace <<java-application,Java
- applications>>**, install the LTTng-UST Java agent:
-+
---
-[role="term"]
-----
-# apt-get install liblttng-ust-agent-java
-----
---
-
-. **If you need to instrument and trace <<python-application,Python
- applications>>**, install the LTTng-UST Python agent:
-+
---
-[role="term"]
-----
-# apt-get install python3-lttngust
-----
---
-
-
-[[enterprise-distributions]]
-=== RHEL, SUSE, and other enterprise distributions
-
-To install LTTng on enterprise Linux distributions, such as Red Hat
-Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SUSE), please
-see http://packages.efficios.com/[EfficiOS Enterprise Packages].
-
-
-[[buildroot]]
-=== Buildroot
-
-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:
-+
---
-[role="term"]
-----
-$ make menuconfig
-----
---
-
-. In **Kernel**, check **Linux kernel**.
-. In **Toolchain**, check **Enable WCHAR support**.
-. In **Target packages**{nbsp}→ **Debugging, profiling and benchmark**,
- check **lttng-modules** and **lttng-tools**.
-. In **Target packages**{nbsp}→ **Libraries**{nbsp}→
- **Other**, check **lttng-libust**.
-
-
-[[oe-yocto]]
-=== OpenEmbedded and Yocto
-
-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_ and Yocto Project{nbsp}2.4 _Rocko_
-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.
-
-[IMPORTANT]
-.Java and Python application instrumentation and tracing
-====
-If you need to instrument and trace <<java-application,Java
-applications>> on Yocto/OpenEmbedded, you need to build and install
-LTTng-UST{nbsp}{revision} <<building-from-source,from source>> and pass
-the `--enable-java-agent-jul`, `--enable-java-agent-log4j`, or
-`--enable-java-agent-all` options to the `configure` script, depending
-on which Java logging framework you use.
-
-If you need to instrument and trace <<python-application,Python
-applications>> on Yocto/OpenEmbedded, you need to build and install
-LTTng-UST{nbsp}{revision} from source and pass the
-`--enable-python-agent` option to the `configure` script.
-====
-
[[building-from-source]]
=== Build from source
+++ /dev/null
-[WARNING]
-.Obsolete information
-=====
-The installation information shown in this section may be **outdated**
-because this version of the LTTng Documentation is **not maintained
-anymore**.
-
-Visit the link:/docs[latest LTTng Documentation version].
-=====
--- /dev/null
+[WARNING]
+.Obsolete information
+=====
+The installation documentation for distributions is not available
+because this version of the LTTng Documentation is **not maintained
+anymore**.
+
+Visit the link:/docs[latest LTTng Documentation version].
+=====
projects / lttng-docs.git / commitdiff
