xref: /linux/Documentation/trace/index.rst (revision 746680ec6696585e30db3e18c93a63df9cbec39c)
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   boottime-trace
58   histogram
59   histogram-design
60
61Hardware and Performance Tracing
62--------------------------------
63
64This section covers tracing features that monitor hardware
65interactions and system performance.
66
67.. toctree::
68   :maxdepth: 1
69
70   intel_th
71   stm
72   sys-t
73   coresight/index
74   rv/index
75   hisi-ptt
76   mmiotrace
77   hwlat_detector
78   osnoise-tracer
79   timerlat-tracer
80
81User-Space Tracing
82------------------
83
84These tools allow tracing user-space applications and
85interactions.
86
87.. toctree::
88   :maxdepth: 1
89
90   user_events
91   uprobetracer
92
93Additional Resources
94--------------------
95
96For more details, refer to the respective documentation of each
97tracing tool and framework.
98
99.. only:: subproject and html
100
101   Indices
102   =======
103
104   * :ref:`genindex`
105