types

Documentation

Index

• type Probe
• type Probes
  • func LoadFromJSONFile(filename string) (Probes, error)
• type ResponseTester

Types

type Probe

type Probe struct {
	// URL is the HTTP URL to probe.
	URLs []string `json:"urls"`

	// Method is the HTTP method to use when probing.
	Method string `json:"method"`

	// Expected is the list of expected HTTP status code, i.e. [200, 201]
	Expected []int `json:"expected"`

	// Body is the body of the request to send if the method is POST.
	Body string `json:"body,omitempty"`

	// The mimetype of the Body.
	MimeType string `json:"mimetype"`

	// The body testing function we should use.
	ResponseTestName string `json:"responsetest,omitempty"`

	// If true, attach an OAuth 2.0 Bearer Token to the request.
	Authenticated bool `json:"authenticated,omitempty"`

	ResponseTest ResponseTester `json:"-"`

	//      map[url]metric.
	Failure map[string]metrics2.Int64Metric `json:"-"`
	Latency map[string]metrics2.Int64Metric `json:"-"` // Latency in ms.

	// Note is some comment about this prober.
	Note string `json:"note,omitempty"`
}

Probe is a single endpoint we are probing.

type Probes

type Probes map[string]*Probe

Probes is all the probes that are to be run.

func LoadFromJSONFile

func LoadFromJSONFile(filename string) (Probes, error)

LoadFromJSONFile loads the configuration of the probers from the given JSON file.

type ResponseTester

type ResponseTester func(io.Reader, http.Header) bool

ResponseTester tests the response from a probe and returns true if it passes all tests.