index.rst 1.8 KB

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