Documentation
¶
Index ¶
- Constants
- Variables
- func Connections(n int) func(*Attacker)
- func HTTP2(enabled bool) func(*Attacker)
- func KeepAlive(keepalive bool) func(*Attacker)
- func LocalAddr(addr net.IPAddr) func(*Attacker)
- func Redirects(n int) func(*Attacker)
- func TLSConfig(c *tls.Config) func(*Attacker)
- func Timeout(d time.Duration) func(*Attacker)
- func Workers(n uint64) func(*Attacker)
- type Attacker
- type Buckets
- type ByteMetrics
- type Closer
- type Decoder
- type Encoder
- type Histogram
- type LatencyMetrics
- type Metrics
- type Report
- type Reporter
- type Result
- type Results
- type Target
- type Targeter
Constants ¶
const ( // DefaultRedirects is the default number of times an Attacker follows // redirects. DefaultRedirects = 10 // DefaultTimeout is the default amount of time an Attacker waits for a request // before it times out. DefaultTimeout = 30 * time.Second // DefaultConnections is the default amount of max open idle connections per // target host. DefaultConnections = 10000 // DefaultWorkers is the default initial number of workers used to carry an attack. DefaultWorkers = 10 // NoFollow is the value when redirects are not followed but marked successful NoFollow = -1 )
Variables ¶
var ( // DefaultLocalAddr is the default local IP address an Attacker uses. DefaultLocalAddr = net.IPAddr{IP: net.IPv4zero} // DefaultTLSConfig is the default tls.Config an Attacker uses. DefaultTLSConfig = &tls.Config{InsecureSkipVerify: true} )
var ( // ErrNoTargets is returned when not enough Targets are available. ErrNoTargets = errors.New("no targets to attack") // ErrNilTarget is returned when the passed Target pointer is nil. ErrNilTarget = errors.New("nil target") )
Functions ¶
func Connections ¶
Connections returns a functional option which sets the number of maximum idle open connections per target host.
func HTTP2 ¶
HTTP2 returns a functional option which enables or disables HTTP/2 support on requests performed by an Attacker.
func KeepAlive ¶
KeepAlive returns a functional option which toggles KeepAlive connections on the dialer and transport.
func LocalAddr ¶
LocalAddr returns a functional option which sets the local address an Attacker will use with its requests.
func Redirects ¶
Redirects returns a functional option which sets the maximum number of redirects an Attacker will follow.
func TLSConfig ¶
TLSConfig returns a functional option which sets the *tls.Config for a Attacker to use with its requests.
Types ¶
type Attacker ¶
type Attacker struct {
// contains filtered or unexported fields
}
Attacker is an attack executor which wraps an http.Client
func NewAttacker ¶
NewAttacker returns a new Attacker with default options which are overridden by the optionally provided opts.
type Buckets ¶
Buckets represents an Histogram's latency buckets.
func (*Buckets) UnmarshalText ¶
UnmarshalText implements the encoding.TextUnmarshaler interface.
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 Closer ¶
type Closer interface {
// Close permantently closes a Report, running any necessary book keeping.
Close()
}
Closer wraps the optional Report Close method.
type Decoder ¶
A Decoder decodes a Result and returns an error in case of failure.
func NewDecoder ¶
NewDecoder returns a new Result decoder closure for the given io.Readers. It round robins across the io.Readers on every invocation and decoding error.
type Encoder ¶
An Encoder encodes a Result and returns an error in case of failure.
func NewCSVEncoder ¶
NewCSVEncoder returns an Encoder that dumps the given *Result as a CSV record with six columns. The columns are: UNIX timestamp in ns since epoch, HTTP status code, request latency in ns, bytes out, bytes in, and lastly the error.
func NewEncoder ¶
NewEncoder returns a new Result encoder closure for the given io.Writer
func NewJSONEncoder ¶
NewJSONEncoder returns an Encoder that dumps the given *Results as a JSON object.
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"`
// 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"`
}
LatencyMetrics holds computed request latency metrics.
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"`
// First 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 requests per second.
Rate float64 `json:"rate"`
// 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 which are used in some of the Reporters
type Report ¶
type Report interface {
// Add adds a given *Result to a Report.
Add(*Result)
}
A Report represents the state a Reporter uses to write out its reports.
type Reporter ¶
A Reporter function writes out reports to the given io.Writer or returns an error in case of failure.
func NewHistogramReporter ¶
NewHistogramReporter returns a Reporter that writes out a Histogram as aligned, formatted text.
func NewJSONReporter ¶
NewJSONReporter returns a Reporter that writes out Metrics as JSON.
func NewPlotReporter ¶
NewPlotReporter returns a Reporter that writes a self-contained HTML page with an interactive plot of the latencies of Requests, built with http://dygraphs.com/
func NewTextReporter ¶
NewTextReporter returns a Reporter that writes out Metrics as aligned, formatted text.
type Result ¶
type Result struct {
Code uint16 `json:"code"`
Timestamp time.Time `json:"timestamp"`
Latency time.Duration `json:"latency"`
BytesOut uint64 `json:"bytes_out"`
BytesIn uint64 `json:"bytes_in"`
Error string `json:"error"`
}
Result represents the metrics defined out of an http.Response generated by each target hit
type Results ¶
type Results []Result
Results is a slice of Result type elements.
func (*Results) Add ¶
Add implements the Add method of the Report interface by appending the given Result to the slice.
type Targeter ¶
A Targeter decodes a Target or returns an error in case of failure. Implementations must be safe for concurrent use.
func NewEagerTargeter ¶
NewEagerTargeter eagerly reads all Targets out of the provided io.Reader and returns a NewStaticTargeter with them.
body will be set as the Target's body if no body is provided. hdr will be merged with the each Target's headers.
func NewLazyTargeter ¶
NewLazyTargeter returns a new Targeter that lazily scans Targets from the provided io.Reader on every invocation.
body will be set as the Target's body if no body is provided. hdr will be merged with the each Target's headers.
func NewStaticTargeter ¶
NewStaticTargeter returns a Targeter which round-robins over the passed Targets.
Source Files