X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=2.10%2Flttng-docs-2.10.txt;h=5d3fab6613fba00db71806ca21e8260467f28cfd;hb=3575940dbf51c5f828ad64879dcdf6b662dbfbd9;hp=defbdf687057eee30c05bca0c519ccaa4d1665ba;hpb=b0e4019318ed6e99056bf0540d9b5262ebcf5d66;p=lttng-docs.git diff --git a/2.10/lttng-docs-2.10.txt b/2.10/lttng-docs-2.10.txt index defbdf6..5d3fab6 100644 --- a/2.10/lttng-docs-2.10.txt +++ b/2.10/lttng-docs-2.10.txt @@ -1,7 +1,7 @@ The LTTng Documentation ======================= Philippe Proulx -v2.10, 3 October 2017 +v2.10, 12 November 2018 include::../common/copyright.txt[] @@ -321,65 +321,97 @@ but note that: applications. [role="growable"] -.Availability of LTTng{nbsp}{revision} for major Linux distributions as of 3 October 2017. +.Availability of LTTng{nbsp}{revision} for major Linux distributions as of 12 November 2018. |==== |Distribution |Available in releases |Alternatives |https://www.ubuntu.com/[Ubuntu] -|Ubuntu{nbsp}14.04 _Trusty Tahr_ and Ubuntu{nbsp}16.04 _Xenial Xerus_: -<>. -|link:/docs/v2.9#doc-ubuntu[LTTng{nbsp}2.9 for Ubuntu{nbsp}17.04 _Zesty Zapus_ and Ubuntu{nbsp}17.10 _Artful Aardvark_]. +|<>. -<> for -other Ubuntu releases. +Ubuntu{nbsp}14.04 _Trusty Tahr_, Ubuntu{nbsp}16.04 _Xenial Xerus_, +and Ubuntu{nbsp}18.04 _Bionic Beaver_: +<>. +|<>. |https://getfedora.org/[Fedora] -|<>. -|link:/docs/v2.9#doc-fedora[LTTng{nbsp}2.9 for Fedora 26]. - -<> for -other Fedora releases. +|xref:fedora["Fedora{nbsp}27, Fedora{nbsp}28, and Fedora{nbsp}29"]. +|<>. |https://www.debian.org/[Debian] -|<>. -|link:/docs/v2.9#doc-debian[LTTng{nbsp}2.9 for Debian "stretch" (stable)]. - -<>. +|<>. +|<>. |https://www.archlinux.org/[Arch Linux] |<>. |<>. |https://alpinelinux.org/[Alpine Linux] -|_Not available_ -|link:/docs/v2.9#doc-alpine-linux[LTTng{nbsp}2.9 for Alpine Linux "edge"]. +|<>. +|<>. -<>. +|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] -|_Not available_ -|link:/docs/v2.9#doc-buildroot[LTTng{nbsp}2.9 for Buildroot{nbsp}2017.02 and -Buildroot{nbsp}2017.05]. - -<>. +|xref:buildroot[Buildroot{nbsp}2018.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] |_Not available_ -|link:/docs/v2.9#doc-oe-yocto[LTTng{nbsp}2.9 for Yocto Project{nbsp}2.3 _Pyro_] -(`openembedded-core` layer). - -<>. +|<>. |==== [[ubuntu]] === [[ubuntu-official-repositories]]Ubuntu +LTTng{nbsp}{revision} is available on Ubuntu{nbsp}18.04 _Bionic Beaver_. +For previous supported releases of Ubuntu, +<>. + +To install LTTng{nbsp}{revision} on Ubuntu{nbsp}18.04 _Bionic Beaver_: + +. 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 @@ -389,6 +421,7 @@ LTTng{nbsp}{revision} packages for: * Ubuntu{nbsp}14.04 _Trusty Tahr_ * Ubuntu{nbsp}16.04 _Xenial Xerus_ +* Ubuntu{nbsp}18.04 _Bionic Beaver_ To install LTTng{nbsp}{revision} from the LTTng Stable{nbsp}{revision} PPA: @@ -440,7 +473,8 @@ To install LTTng{nbsp}{revision} from the LTTng Stable{nbsp}{revision} PPA: [[fedora]] === Fedora -To install LTTng{nbsp}{revision} on Fedora{nbsp}27: +To install LTTng{nbsp}{revision} on Fedora{nbsp}27, Fedora{nbsp}28, +or Fedora{nbsp}29: . Install the LTTng-tools{nbsp}{revision} and LTTng-UST{nbsp}{revision} packages: @@ -488,8 +522,7 @@ LTTng-UST{nbsp}{revision} from source and pass the [[debian]] === Debian -To install LTTng{nbsp}{revision} on Debian "buster" (testing) -or Debian "sid" (unstable): +To install LTTng{nbsp}{revision} on Debian "buster" (testing): . Install the main LTTng{nbsp}{revision} packages: + @@ -540,8 +573,8 @@ https://github.com/rmarquis/pacaur[pacaur] for the AUR packages: [role="term"] ---- # pacman -Sy lttng-ust -$ pacaur -Sy lttng-tools -$ pacaur -Sy lttng-modules +$ pikaur -Sy lttng-tools +$ pikaur -Sy lttng-modules ---- -- @@ -557,6 +590,71 @@ $ pacaur -Sy lttng-modules -- +[[alpine-linux]] +=== Alpine Linux + +To install LTTng-tools{nbsp}{revision} and LTTng-UST{nbsp}{revision} on +Alpine Linux{nbsp}3.7 or Alpine Linux{nbsp}3.8: + +. 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.0: + +* 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 @@ -565,6 +663,30 @@ 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, or +Buildroot{nbsp}2018.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**. + + [[building-from-source]] === Build from source @@ -1655,7 +1777,7 @@ The LTTng project incorporates: * **LTTng-tools**: Libraries and command-line interface to control tracing sessions. ** <> (man:lttng-sessiond(8)). -** <> (man:lttng-consumerd(8)). +** <> (cmd:lttng-consumerd). ** <> (man:lttng-relayd(8)). ** <> (`liblttng-ctl`). ** <> (man:lttng(1)). @@ -1951,7 +2073,7 @@ running. You can also start the session daemon manually. .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 <> over the network). The consumer daemon @@ -5725,8 +5847,9 @@ Tracepoint or system call name. In the case of a Linux KProbe or function, this is a custom name given to the event rule. With the JUL, log4j, and Python domains, this is a logger name. -With a tracepoint, logger, or system call name, the last character -can be `*` to match anything that remains. +With a tracepoint, logger, or system call name, you can use the special +`*` globbing character to match anything (for example, `sched_*`, +`my_comp*:*msg_*`). |All. @@ -6370,8 +6493,8 @@ leads to this whitelist: .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"] ----