X-Git-Url: http://git.liburcu.org/?a=blobdiff_plain;f=2.10%2Flttng-docs-2.10.txt;h=defbdf687057eee30c05bca0c519ccaa4d1665ba;hb=b0e4019318ed6e99056bf0540d9b5262ebcf5d66;hp=37117b0b6c07ae8d9262465682a789a248af0440;hpb=eeb714962a4034a68fc39a5081cb65a375f19f82;p=lttng-docs.git diff --git a/2.10/lttng-docs-2.10.txt b/2.10/lttng-docs-2.10.txt index 37117b0..defbdf6 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, 1 August 2017 +v2.10, 3 October 2017 include::../common/copyright.txt[] @@ -138,7 +138,7 @@ instrumented with LTTng-UST which is explicitly allowed to block: [role="term"] ---- $ lttng create -$ lttng enable-channel --userspace --blocking-timeout=-1 blocking-channel +$ lttng enable-channel --userspace --blocking-timeout=inf blocking-channel $ lttng enable-event --userspace --channel=blocking-channel --all $ lttng start $ LTTNG_UST_ALLOW_BLOCKING=1 my-app @@ -321,34 +321,34 @@ but note that: applications. [role="growable"] -.Availability of LTTng{nbsp}{revision} for major Linux distributions as of 25 July 2017. +.Availability of LTTng{nbsp}{revision} for major Linux distributions as of 3 October 2017. |==== |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_]. +|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. |https://getfedora.org/[Fedora] -|_Not available_ +|<>. |link:/docs/v2.9#doc-fedora[LTTng{nbsp}2.9 for Fedora 26]. -<>. +<> for +other Fedora releases. |https://www.debian.org/[Debian] -|_Not available_ -|link:/docs/v2.9#doc-debian[LTTng{nbsp}2.9 for Debian "stretch" -(stable), Debian "buster" (testing), and Debian "sid" (unstable)]. +|<>. +|link:/docs/v2.9#doc-debian[LTTng{nbsp}2.9 for Debian "stretch" (stable)]. <>. |https://www.archlinux.org/[Arch Linux] -|_Not available_ -|link:/docs/v2.9#doc-arch-linux[LTTng{nbsp}2.9 in the latest AUR packages]. +|<>. +|<>. |https://alpinelinux.org/[Alpine Linux] |_Not available_ @@ -437,6 +437,126 @@ To install LTTng{nbsp}{revision} from the LTTng Stable{nbsp}{revision} PPA: -- +[[fedora]] +=== Fedora + +To install LTTng{nbsp}{revision} on Fedora{nbsp}27: + +. 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" (testing) +or Debian "sid" (unstable): + +. 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 +---- +-- + + +[[arch-linux]] +=== Arch Linux + +LTTng-UST{nbsp}{revision} is available in Arch Linux's _Community_ +repository, while LTTng-tools{nbsp}{revision} and +LTTng-modules{nbsp}{revision} are available in the +https://aur.archlinux.org/[AUR]. + +To install LTTng{nbsp}{revision} on Arch Linux, using +https://github.com/rmarquis/pacaur[pacaur] for the AUR packages: + +. Install the main LTTng{nbsp}{revision} packages: ++ +-- +[role="term"] +---- +# pacman -Sy lttng-ust +$ pacaur -Sy lttng-tools +$ pacaur -Sy lttng-modules +---- +-- + +. **If you need to instrument and trace <>**, install the LTTng-UST Python agent: ++ +-- +[role="term"] +---- +# pacman -Sy python-lttngust +# pacman -Sy python2-lttngust +---- +-- + + [[enterprise-distributions]] === RHEL, SUSE, and other enterprise distributions @@ -1308,15 +1428,19 @@ always keep a fixed amount of the latest data. Which mechanism you should choose depends on your context: prioritize the newest or the oldest event records in the ring buffer? -Beware that, in overwrite mode, the tracer abandons a whole sub-buffer +Beware that, in overwrite mode, the tracer abandons a _whole sub-buffer_ 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. @@ -5953,7 +6077,7 @@ in blocking mode to +__TIMEOUTUS__+: 0 (default):: Never block (non-blocking mode). --1:: +`inf`:: Block forever until space is available in a sub-buffer to record the event. @@ -6022,7 +6146,7 @@ and <>: [role="term"] ---- $ lttng create -$ lttng enable-channel --userspace --blocking-timeout=-1 blocking-channel +$ lttng enable-channel --userspace --blocking-timeout=inf blocking-channel $ lttng enable-event --userspace --channel=blocking-channel --all $ lttng start ----