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