metrics

Documentation

Index

• type ByteMetrics
• type LatencyMetrics
  • func (l *LatencyMetrics) Add(latency time.Duration)
  • func (l LatencyMetrics) Quantile(nth float64) time.Duration
• type LoadTestCollection
  • func NewLoadTestCollection(labels map[string]string) *LoadTestCollection
• type Metrics
  • func NewMetricAggregator(testid string, instanceid string, jobid string) *Metrics
  • func (m *Metrics) Add(r *scheduler.Metrics)
  • func (m *Metrics) Close()

Types

type ByteMetrics

type ByteMetrics struct {
	// Total is the total number of flowing bytes in an attack.
	Total uint64 `json:"total"`
	// Mean is the mean number of flowing bytes per hit.
	Mean float64 `json:"mean"`
}

ByteMetrics holds computed byte flow metrics.

type LatencyMetrics

type LatencyMetrics struct {
	// Total is the total latency sum of all requests in an attack.
	Total time.Duration `json:"total"`
	// Mean is the mean request latency.
	Mean time.Duration `json:"mean"`
	// P50 is the 50th percentile request latency.
	P50 time.Duration `json:"50th"`
	// P90 is the 90th percentile request latency.
	P90 time.Duration `json:"90th"`
	// P95 is the 95th percentile request latency.
	P95 time.Duration `json:"95th"`
	// P99 is the 99th percentile request latency.
	P99 time.Duration `json:"99th"`
	// Max is the maximum observed request latency.
	Max time.Duration `json:"max"`
	// Min is the minimum observed request latency.
	Min time.Duration `json:"min"`
	// contains filtered or unexported fields
}

LatencyMetrics holds computed request latency metrics.

func (*LatencyMetrics) Add

func (l *LatencyMetrics) Add(latency time.Duration)

Add adds the given latency to the latency metrics.

func (LatencyMetrics) Quantile

func (l LatencyMetrics) Quantile(nth float64) time.Duration

Quantile returns the nth quantile from the latency summary.

type LoadTestCollection

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

LoadTestCollection maintains prometheus metric collectors

func NewLoadTestCollection

func NewLoadTestCollection(labels map[string]string) *LoadTestCollection

NewLoadTestCollection returns a new prometheus metric collection

type Metrics

type Metrics struct {
	// Latencies holds computed request latency metrics.
	Latencies LatencyMetrics `json:"latencies"`

	// BytesIn holds computed incoming byte metrics.
	BytesIn ByteMetrics `json:"bytes_in"`

	// BytesOut holds computed outgoing byte metrics.
	BytesOut ByteMetrics `json:"bytes_out"`

	// Earliest is the earliest timestamp in a Result set.
	Earliest time.Time `json:"earliest"`

	// Latest is the latest timestamp in a Result set.
	Latest time.Time `json:"latest"`

	// End is the latest timestamp in a Result set plus its latency.
	End time.Time `json:"end"`

	// Duration is the duration of the attack.
	Duration time.Duration `json:"duration"`

	// Wait is the extra time waiting for responses from targets.
	Wait time.Duration `json:"wait"`

	// Requests is the total number of requests executed.
	Requests uint64 `json:"requests"`

	// Rate is the rate of sent requests per second.
	Rate float64 `json:"rate"`

	// Throughput is the rate of successful requests per second.
	Throughput float64 `json:"throughput"`

	// Success is the percentage of non-error responses.
	Success float64 `json:"success"`

	// StatusCodes is a histogram of the responses' status codes.
	StatusCodes map[string]int `json:"status_codes"`

	// Errors is a set of unique errors returned by the targets during the attack.
	Errors []string `json:"errors"`
	// contains filtered or unexported fields
}

Metrics holds metrics computed out of a slice of Results

func NewMetricAggregator

func NewMetricAggregator(testid string, instanceid string, jobid string) *Metrics

NewMetricAggregator Creates a new MAgg

func (*Metrics) Add

func (m *Metrics) Add(r *scheduler.Metrics)

Add implements the Add method of the Report interface by adding the given Result to Metrics.

func (*Metrics) Close

func (m *Metrics) Close()

Close implements the Close method of the Report interface by computing derived summary metrics which don't need to be run on every Add call.