api

Documentation

Index

• type Builder
• type Constructor
• type Options
• type Parameter
• type RateFunction
  • func NewDistribution(distributionTypeArg string, iterationDuration time.Duration, ...) (time.Duration, RateFunction, error)
  • func WithJitter(rate RateFunction, multiple float64) RateFunction
• type Rates
• type Trigger
• type WorkTriggerer
  • func NewIterationWorker(iterationDuration time.Duration, rate RateFunction) WorkTriggerer

Types

type Builder

type Builder struct {
	Name              string
	Description       string
	New               Constructor
	Flags             *pflag.FlagSet
	IgnoreCommonFlags bool
}

type Constructor

type Constructor func(*pflag.FlagSet) (*Trigger, error)

type Options

type Options struct {
	MaxDuration   time.Duration
	Concurrency   int
	Verbose       bool
	VerboseFail   bool
	MaxIterations int32
	IgnoreDropped bool
	Scenario      string
}

type Parameter

type Parameter struct {
	Name        string
	Short       string
	Description string
	Default     string
}

type RateFunction

type RateFunction func(time.Time) int

func NewDistribution

func NewDistribution(distributionTypeArg string, iterationDuration time.Duration, rateFn RateFunction) (time.Duration, RateFunction, error)

func WithJitter

func WithJitter(rate RateFunction, multiple float64) RateFunction

type Rates

type Rates struct {
	IterationDuration time.Duration
	Rate              RateFunction
	Duration          time.Duration
}

type Trigger

type Trigger struct {
	Trigger     WorkTriggerer
	DryRun      RateFunction
	Description string
	Duration    time.Duration
	Options     Options
}

type WorkTriggerer

type WorkTriggerer func(doWork chan<- bool, stop <-chan bool, workDone <-chan bool, options options.RunOptions)

func NewIterationWorker

func NewIterationWorker(iterationDuration time.Duration, rate RateFunction) WorkTriggerer

NewIterationWorker produces a WorkTriggerer which triggers work at fixed intervals.