[[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]]
projects / lttng-docs.git / blobdiff