health

Documentation

Overview

Package health contains an HTTP server that renders a basic HTML UI displaying the results of health checks of kubernetes pods that have special annotations.

Index

• type HTTP
  • func NewHTTP(scraper Scraper) *HTTP
  • func (t *HTTP) Get(w http.ResponseWriter, r *http.Request)
  • func (t *HTTP) Register(r *mux.Router)
• type Scraper

Types

type HTTP

type HTTP struct {
	transport.HTTP
	// contains filtered or unexported fields
}

The HTTP type is responsible for handling inbound HTTP requests to display the health check user-interface.

func NewHTTP

func NewHTTP(scraper Scraper) *HTTP

NewHTTP returns a new instance of the HTTP type that will scrape pod health using the provided Scraper implementation.

func (*HTTP) Get

func (t *HTTP) Get(w http.ResponseWriter, r *http.Request)

Get handles an inbound HTTP GET request that performs a health scrape and renders the health check UI.

func (*HTTP) Register

func (t *HTTP) Register(r *mux.Router)

Register HTTP handlers on the provided mux.Router.

type Scraper

type Scraper interface {
	Scrape(ctx context.Context) ([]*scrape.PodHealth, error)
}

The Scraper interface describes types that scrape kubernetes pods for their current health.