X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;f=2.8%2Flttng-docs-2.8.txt;h=446dea4f74a985c32d76c2774d24e0440cd3b3db;hb=1e0fb3c587ed3481e2762b41585803bcf09981e1;hp=79496e893dbdcd8f360777e29f8ab46ca60d53d8;hpb=837c451dae2f43e440a86b6d3dece350eb085f79;p=lttng-docs.git diff --git a/2.8/lttng-docs-2.8.txt b/2.8/lttng-docs-2.8.txt index 79496e8..446dea4 100644 --- a/2.8/lttng-docs-2.8.txt +++ b/2.8/lttng-docs-2.8.txt @@ -1,7 +1,7 @@ The LTTng Documentation ======================= Philippe Proulx -v2.8, 25 October 2016 +v2.8, 28 November 2016 include::../common/copyright.txt[] @@ -372,46 +372,43 @@ but note that: applications. [role="growable"] -.Availability of LTTng{nbsp}{revision} for major Linux distributions. +.Availability of LTTng{nbsp}{revision} for major Linux distributions as of 28 November 2016. |==== |Distribution |Available in releases |Alternatives |Ubuntu -|<> +|<>. |LTTng{nbsp}{revision} for Ubuntu{nbsp}14.04 _Trusty Tahr_ and Ubuntu{nbsp}16.04 _Xenial Xerus_: <>. +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]. + <> for other Ubuntu releases. |Fedora -|_Not available_ -|LTTng{nbsp}{revision} for Fedora{nbsp}25 and Fedora{nbsp}26 (not -released yet). - -<> for +|<>. +|<> for other Fedora releases. |Debian -|<> -| -<> for +|<>. +|<> for previous Debian releases. |openSUSE |_Not available_ -|LTTng{nbsp}2.7 for openSUSE Leap{nbsp}42.1. - -<> for -other openSUSE releases. +|<>. |Arch Linux -|Latest AUR packages. -| +|_Not available_ +|link:/docs/v2.9#doc-arch-linux[LTTng{nbsp}2.9 from the AUR]. |Alpine Linux -|<> +|<>. |LTTng{nbsp}{revision} for Alpine Linux{nbsp}3.5 (not released yet). <> for @@ -425,14 +422,11 @@ other Alpine Linux releases. |_Not available_ |LTTng{nbsp}{revision} for Buildroot{nbsp}2016.11 (not released yet). -LTTng{nbsp}2.7 for Buildroot{nbsp}2016.02, Buildroot{nbsp}2016.05, -and Buildroot{nbsp}2016.08. - <> for other Buildroot releases. |OpenEmbedded and Yocto -|<> (`openembedded-core` layer) +|<> (`openembedded-core` layer). |<> for other OpenEmbedded releases. |==== @@ -445,7 +439,7 @@ LTTng{nbsp}{revision} is available on Ubuntu{nbsp}16.10 _Yakkety Yak_. For previous releases of Ubuntu, <>. -To install LTTng{nbsp}{revision} on Ubuntu 16.10{nbsp}_Yakkety Yak_: +To install LTTng{nbsp}{revision} on Ubuntu{nbsp}16.10 _Yakkety Yak_: . Install the main LTTng{nbsp}{revision} packages: + @@ -470,7 +464,7 @@ sudo apt-get install liblttng-ust-agent-java -- . **If you need to instrument and trace - <>**, install the + <>**, install the LTTng-UST Python agent: + -- @@ -527,7 +521,7 @@ sudo apt-get install liblttng-ust-agent-java -- . **If you need to instrument and trace - <>**, install the + <>**, install the LTTng-UST Python agent: + -- @@ -538,6 +532,54 @@ sudo 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"] +---- +sudo yum install lttng-tools +sudo 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 <> 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. +==== + + [[debian]] === Debian @@ -578,8 +620,8 @@ sudo apt-get install python3-lttngust [[alpine-linux]] === Alpine Linux -To install LTTng{nbsp}{revision} (tracing control and user space -tracing) on Alpine Linux "edge": +To install LTTng-tools{nbsp}{revision} and LTTng-UST{nbsp}{revision} on +Alpine Linux "edge": . Make sure your system is https://wiki.alpinelinux.org/wiki/Edge[configured for "edge"]. @@ -2628,7 +2670,7 @@ holding more than one tracepoint providers. Once you <>, you can use the `tracepoint()` macro in your application's source code to insert the tracepoints that this header -<> defines. +<>. The `tracepoint()` macro takes at least two parameters: the tracepoint provider name and the tracepoint name. The corresponding tracepoint @@ -2837,10 +2879,11 @@ In the following diagrams, we use the following file names: `libemon.so`:: User library shared object file. -The red star indicates that this object file is instrumented -(contains code which uses the `tracepoint()` macro). The spring -symbol between the application and a library means the application is -linked with the library at build time. +We use the following symbols in the diagrams of table below: + +[role="img-100"] +.Symbols used in the build scenario diagrams. +image::ust-sit-symbols.png[] We assume that path:{.} is part of the env:LD_LIBRARY_PATH environment variable in the following instructions. @@ -3289,7 +3332,7 @@ include::../common/ust-sit-step-tp-so.txt[] To build the instrumented user library: . In path:{emon.c}, before including path:{tpp.h}, add the - following line: + following lines: + -- [source,c] @@ -3376,7 +3419,7 @@ include::../common/ust-sit-step-tp-so.txt[] To build the instrumented user library: . In path:{emon.c}, before including path:{tpp.h}, add the - following line: + following lines: + -- [source,c] @@ -3525,7 +3568,7 @@ include::../common/ust-sit-step-tp-so.txt[] To build the instrumented user library: . In path:{emon.c}, before including path:{tpp.h}, add the - following line: + following lines: + -- [source,c] @@ -3598,7 +3641,7 @@ include::../common/ust-sit-step-tp-so.txt[] To build the instrumented user library: . In path:{emon.c}, before including path:{tpp.h}, add the - following line: + following lines: + -- [source,c] @@ -4301,10 +4344,8 @@ Assuming no event record is lost, having only the function addresses on entry is enough to create a call graph, since an event record always contains the ID of the CPU that generated it. + -You can use a tool like -https://sourceware.org/binutils/docs/binutils/addr2line.html[cmd:addr2line] -to convert function addresses back to source file names and -line numbers. +You can use a tool like man:addr2line(1) to convert function addresses +back to source file names and line numbers. * **path:{liblttng-ust-cyg-profile.so}** is a more robust variant which also works in use cases where event records might get discarded or