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