http

Documentation

Index

• func DoHTTPProbe(url *url.URL, headers http.Header, client GetHTTPInterface) (probe.Result, string, error)
• type GetHTTPInterface
• type Prober
  • func New(followNonLocalRedirects bool) Prober
  • func NewWithTLSConfig(config *tls.Config, followNonLocalRedirects bool) Prober

Functions

func DoHTTPProbe

func DoHTTPProbe(url *url.URL, headers http.Header, client GetHTTPInterface) (probe.Result, string, error)

DoHTTPProbe checks if a GET request to the url succeeds. If the HTTP response code is successful (i.e. 400 > code >= 200), it returns Success. If the HTTP response code is unsuccessful or HTTP communication fails, it returns Failure. This is exported because some other packages may want to do direct HTTP probes.

Types

type GetHTTPInterface

type GetHTTPInterface interface {
	Do(req *http.Request) (*http.Response, error)
}

GetHTTPInterface is an interface for making HTTP requests, that returns a response and error.

type Prober

type Prober interface {
	Probe(url *url.URL, headers http.Header, timeout time.Duration) (probe.Result, string, error)
}

Prober is an interface that defines the Probe function for doing HTTP readiness/liveness checks.

func New

func New(followNonLocalRedirects bool) Prober

New creates Prober that will skip TLS verification while probing. followNonLocalRedirects configures whether the prober should follow redirects to a different hostname.

If disabled, redirects to other hosts will trigger a warning result.

func NewWithTLSConfig

func NewWithTLSConfig(config *tls.Config, followNonLocalRedirects bool) Prober

NewWithTLSConfig takes tls config as parameter. followNonLocalRedirects configures whether the prober should follow redirects to a different hostname.

If disabled, redirects to other hosts will trigger a warning result.