diff --git a/share/man/man7/Makefile b/share/man/man7/Makefile --- a/share/man/man7/Makefile +++ b/share/man/man7/Makefile @@ -30,6 +30,7 @@ stdint.7 \ sticky.7 \ tests.7 \ + tracing.7 tuning.7 MLINKS= intro.7 miscellaneous.7 diff --git a/share/man/man7/tracing.7 b/share/man/man7/tracing.7 new file mode 100644 --- /dev/null +++ b/share/man/man7/tracing.7 @@ -0,0 +1,76 @@ +.\"- +.\" SPDX-License-Identifier: BSD-2-Clause +.\" +.\" Copyright (c) 2025 Mateusz Piotrowski <0mp@FreeBSD.org> +.\" +.Dd June 14, 2025 +.Dt TRACING 7 +.Os +.Sh NAME +.Nm tracing +.Nd introduction to tracing and performance monitoring facilities +.Sh DESCRIPTION +.Fx +features a large variety of tracing and performance monitoring facilities. +Use them to measure performance and +troubleshoot kernel and userland problems both during +.Xr development 7 +and on production systems. +The facilities differ in scope, ease of use, overhead, design, and limitations. +.Ss DTrace +.Xr dtrace 1 +is the most versatile tracing framework available on +.Fx +and is capable of tracing throughout the +.Fx +software stack from the kernel to the applications running in userland. +Refer to +.Xr dtrace 1 +and +.Xr SDT 9 +for more details. +.Pp +.Xr dwatch 1 +is an user-friendly wrapper for DTrace. +It simplifies common DTrace usage patterns and requires less expert knowledge +to operate. +.Pp +.Ss Userland Tracing +.Xr truss 1 +is an easy-to-use alternative to +.Xr dtrace 1 +when simple system-call tracing is all the user needs. +It uses +.Xr ptrace 2 , +which is one of the classic interfaces for debugging and tracing processes. +.Pp +.Ss Kernel Tracing +Kernel tracing does not belong solely to the domain of DTrace. +.Pp +.Xr ktr 4 +is a facility for logging strings in the kernel. +It comes in handy for some niche purposes during kernel development. +.Pp +.Xr ktrace 1 +is a much more complete tracing facility than KTR. +It enables kernel trace logging for specified processes. +.Ss Hardware Counters +.Pp +.Xr pmcstat 8 Pq and its kernel counterpart, Xr hwmpc 4 +is the +.Fx +facility for conducting performance measurements with hardware counters. +.Ss Boot-Time And Shutdown Tracing +.Xr boottrace 4 +is a facility for tracing events at boot and shutdown. +Its target audience are system administrators. +.Pp +.Xr tslog 4 +is a developer-oriented tool for tracing boot-time events. +.Sh HISTORY +The +.Nm +manual page was written by +.An Mateusz Piotrowski Aq Mt 0mp@FreeBSD.org . +It first appeared in +.Fx 15.0 .