index.rst

  1================================
  2Linux Tracing Technologies Guide
  3================================
  4
  5Tracing in the Linux kernel is a powerful mechanism that allows
  6developers and system administrators to analyze and debug system
  7behavior. This guide provides documentation on various tracing
  8frameworks and tools available in the Linux kernel.
  9
 10Introduction to Tracing
 11-----------------------
 12
 13This section provides an overview of Linux tracing mechanisms
 14and debugging approaches.
 15
 16.. toctree::
 17   :maxdepth: 1
 18
 19   debugging
 20   tracepoints
 21   tracepoint-analysis
 22   ring-buffer-map
 23
 24Core Tracing Frameworks
 25-----------------------
 26
 27The following are the primary tracing frameworks integrated into
 28the Linux kernel.
 29
 30.. toctree::
 31   :maxdepth: 1
 32
 33   ftrace
 34   ftrace-design
 35   ftrace-uses
 36   kprobes
 37   kprobetrace
 38   fprobetrace
 39   eprobetrace
 40   fprobe
 41   ring-buffer-design
 42
 43Event Tracing and Analysis
 44--------------------------
 45
 46A detailed explanation of event tracing mechanisms and their
 47applications.
 48
 49.. toctree::
 50   :maxdepth: 1
 51
 52   events
 53   events-kmem
 54   events-power
 55   events-nmi
 56   events-msr
 57   events-pci
 58   boottime-trace
 59   histogram
 60   histogram-design
 61
 62Hardware and Performance Tracing
 63--------------------------------
 64
 65This section covers tracing features that monitor hardware
 66interactions and system performance.
 67
 68.. toctree::
 69   :maxdepth: 1
 70
 71   intel_th
 72   stm
 73   sys-t
 74   coresight/index
 75   rv/index
 76   hisi-ptt
 77   mmiotrace
 78   hwlat_detector
 79   osnoise-tracer
 80   timerlat-tracer
 81
 82User-Space Tracing
 83------------------
 84
 85These tools allow tracing user-space applications and
 86interactions.
 87
 88.. toctree::
 89   :maxdepth: 1
 90
 91   user_events
 92   uprobetracer
 93
 94Additional Resources
 95--------------------
 96
 97For more details, refer to the respective documentation of each
 98tracing tool and framework.
 99
100.. only:: subproject and html
101
102   Indices
103   =======
104
105   * :ref:`genindex`