healthcheck

Documentation

Overview

Package healthcheck tests and communicates the health of the AlloyDB Auth proxy.

Index

• type Check
  • func NewCheck(p *proxy.Client, l alloydb.Logger) *Check
  • func (c *Check) HandleLiveness(w http.ResponseWriter, _ *http.Request)
  • func (c *Check) HandleReadiness(w http.ResponseWriter, _ *http.Request)
  • func (c *Check) HandleStartup(w http.ResponseWriter, _ *http.Request)
  • func (c *Check) NotifyStarted()
  • func (c *Check) NotifyStopped()

Types

type Check

type Check struct {
	// contains filtered or unexported fields
}

Check provides HTTP handlers for use as healthchecks typically in a Kubernetes context.

func NewCheck

func NewCheck(p *proxy.Client, l alloydb.Logger) *Check

NewCheck is the initializer for Check.

func (*Check) HandleLiveness

func (c *Check) HandleLiveness(w http.ResponseWriter, _ *http.Request)

HandleLiveness indicates the process is up and responding to HTTP requests. If this check fails (because it's not reachable), the process is in a bad state and should be restarted.

func (*Check) HandleReadiness

func (c *Check) HandleReadiness(w http.ResponseWriter, _ *http.Request)

HandleReadiness ensures the Check has been notified of successful startup, that the proxy has not reached maximum connections, and that the Proxy has not started shutting down.

func (*Check) HandleStartup

func (c *Check) HandleStartup(w http.ResponseWriter, _ *http.Request)

HandleStartup reports whether the Check has been notified of startup.

func (*Check) NotifyStarted

func (c *Check) NotifyStarted()

NotifyStarted notifies the check that the proxy has started up successfully.

func (*Check) NotifyStopped

func (c *Check) NotifyStopped()

NotifyStopped notifies the check that the proxy has initiated its shutdown sequence.