Documentation
¶
Index ¶
Constants ¶
View Source
const ( DegradingChange = -1 // represents a statistically significant degradation InsignificantChange = 0 // represents no statistically significant change ImprovingChange = 1 // represents a statistically significant improvement )
BenchmarkChangeType values
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Benchdiff ¶
type Benchdiff struct {
BenchCmd string
BenchArgs string
ResultsDir string
BaseRef string
Path string
GitCmd string
Writer io.Writer
Benchstat *benchstatter.Benchstat
Force bool
JSONOutput bool
Cooldown time.Duration
WarmupCount int
WarmupTime string
Debug *log.Logger
}
Benchdiff runs benchstats and outputs their deltas
type BenchmarkChangeType ¶
type BenchmarkChangeType int
BenchmarkChangeType is whether a change is an improvement or degradation
type RunResult ¶
type RunResult struct {
// contains filtered or unexported fields
}
RunResult is the result of a Run
func (*RunResult) HasDegradedResult ¶ added in v0.4.3
HasDegradedResult returns true if there are any rows with DegradingChange and PctDelta over tolerance
func (*RunResult) WriteOutput ¶
func (r *RunResult) WriteOutput(w io.Writer, opts *RunResultOutputOptions) error
WriteOutput outputs the result
type RunResultOutputOptions ¶
type RunResultOutputOptions struct {
BenchstatFormatter benchstatter.OutputFormatter // default benchstatter.TextFormatter(nil)
OutputFormat string // one of json or human. default: human
Tolerance float64
}
RunResultOutputOptions options for RunResult.WriteOutput
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.