pacer

Documentation

Index

• type Pacer
  • func NewConstantPacer(rate Rate) Pacer
  • func NewLinearRampUpPacer(startRate Rate, targetRate Rate, rampUpDuration time.Duration) Pacer
• type Rate

Types

type Pacer

type Pacer interface {
	// Pace returns the duration an Runner should wait until
	// hitting the next Target, given an already elapsed duration and
	// completed hits.
	Pace(elapsed time.Duration, hits uint64) (wait time.Duration)

	// Rate returns a Pacer's instantaneous hit rate (per seconds)
	// at the given elapsed duration of an execution.
	Rate(elapsed time.Duration) float64
}

A Pacer defines the rate of hits during an Attack.

func NewConstantPacer

func NewConstantPacer(rate Rate) Pacer

func NewLinearRampUpPacer

func NewLinearRampUpPacer(startRate Rate, targetRate Rate, rampUpDuration time.Duration) Pacer

NewLinearRampUpPacer creates a linear increase from the start to Target rate within the given RampUpDuration

type Rate

type Rate struct {
	Freq int           // Frequency (number of occurrences) per ...
	Per  time.Duration // Time unit, usually 1s
}