xref: /linux/Documentation/trace/index.rst (revision 570f7e331f5febb30f1384817463c7e42b65ca7d)
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-landlock
58   events-pci
59   events-pci-controller
60   boottime-trace
61   histogram
62   histogram-design
63
64Hardware and Performance Tracing
65--------------------------------
66
67This section covers tracing features that monitor hardware
68interactions and system performance.
69
70.. toctree::
71   :maxdepth: 1
72
73   intel_th
74   stm
75   sys-t
76   coresight/index
77   rv/index
78   hisi-ptt
79   mmiotrace
80   hwlat_detector
81   osnoise-tracer
82   timerlat-tracer
83
84User-Space Tracing
85------------------
86
87These tools allow tracing user-space applications and
88interactions.
89
90.. toctree::
91   :maxdepth: 1
92
93   user_events
94   uprobetracer
95
96Remote Tracing
97--------------
98
99This section covers the framework to read compatible ring-buffers, written by
100entities outside of the kernel (most likely firmware or hypervisor)
101
102.. toctree::
103   :maxdepth: 1
104
105   remotes
106
107Additional Resources
108--------------------
109
110For more details, refer to the respective documentation of each
111tracing tool and framework.
112