bench

package

v0.1.0 Latest Latest Go to latest Published: Mar 24, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Package bench provides utilities for collecting and analyzing performance measurements.

This section is empty.

This section is empty.

This section is empty.

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

Bench tracks timing samples over a configurable duration for benchmarking.

func (b *Bench) End()

End records the total elapsed time since Start was called.

func (b *Bench) IsTestFinished() bool

IsTestFinished reports whether the benchmark has run long enough and collected enough samples.

func (b *Bench) Measure(fn func() error) error

Measure times the execution of fn and records the duration as a sample.

func (b *Bench) Results() Results

Results returns a snapshot of the collected benchmark results.

func (b *Bench) SetDuration(d time.Duration)

SetDuration sets the expected total duration for the benchmark run.

func (b *Bench) Start()

Start begins the benchmark timer.

type Results struct {
	Samples     []time.Duration
	TotDuration time.Duration
}

Results holds the collected timing samples and total duration of a benchmark run.

func (r Results) Avg() time.Duration

Avg returns the arithmetic mean of all collected samples.

func (r Results) Percentile(pctile float64) time.Duration

Percentile returns the sample value at the given percentile (0.0 to 1.0).