X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=2.10%2Flttng-docs-2.10.txt;h=962f2da2193743cfd48a22b104f143cb0705ac04;hb=4234ccdda72150973938401da0df5c5d8bb71ee8;hp=d237bcace6b83e07809c7b9556a64f545f98d284;hpb=9fe3b57a66d50c9ac5923a666fcb8451f0d0cdea;p=lttng-docs.git diff --git a/2.10/lttng-docs-2.10.txt b/2.10/lttng-docs-2.10.txt index d237bca..962f2da 100644 --- a/2.10/lttng-docs-2.10.txt +++ b/2.10/lttng-docs-2.10.txt @@ -300,6 +300,8 @@ becomes inactive or in real-time. [[installing-lttng]] == Installation +include::../common/warning-no-installation.txt[] + **LTTng** is a set of software <> which interact to <> the Linux kernel and user applications, and to <> (start and stop @@ -314,391 +316,14 @@ components are bundled into the following packages: 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_: -<>. - -|https://getfedora.org/[Fedora] -|xref:fedora[Fedora{nbsp}29, Fedora{nbsp}30, Fedora{nbsp}31, -and Fedora{nbsp}32]. - -|https://www.debian.org/[Debian] -|<>. - -|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] -|<>. - -|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] -|<>. -|==== - - -[[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, <>. - -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 - <>**, install the LTTng-UST - Java agent: -+ --- -[role="term"] ----- -# apt-get install liblttng-ust-agent-java ----- --- - -. **If you need to instrument and trace - <>**, 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 - <>**, install the LTTng-UST - Java agent: -+ --- -[role="term"] ----- -# apt-get install liblttng-ust-agent-java ----- --- - -. **If you need to instrument and trace - <>**, 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 <> on Fedora, you need to build and install -LTTng-UST{nbsp}{revision} <> 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 <> 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 <>**, install the LTTng-UST Java agent: -+ --- -[role="term"] ----- -# apt-get install liblttng-ust-agent-java ----- --- - -. **If you need to instrument and trace <>**, 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 <> on openSUSE, you need to build and install -LTTng-UST{nbsp}{revision} <> 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 <> 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 <> on Yocto/OpenEmbedded, you need to build and install -LTTng-UST{nbsp}{revision} <> 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 <> 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