X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=2.9%2Flttng-docs-2.9.txt;h=7fe1dbe9c24520b9adb689dff39696b3df33bcf6;hb=35df69388ff1fdf8a57e81832f64fb1fc132054c;hp=79110f3f3be77c0ddcdb1bb60037ec5ba992ca10;hpb=ded026983bfe6b3ba0365bba59c93b4aa55bb37a;p=lttng-docs.git diff --git a/2.9/lttng-docs-2.9.txt b/2.9/lttng-docs-2.9.txt index 79110f3..7fe1dbe 100644 --- a/2.9/lttng-docs-2.9.txt +++ b/2.9/lttng-docs-2.9.txt @@ -1,7 +1,7 @@ The LTTng Documentation ======================= Philippe Proulx -v2.9, 20 February 2017 +v2.9, 22 January 2018 include::../common/copyright.txt[] @@ -340,71 +340,108 @@ but note that: applications. [role="growable"] -.Availability of LTTng{nbsp}{revision} for major Linux distributions as of 2 December 2016. +.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{nbsp}14.04 _Trusty Tahr_ and Ubuntu{nbsp}16.04 _Xenial Xerus_: -<>. -|link:/docs/v2.8#doc-ubuntu[LTTng{nbsp}2.8 for Ubuntu{nbsp}16.10 _Yakkety Yak_]. +|<>. -<> for +Ubuntu{nbsp}14.04 _Trusty Tahr_ and Ubuntu{nbsp}16.04 _Xenial Xerus_: +<>. +|<> for other Ubuntu releases. |https://getfedora.org/[Fedora] -|_Not available_ -|<>. +|<>. +|link:/docs/v2.10#doc-fedora[LTTng{nbsp}2.10 for Fedora{nbsp}27]. + +<> for +other Fedora releases. |https://www.debian.org/[Debian] -|_Not available_ -|<>. +|<>. +|link:/docs/v2.10#doc-debian[LTTng{nbsp}2.10 for Debian "buster" (testing) +and Debian "sid" (unstable)]. -|https://www.opensuse.org/[openSUSE] -|_Not available_ -|<>. + +<> 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]. + +<>. |https://alpinelinux.org/[Alpine Linux] |_Not available_ -|link:/docs/v2.8#doc-alpine-linux[LTTng{nbsp}2.8 for Alpine Linux{nbsp}"edge"]. +|link:/docs/v2.10#doc-alpine-linux[LTTng{nbsp}2.10 for Alpine Linux{nbsp}3.7 +and Alpine Linux{nbsp}"edge"]. -LTTng{nbsp}2.8 for Alpine Linux{nbsp}3.5 (not released yet). - -<> for -other Alpine Linux releases. +<>. |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.8#doc-buildroot[LTTng{nbsp}2.8 for Buildroot{nbsp}2016.11]. - -<> for +|<<"buildroot", "Buildroot{nbsp}2017.02, Buildroot{nbsp}2017.05, Buildroot{nbsp}2017.08, and Buildroot{nbsp}2017.11">>. +|<> for other Buildroot releases. |http://www.openembedded.org/wiki/Main_Page[OpenEmbedded] and https://www.yoctoproject.org/[Yocto] -|_Not available_ -|link:/docs/v2.8#doc-oe-yocto[LTTng{nbsp}2.8 for Yocto Project{nbsp}2.2 _Morty_] +|<> (`openembedded-core` layer). - -<> for -other OpenEmbedded releases. +|<> 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, <>. + +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 + <>**, 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 @@ -462,20 +499,77 @@ To install LTTng{nbsp}{revision} from the LTTng Stable{nbsp}{revision} PPA: -- -[[arch-linux]] -=== Arch Linux +[[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 <> 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. +==== + -To install LTTng{nbsp}{revision} on Arch Linux using -https://archlinux.fr/yaourt-en[Yaourt]: +[[debian]] +=== Debian + +To install LTTng{nbsp}{revision} on Debian "stretch" (stable): . Install the main LTTng{nbsp}{revision} packages: + -- [role="term"] ---- -$ yaourt -S lttng-tools -$ yaourt -S lttng-ust -$ yaourt -S lttng-modules +# 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 ---- -- @@ -485,8 +579,7 @@ $ yaourt -S lttng-modules -- [role="term"] ---- -$ yaourt -S python-lttngust -$ yaourt -S python2-lttngust +# apt-get install python3-lttngust ---- -- @@ -499,6 +592,73 @@ 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 <> 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 @@ -1358,10 +1518,14 @@ as soon as a there's no space left for a new event record, whereas in discard mode, the tracer only discards the event record that doesn't fit. -In discard mode, LTTng increments a count of lost event records when -an event record is lost and saves this count to the trace. In -overwrite mode, LTTng keeps no information when it overwrites a -sub-buffer before consuming it. +In discard mode, LTTng increments a count of lost event records when an +event record is lost and saves this count to the trace. In overwrite +mode, since LTTng 2.8, LTTng increments a count of lost sub-buffers when +a sub-buffer is lost and saves this count to the trace. In this mode, +the exact number of lost event records in those lost sub-buffers is not +saved to the trace. Trace analyses can use the trace's saved discarded +event record and sub-buffer counts to decide whether or not to perform +the analyses even if trace data is known to be missing. There are a few ways to decrease your probability of losing event records. @@ -1386,8 +1550,8 @@ to configure the sub-buffer count and size for them: * **High event throughput**: In general, prefer bigger sub-buffers to lower the risk of losing event records. + -Having bigger sub-buffers also ensures a lower sub-buffer switching -frequency. +Having bigger sub-buffers also ensures a lower +<>. + The number of sub-buffers is only meaningful if you create the channel in overwrite mode: in this case, if a sub-buffer overwrite happens, the @@ -1541,7 +1705,7 @@ With so many similar terms, it's easy to get confused. An **event** is the consequence of the execution of an _instrumentation point_, like a tracepoint that you manually place in some source code, or a Linux kernel KProbe. An event is said to _occur_ at a specific -time. Different actions can be taken upon the occurance of an event, +time. Different actions can be taken upon the occurrence of an event, like record the event's payload to a buffer. An **event record** is the representation of an event in a sub-buffer. A @@ -5177,12 +5341,12 @@ MODULE_VERSION(__stringify(LTTNG_MODULES_MAJOR_VERSION) "." ---- -- -. Edit path:{probes/Makefile} and add your new kernel module object +. Edit path:{probes/KBuild} and add your new kernel module object next to the existing ones: + -- [source,make] -.path:{probes/Makefile} +.path:{probes/KBuild} ---- # ... @@ -7204,7 +7368,7 @@ event:: or a Linux kernel KProbe. + An event is said to _occur_ at a specific time. Different actions can -be taken upon the occurance of an event, like record the event's payload +be taken upon the occurrence of an event, like record the event's payload to a sub-buffer. <>::