metrics

Documentation

Index

• func ControllerLive() healthz.HealthzChecker
• func HTTPBackendAvailable(u *url.URL) healthz.HealthzChecker
• func HasSynced(routerPtr **templateplugin.TemplatePlugin) (healthz.HealthzChecker, error)
• func ProxyProtocolHTTPBackendAvailable(u *url.URL) healthz.HealthzChecker
• type Listener
  • func (l Listener) Listen()

Functions

func ControllerLive

func ControllerLive() healthz.HealthzChecker

func HTTPBackendAvailable

func HTTPBackendAvailable(u *url.URL) healthz.HealthzChecker

HTTPBackendAvailable returns a healthz check that verifies a backend responds to a GET to the provided URL with 2xx or 3xx response.

func HasSynced

func HasSynced(routerPtr **templateplugin.TemplatePlugin) (healthz.HealthzChecker, error)

HasSynced returns a healthz check that verifies the router has been synced at least once. routerPtr is a pointer because it may not yet be defined (there's a chicken-and-egg problem

with when the health checker and router object are set up).

func ProxyProtocolHTTPBackendAvailable

func ProxyProtocolHTTPBackendAvailable(u *url.URL) healthz.HealthzChecker

ProxyProtocolHTTPBackendAvailable returns a healthz check that verifies a backend supporting the HAProxy PROXY protocol responds to a GET to the provided URL with 2xx or 3xx response.

Types

type Listener

type Listener struct {
	Addr string

	TLSConfig *tls.Config

	Username string
	Password string

	Authenticator authenticator.Request
	Authorizer    authorizer.Authorizer
	Record        authorizer.AttributesRecord

	LiveChecks  []healthz.HealthzChecker
	ReadyChecks []healthz.HealthzChecker
}

func (Listener) Listen

func (l Listener) Listen()

Listen starts a server for health, metrics, and profiling on the provided listen port. It will terminate the process if the server fails. Metrics and profiling are only exposed if username and password are provided and the user's input matches.