package pprof

Import Path
	runtime/pprof (on go.dev)

Dependency Relation
	imports 23 packages, and imported by one package


Involved Source Files

	    elf.go
	    label.go
	    map.go
	    pe.go
	
		Package pprof writes runtime profiling data in the format expected
		by the pprof visualization tool.
		
		# Profiling a Go program
		
		The first step to profiling a Go program is to enable profiling.
		Support for profiling benchmarks built with the standard testing
		package is built into go test. For example, the following command
		runs benchmarks in the current directory and writes the CPU and
		memory profiles to cpu.prof and mem.prof:
		
			go test -cpuprofile cpu.prof -memprofile mem.prof -bench .
		
		To add equivalent profiling support to a standalone program, add
		code like the following to your main function:
		
			var cpuprofile = flag.String("cpuprofile", "", "write cpu profile to `file`")
			var memprofile = flag.String("memprofile", "", "write memory profile to `file`")
		
			func main() {
			    flag.Parse()
			    if *cpuprofile != "" {
			        f, err := os.Create(*cpuprofile)
			        if err != nil {
			            log.Fatal("could not create CPU profile: ", err)
			        }
			        defer f.Close() // error handling omitted for example
			        if err := pprof.StartCPUProfile(f); err != nil {
			            log.Fatal("could not start CPU profile: ", err)
			        }
			        defer pprof.StopCPUProfile()
			    }
		
			    // ... rest of the program ...
		
			    if *memprofile != "" {
			        f, err := os.Create(*memprofile)
			        if err != nil {
			            log.Fatal("could not create memory profile: ", err)
			        }
			        defer f.Close() // error handling omitted for example
			        runtime.GC() // get up-to-date statistics
			        // Lookup("allocs") creates a profile similar to go test -memprofile.
			        // Alternatively, use Lookup("heap") for a profile
			        // that has inuse_space as the default index.
			        if err := pprof.Lookup("allocs").WriteTo(f, 0); err != nil {
			            log.Fatal("could not write memory profile: ", err)
			        }
			    }
			}
		
		There is also a standard HTTP interface to profiling data. Adding
		the following line will install handlers under the /debug/pprof/
		URL to download live profiles:
		
			import _ "net/http/pprof"
		
		See the net/http/pprof package for more details.
		
		Profiles can then be visualized with the pprof tool:
		
			go tool pprof cpu.prof
		
		There are many commands available from the pprof command line.
		Commonly used commands include "top", which prints a summary of the
		top program hot-spots, and "web", which opens an interactive graph
		of hot-spots and their call graphs. Use "help" for information on
		all pprof commands.
		
		For more information about pprof, see
		https://github.com/google/pprof/blob/main/doc/README.md.

	    pprof_rusage.go
	    proto.go
	    proto_other.go
	    protobuf.go
	    protomem.go
	    runtime.go


