toc/docs.yml

   1 title: The <span class="reset-text-transform">LTTng</span> Documentation
   2 cats:
   3   - id: whats-new
   4     title: What's new in LTTng 2.6?
   5   - id: nuts-and-bolts
   6     title: Nuts and bolts
   7     cats:
   8       - id: what-is-tracing
   9         title: What is tracing?
  10       - id: lttng-alternatives
  11         title: Alternatives to LTTng
  12   - id: installing-lttng
  13     title: Installing <span class="reset-text-transform">LTTng</span>
  14     cats:
  15       - id: desktop-distributions
  16         title: Desktop distributions
  17         cats:
  18           - id: ubuntu
  19             title: Ubuntu
  20             cats:
  21               - id: ubuntu-official-repositories
  22                 title: Official repositories
  23               - id: ubuntu-ppa
  24                 title: PPA
  25           - id: fedora
  26             title: Fedora
  27           - id: debian
  28             title: Debian
  29           - id: opensuse
  30             title: openSUSE/RPM
  31           - id: archlinux
  32             title: Arch Linux
  33       - id: embedded-distributions
  34         title: Embedded distributions
  35         cats:
  36           - id: buildroot
  37             title: Buildroot
  38           - id: oe-yocto
  39             title: OpenEmbedded/Yocto
  40       - id: enterprise-distributions
  41         title: "Enterprise distributions (<abbr title=\"Red Hat Enterprise Linux\">RHEL</abbr>, <abbr title=\"SUSE Linux Enterprise Server\">SLES</abbr>)"
  42       - id: building-from-source
  43         title: Building from source
  44   - id: getting-started
  45     title: Getting started with <span class="reset-text-transform">LTTng</span>
  46     cats:
  47       - id: tracing-the-linux-kernel
  48         title: Tracing the Linux kernel
  49       - id: tracing-your-own-user-application
  50         title: Tracing your own user application
  51       - id: viewing-and-analyzing-your-traces
  52         title: Viewing and analyzing your traces
  53   - id: understanding-lttng
  54     title: Understanding <span class="reset-text-transform">LTTng</span>
  55     cats:
  56       - id: core-concepts
  57         title: Core concepts
  58         cats:
  59           - id: tracing-session
  60             title: Tracing session
  61           - id: domain
  62             title: Domain
  63           - id: channel
  64             title: Channel
  65             cats:
  66               - id: channel-overwrite-mode-vs-discard-mode
  67                 title: Overwrite and discard event loss modes
  68               - id: channel-subbuf-size-vs-subbuf-count
  69                 title: Sub-buffers count and size
  70               - id: channel-switch-timer
  71                 title: Switch timer
  72               - id: channel-buffering-schemes
  73                 title: Buffering schemes
  74           - id: event
  75             title: Event
  76       - id: plumbing
  77         title: Plumbing
  78         cats:
  79           - id: plumbing-overview
  80             title: Overview
  81           - id: lttng-sessiond
  82             title: Session daemon
  83           - id: lttng-consumerd
  84             title: Consumer daemon
  85           - id: lttng-relayd
  86             title: Relay daemon
  87           - id: liblttng-ctl-lttng
  88             title: Control library and command line interface
  89           - id: lttng-ust
  90             title: User space tracing library
  91           - id: lttng-modules
  92             title: <span class="reset-text-transform">LTTng</span> kernel modules
  93   - id: using-lttng
  94     title: Using <span class="reset-text-transform">LTTng</span>
  95     cats:
  96       - id: instrumenting
  97         title: Instrumenting
  98         cats:
  99           - id: c-application
 100             title: C application
 101             cats:
 102               - id: tracepoint-provider
 103                 title: Tracepoint provider
 104               - id: lttng-gen-tp
 105                 title: Using <code>lttng-gen-tp</code>
 106               - id: defining-tracepoints
 107                 title: Defining tracepoints
 108               - id: using-tracepoint-classes
 109                 title: Using tracepoint classes
 110               - id: assigning-log-levels
 111                 title: Assigning log levels to tracepoints
 112               - id: probing-the-application-source-code
 113                 title: Probing the application's source code
 114               - id: building-tracepoint-providers-and-user-application
 115                 title: Building/linking tracepoint providers and the user application
 116                 cats:
 117                   - id: static-linking
 118                     title: Static linking
 119                   - id: dynamic-linking
 120                     title: Dynamic linking
 121                   - id: using-lttng-ust-with-daemons
 122                     title: Using <span class="reset-text-transform">LTTng</span>-UST with daemons
 123                   - id: lttng-ust-pkg-config
 124                     title: <span class="reset-text-transform">pkg-config</span>
 125               - id: tracef
 126                 title: Using <code>tracef()</code>
 127               - id: lttng-ust-environment-variables-compiler-flags
 128                 title: <span class="reset-text-transform">LTTng</span>-UST environment variables and special compilation flags
 129           - id: cxx-application
 130             title: C++ application
 131           - id: prebuilt-ust-helpers
 132             title: Prebuilt user space tracing helpers
 133             cats:
 134               - id: liblttng‑ust‑libc‑pthread-wrapper
 135                 title: C standard library and POSIX threads tracing
 136               - id: liblttng‑ust‑cyg‑profile
 137                 title: Function tracing
 138               - id: liblttng‑ust‑dl
 139                 title: Dynamic linker tracing
 140           - id: java-application
 141             title: Java application
 142           - id: instrumenting-linux-kernel
 143             title: Linux kernel
 144             cats:
 145               - id: instrumenting-linux-kernel-itself
 146                 title: Instrumenting the Linux kernel for <span class="reset-text-transform">LTTng</span>
 147                 cats:
 148                   - id: mainline-trace-event
 149                     title: Defining/using tracepoints with mainline <code>TRACE_EVENT()</code> infrastructure
 150                   - id: lttng-adaptation-layer
 151                     title: Adding the <span class="reset-text-transform">LTTng</span> adaptation layer
 152                   - id: instrumenting-linux-kernel-tracing
 153                     title: Tracing
 154               - id: instrumenting-out-of-tree-linux-kernel
 155                 title: Instrumenting an out-of-tree Linux kernel module for <span class="reset-text-transform">LTTng</span>
 156           - id: proc-lttng-logger-abi
 157             title: <span class="reset-text-transform">LTTng</span> logger ABI
 158           - id: advanced-instrumenting-techniques
 159             title: Advanced techniques
 160             cats:
 161               - id: instrumenting-32-bit-app-on-64-bit-system
 162                 title: Instrumenting a 32-bit application on a 64-bit system
 163                 cats:
 164                   - id: building-32-bit-userspace-rcu
 165                     title: Building 32-bit Userspace RCU
 166                   - id: building-32-bit-lttng-ust
 167                     title: Building 32-bit <span class="reset-text-transform">LTTng</span>-UST
 168                   - id: building-32-bit-lttng-tools
 169                     title: Building 32-bit <span class="reset-text-transform">LTTng</span>-tools
 170                   - id: building-64-bit-lttng-tools
 171                     title: Building 64-bit <span class="reset-text-transform">LTTng</span>-tools
 172                   - id: building-instrumented-32-bit-c-application
 173                     title: Building an instrumented 32-bit C application
 174                   - id: running-32-bit-and-64-bit-c-applications
 175                     title: Running 32-bit and 64-bit versions of an instrumented C application
 176       - id: controlling-tracing
 177         title: Controlling tracing
 178         cats:
 179           - id: creating-destroying-tracing-sessions
 180             title: Creating and destroying tracing sessions
 181           - id: enabling-disabling-events
 182             title: Enabling and disabling events
 183           - id: basic-tracing-session-control
 184             title: Basic tracing session control
 185           - id: enabling-disabling-channels
 186             title: Enabling and disabling channels
 187             cats:
 188               - id: fine-tuning-channels
 189                 title: Fine-tuning channels
 190           - id: adding-context
 191             title: Adding some context to channels
 192           - id: saving-loading-tracing-session
 193             title: Saving and loading tracing session configurations
 194           - id: sending-trace-data-over-the-network
 195             title: Sending trace data over the network
 196           - id: lttng-live
 197             title: Viewing events as they arrive
 198           - id: taking-a-snapshot
 199             title: Taking a snapshot
 200           - id: mi
 201             title: Machine interface
 202   - id: reference
 203     title: Reference
 204     cats:
 205       - id: online-lttng-manpages
 206         title: Online <span class="reset-text-transform">LTTng</span> man pages
 207       - id: lttng-ust-ref
 208         title: <span class="reset-text-transform">LTTng</span>-UST
 209         cats:
 210           - id: liblttng-ust
 211             title: <span class="reset-text-transform">LTTng</span>-UST library (<code>liblttng&#8209;ust</code>)
 212             cats:
 213               - id: liblttng-ust-tp-fields
 214                 title: Tracepoint fields macros (for <code>TP_FIELDS()</code>)
 215               - id: liblttng-ust-tracepoint-loglevel
 216                 title: Tracepoint log levels (for <code>TRACEPOINT_LOGLEVEL()</code>)
 217       - id: lttng-modules-ref
 218         title: <span class="reset-text-transform">LTTng</span>-modules
 219         cats:
 220           - id: lttng-modules-tp-struct-entry
 221             title: Tracepoint fields macros (for <code>TP_STRUCT__entry()</code>)
 222           - id: lttng-modules-tp-fast-assign
 223             title: Tracepoint assignment macros (for <code>TP_fast_assign()</code>)