benchgate

Documentation

Overview

Package benchgate provides a fail-closed benchmark regression gate.

Index

• type Regression
  • func ParseAndCheck(path string, threshold float64) ([]Regression, error)

Types

type Regression

type Regression struct {
	Name          string
	Metric        string
	ChangePercent float64
	PValue        float64
}

Regression describes a statistically significant benchmark regression.

func ParseAndCheck

func ParseAndCheck(path string, threshold float64) ([]Regression, error)

ParseAndCheck reads benchstat -format=csv output and reports regressions whose positive change is both statistically significant and above threshold.