profiling

package

v0.6.1 Latest Latest Go to latest Published: Feb 2, 2026 License: MIT Imports: 11 Imported by: 0

Details

This section is empty.

This section is empty.

func Enable()

Enable turns on the global profiler.

func Summarize(w io.Writer)

Summarize prints a formatted, hierarchical summary of all timed spans to the writer.

type CobraProfiler struct {
	// contains filtered or unexported fields
}

CobraProfiler encapsulates profiling state and flag management for Cobra apps.

func NewCobraProfiler() *CobraProfiler

NewCobraProfiler creates a new profiler for Cobra integration.

func (p *CobraProfiler) AddFlags(cmd *cobra.Command)

AddFlags adds the profiling flags to the given Cobra command.

func (p *CobraProfiler) PostRun(cmd *cobra.Command, args []string)

PostRun is intended to be used as a Cobra PersistentPostRun hook. It finalizes profiling, writing files and printing summaries.

func (p *CobraProfiler) PreRun(cmd *cobra.Command, args []string) error

PreRun is intended to be used as a Cobra PersistentPreRunE hook. It initializes profiling based on the flags provided.

type Profiler struct {
	// contains filtered or unexported fields
}

Profiler manages a profiling session with nested timing spans.

type Stopper interface {
	Stop()
}

Stopper is an interface for stopping a timed span.

func Start(name string) Stopper

Start begins a new timed span with the given name. It returns a Stopper which must be used to end the span, typically via defer.