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