mako

README

Mako

Mako is an open source project for performance testing in Knative. It offers capacities like data storage, charting, statistical aggregation and automated regression analysis.

This folder contains common code that can be used by all Knative projects, with which we can follow the same process to set up Mako and collaborate.

Documentation

Index

• func EscapeTag(tag string) string
• func NewCrossRunConfig(runCount int32, tags ...string) *tpb.CrossRunConfig
• func XTime(t time.Time) float64
• type Client
  • func Setup(ctx context.Context, extraTags ...string) (*Client, error)
  • func SetupHelper(ctx context.Context, benchmarkKey *string, benchmarkName *string, ...) (*Client, error)
  • func SetupWithBenchmarkConfig(ctx context.Context, benchmarkKey *string, benchmarkName *string, ...) (*Client, error)
  • func (c *Client) StoreAndHandleResult() error

Functions

func EscapeTag

func EscapeTag(tag string) string

EscapeTag replaces characters that Mako doesn't accept with ones it does.

func NewCrossRunConfig

func NewCrossRunConfig(runCount int32, tags ...string) *tpb.CrossRunConfig

NewCrossRunConfig returns a config that can be used in ThresholdAnalyzer. By using it, the Analyzer will only fail if there are xx continuous runs that cross the threshold.

func XTime

func XTime(t time.Time) float64

XTime converts a time.Time into a Mako x-axis compatible timestamp.

Types

type Client

type Client struct {
	Quickstore   *quickstore.Quickstore
	Context      context.Context
	ShutDownFunc func(context.Context)
	// contains filtered or unexported fields
}

Client is a wrapper that wraps all Mako related operations

func Setup

func Setup(ctx context.Context, extraTags ...string) (*Client, error)

func SetupHelper

func SetupHelper(ctx context.Context, benchmarkKey *string, benchmarkName *string, extraTags ...string) (*Client, error)

SetupHelper sets up the mako client for the provided benchmarkKey. It will add a few common tags and allow each benchmark to add custm tags as well. It returns the mako client handle to store metrics, a method to close the connection to mako server once done and error in case of failures.

func SetupWithBenchmarkConfig

func SetupWithBenchmarkConfig(ctx context.Context, benchmarkKey *string, benchmarkName *string, extraTags ...string) (*Client, error)

func (*Client) StoreAndHandleResult

func (c *Client) StoreAndHandleResult() error

StoreAndHandleResult stores the benchmarking data and handles the result.