health

package

v0.0.0-...-bb60f61 Latest Latest Go to latest Published: Apr 28, 2022 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/davidsbond/homelab

Links

Open Source Insights

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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.

Source Files ¶

View all Source files

index.go

Directories ¶

Path	Synopsis
assets
scrape Package scrape contains logic for scraping the health check endpoints of kubernetes pods that have specified the required annotations.	Package scrape contains logic for scraping the health check endpoints of kubernetes pods that have specified the required annotations.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL