Documentation
¶
Index ¶
- Constants
- func RunTrackAuto(selections *Selections) error
- func RunTrackManual(selections *Selections) error
- type AbsoluteChange
- type FunctionChangeResult
- type ProfileChangeReport
- func (r *ProfileChangeReport) ApplyCIConfiguration(cicdConfig *internal.CIConfig, benchmarkName string)
- func (r *ProfileChangeReport) BestImprovement() *FunctionChangeResult
- func (r *ProfileChangeReport) ChooseOutputFormat(outputFormat string)
- func (r *ProfileChangeReport) WorstRegression() *FunctionChangeResult
- type Selections
Constants ¶
View Source
const ( SeverityNoneThreshold = 0.0 SeverityLowThreshold = 5.0 SeverityModerateThreshold = 15.0 SeverityHighThreshold = 30.0 )
Variables ¶
This section is empty.
Functions ¶
func RunTrackAuto ¶ added in v1.8.0
func RunTrackAuto(selections *Selections) error
runTrack handles the track command execution
func RunTrackManual ¶ added in v1.8.0
func RunTrackManual(selections *Selections) error
RunTrackManual receives the location of the .out / .prof files.
Types ¶
type AbsoluteChange ¶ added in v1.5.1
type FunctionChangeResult ¶
type FunctionChangeResult struct {
FunctionName string `json:"function_name"`
ChangeType string `json:"change_type"`
FlatChangePercent float64 `json:"flat_change_percent"`
CumChangePercent float64 `json:"cum_change_percent"`
FlatAbsolute AbsoluteChange `json:"flat_absolute"`
CumAbsolute AbsoluteChange `json:"cum_absolute"`
Timestamp time.Time `json:"timestamp"`
}
func (*FunctionChangeResult) Report ¶
func (cr *FunctionChangeResult) Report() string
Full detailed report
type ProfileChangeReport ¶
type ProfileChangeReport struct {
FunctionChanges []*FunctionChangeResult
}
func CheckPerformanceDifferences ¶
func CheckPerformanceDifferences(selections *Selections) (*ProfileChangeReport, error)
CheckPerformanceDifferences creates the profile report by comparing data from prof's auto run.
func (*ProfileChangeReport) ApplyCIConfiguration ¶ added in v1.8.0
func (r *ProfileChangeReport) ApplyCIConfiguration(cicdConfig *internal.CIConfig, benchmarkName string)
ApplyCIConfiguration applies CI/CD configuration filtering to the report
func (*ProfileChangeReport) BestImprovement ¶ added in v1.8.0
func (r *ProfileChangeReport) BestImprovement() *FunctionChangeResult
BestImprovement returns the single best improvement by absolute flat change percent. Returns nil if there are no improvements.
func (*ProfileChangeReport) ChooseOutputFormat ¶ added in v1.5.1
func (r *ProfileChangeReport) ChooseOutputFormat(outputFormat string)
func (*ProfileChangeReport) WorstRegression ¶ added in v1.6.0
func (r *ProfileChangeReport) WorstRegression() *FunctionChangeResult
WorstRegression returns the single worst regression by flat change percent. Returns nil if there are no regressions.
Click to show internal directories.
Click to hide internal directories.