stress

Documentation

Index

• Constants
• func CreateTextStressSummary(reqStatSummary RequestStatSummary) string
• func InitCmd(watchCmd *cobra.Command)
• func RunStress(s StressConfig, w io.Writer) ([][]RequestStat, error)
• type RequestStat
• type RequestStatSummary
  • func CreateRequestsStats(requestStats []RequestStat) RequestStatSummary
• type StressConfig
  • func NewStressConfig() (s *StressConfig)
• type Target

Constants

const (
	DefaultURL         = "http://localhost"
	DefaultTimeout     = "10s"
	DefaultMethod      = "GET"
	DefaultUserAgent   = "stress"
	DefaultCount       = 10
	DefaultConcurrency = 1
)

Reasonable default values for a target

Functions

func CreateTextStressSummary

func CreateTextStressSummary(reqStatSummary RequestStatSummary) string

CreateTextStressSummary creates a human friendly summary of entire stress test

func InitCmd

func InitCmd(watchCmd *cobra.Command)

func RunStress

func RunStress(s StressConfig, w io.Writer) ([][]RequestStat, error)

RunStress starts the stress tests with the provided StressConfig. Throughout the test, data is sent to w, useful for live updates.

Types

type RequestStat

type RequestStat struct {
	StartTime       time.Time `json:"startTime"`
	EndTime         time.Time `json:"endTime"`
	Error           error     `json:"error"`
	Proto           string
	Method          string
	URL             string
	Duration        time.Duration `json:"duration"`
	StatusCode      int           `json:"statusCode"`
	DataTransferred int
}

RequestStat is the saved information about an individual completed HTTP request

type RequestStatSummary

type RequestStatSummary struct {
	// contains filtered or unexported fields
}

RequestStatSummary is an aggregate statistical summary of a set of RequestStats

func CreateRequestsStats

func CreateRequestsStats(requestStats []RequestStat) RequestStatSummary

CreateRequestsStats creates a statistical summary out of the individual RequestStats

type StressConfig

type StressConfig struct {
	Cookies         string
	BasicAuth       string
	Body            string
	BodyFilename    string
	Headers         string
	UserAgent       string
	Timeout         string
	Method          string
	Targets         []Target
	Count           int
	Concurrency     int
	Verbose         bool
	DNSPrefetch     bool
	Quiet           bool
	Compress        bool
	KeepAlive       bool
	FollowRedirects bool
	NoHTTP2         bool
	EnforceSSL      bool
}

StressConfig is the top level struct that contains the configuration for a stress test

func NewStressConfig

func NewStressConfig() (s *StressConfig)

NewStressConfig creates a new StressConfig with package defaults

type Target

type Target struct {
	Cookies         string
	BasicAuth       string
	UserAgent       string
	Timeout         string
	Method          string
	Body            string
	BodyFilename    string
	Headers         string
	URL             string
	DNSPrefetch     bool
	RegexURL        bool
	Compress        bool
	KeepAlive       bool
	FollowRedirects bool
	NoHTTP2         bool
	EnforceSSL      bool
}

Target is location of where send the HTTP request and how to send it.