Package-Level Type Names (total 18, in which 2 are exported)


	/* sort exporteds by:  |  */
	
		LabelSet is a set of labels.

		
			
		
			func Labels(args ...string) LabelSet
			
		
			func Do(ctx context.Context, labels LabelSet, f func(context.Context))
			func WithLabels(ctx context.Context, labels LabelSet) context.Context
			


	
		A Profile is a collection of stack traces showing the call sequences
		that led to instances of a particular event, such as allocation.
		Packages can create and maintain their own profiles; the most common
		use is for tracking resources that must be explicitly closed, such as files
		or network connections.
		
		A Profile's methods can be called from multiple goroutines simultaneously.
		
		Each Profile has a unique name. A few profiles are predefined:
		
			goroutine    - stack traces of all current goroutines
			heap         - a sampling of memory allocations of live objects
			allocs       - a sampling of all past memory allocations
			threadcreate - stack traces that led to the creation of new OS threads
			block        - stack traces that led to blocking on synchronization primitives
			mutex        - stack traces of holders of contended mutexes
		
		These predefined profiles maintain themselves and panic on an explicit
		[Profile.Add] or [Profile.Remove] method call.
		
		The CPU profile is not available as a Profile. It has a special API,
		the [StartCPUProfile] and [StopCPUProfile] functions, because it streams
		output to a writer during profiling.
		
		# Heap profile
		
		The heap profile reports statistics as of the most recently completed
		garbage collection; it elides more recent allocation to avoid skewing
		the profile away from live data and toward garbage.
		If there has been no garbage collection at all, the heap profile reports
		all known allocations. This exception helps mainly in programs running
		without garbage collection enabled, usually for debugging purposes.
		
		The heap profile tracks both the allocation sites for all live objects in
		the application memory and for all objects allocated since the program start.
		Pprof's -inuse_space, -inuse_objects, -alloc_space, and -alloc_objects
		flags select which to display, defaulting to -inuse_space (live objects,
		scaled by size).
		
		# Allocs profile
		
		The allocs profile is the same as the heap profile but changes the default
		pprof display to -alloc_space, the total number of bytes allocated since
		the program began (including garbage-collected bytes).
		
		# Block profile
		
		The block profile tracks time spent blocked on synchronization primitives,
		such as [sync.Mutex], [sync.RWMutex], [sync.WaitGroup], [sync.Cond], and
		channel send/receive/select.
		
		Stack traces correspond to the location that blocked (for example,
		[sync.Mutex.Lock]).
		
		Sample values correspond to cumulative time spent blocked at that stack
		trace, subject to time-based sampling specified by
		[runtime.SetBlockProfileRate].
		
		# Mutex profile
		
		The mutex profile tracks contention on mutexes, such as [sync.Mutex],
		[sync.RWMutex], and runtime-internal locks.
		
		Stack traces correspond to the end of the critical section causing
		contention. For example, a lock held for a long time while other goroutines
		are waiting to acquire the lock will report contention when the lock is
		finally unlocked (that is, at [sync.Mutex.Unlock]).
		
		Sample values correspond to the approximate cumulative time other goroutines
		spent blocked waiting for the lock, subject to event-based sampling
		specified by [runtime.SetMutexProfileFraction]. For example, if a caller
		holds a lock for 1s while 5 other goroutines are waiting for the entire
		second to acquire the lock, its unlock call stack will report 5s of
		contention.
		
		Runtime-internal locks are always reported at the location
		"runtime._LostContendedRuntimeLock". More detailed stack traces for
		runtime-internal locks can be obtained by setting
		`GODEBUG=runtimecontentionstacks=1` (see package [runtime] docs for
		caveats).

		
			
		
			
				Add adds the current execution stack to the profile, associated with value.
				Add stores value in an internal map, so value must be suitable for use as
				a map key and will not be garbage collected until the corresponding
				call to [Profile.Remove]. Add panics if the profile already contains a stack for value.
				
				The skip parameter has the same meaning as [runtime.Caller]'s skip
				and controls where the stack trace begins. Passing skip=0 begins the
				trace in the function calling Add. For example, given this
				execution stack:
				
					Add
					called from rpc.NewClient
					called from mypkg.Run
					called from main.main
				
				Passing skip=0 begins the stack trace at the call to Add inside rpc.NewClient.
				Passing skip=1 begins the stack trace at the call to NewClient inside mypkg.Run.

			
				Count returns the number of execution stacks currently in the profile.

			
				Name returns this profile's name, which can be passed to [Lookup] to reobtain the profile.

			
				Remove removes the execution stack associated with value from the profile.
				It is a no-op if the value is not in the profile.

			
				WriteTo writes a pprof-formatted snapshot of the profile to w.
				If a write to w returns an error, WriteTo returns that error.
				Otherwise, WriteTo returns nil.
				
				The debug parameter enables additional output.
				Passing debug=0 writes the gzip-compressed protocol buffer described
				in https://github.com/google/pprof/tree/main/proto#overview.
				Passing debug=1 writes the legacy text format with comments
				translating addresses to function names and line numbers, so that a
				programmer can read the profile without tools.
				
				The predefined profiles may assign meaning to other debug values;
				for example, when printing the "goroutine" profile, debug=2 means to
				print the goroutine stacks in the same form that a Go program uses
				when dying due to an unrecovered panic.

		
			func Lookup(name string) *Profile
			func NewProfile(name string) *Profile
			func Profiles() []*Profile
		
			
		
			


	


Package-Level Functions (total 60, in which 12 are exported)


	
		Do calls f with a copy of the parent context with the
		given labels added to the parent's label map.
		Goroutines spawned while executing f will inherit the augmented label-set.
		Each key/value pair in labels is inserted into the label map in the
		order provided, overriding any previous value for the same key.
		The augmented label map will be set for the duration of the call to f
		and restored once f returns.


	
		ForLabels invokes f with each label set on the context.
		The function f should return true to continue iteration or false to stop iteration early.


	
		Label returns the value of the label with the given key on ctx, and a boolean indicating
		whether that label exists.


	
		Labels takes an even number of strings representing key-value pairs
		and makes a [LabelSet] containing them.
		A label overwrites a prior label with the same key.
		Currently only the CPU and goroutine profiles utilize any labels
		information.
		See https://golang.org/issue/23458 for details.


	
		Lookup returns the profile with the given name, or nil if no such profile exists.


	
		NewProfile creates a new profile with the given name.
		If a profile with that name already exists, NewProfile panics.
		The convention is to use a 'import/path.' prefix to create
		separate name spaces for each package.
		For compatibility with various tools that read pprof data,
		profile names should not contain spaces.


	
		Profiles returns a slice of all the known profiles, sorted by name.


	
		SetGoroutineLabels sets the current goroutine's labels to match ctx.
		A new goroutine inherits the labels of the goroutine that created it.
		This is a lower-level API than [Do], which should be used instead when possible.


	
		StartCPUProfile enables CPU profiling for the current process.
		While profiling, the profile will be buffered and written to w.
		StartCPUProfile returns an error if profiling is already enabled.
		
		On Unix-like systems, StartCPUProfile does not work by default for
		Go code built with -buildmode=c-archive or -buildmode=c-shared.
		StartCPUProfile relies on the SIGPROF signal, but that signal will
		be delivered to the main program's SIGPROF signal handler (if any)
		not to the one used by Go. To make it work, call [os/signal.Notify]
		for [syscall.SIGPROF], but note that doing so may break any profiling
		being done by the main program.


	
		StopCPUProfile stops the current CPU profile, if any.
		StopCPUProfile only returns after all the writes for the
		profile have completed.


	
		WithLabels returns a new [context.Context] with the given labels added.
		A label overwrites a prior label with the same key.


	
		WriteHeapProfile is shorthand for [Lookup]("heap").WriteTo(w, 0).
		It is preserved for backwards compatibility.


	


Package-Level Variables (total 12, none are exported)

	


Package-Level Constants (total 45, none are exported)