toc/docs.yml

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