health

Documentation

Index

• func StartEndpointHealthCheck(ctx context.Context, endpointAddress string, opts ...Option) <-chan bool
• type Option
  • func WithClock(clock kclock.WithTicker) Option
  • func WithFailureThreshold(threshold int32) Option
  • func WithHTTPClient(client *http.Client) Option
  • func WithInitialDelay(delay time.Duration) Option
  • func WithInterval(interval time.Duration) Option
  • func WithRequestTimeout(timeout time.Duration) Option
  • func WithSuccessStatusCode(code int) Option
• type RouterOptions
  • func NewJSONDataRouterOptions[T any](path string, getter func() (T, error)) RouterOptions
  • func NewRouterOptions(path string, handler http.Handler) RouterOptions
• type Server
  • func NewServer(log logger.Logger, options ...RouterOptions) Server

Functions

func StartEndpointHealthCheck

func StartEndpointHealthCheck(ctx context.Context, endpointAddress string, opts ...Option) <-chan bool

StartEndpointHealthCheck starts a health check on the specified address with the given options. It returns a channel that will emit true if the endpoint is healthy and false if the failure conditions Have been met.

Types

type Option

type Option func(o *healthCheckOptions)

Option is a function that applies a health check option.

func WithClock

func WithClock(clock kclock.WithTicker) Option

WithClock sets a custom clock (for mocking time).

func WithFailureThreshold

func WithFailureThreshold(threshold int32) Option

WithFailureThreshold sets the failure threshold for the health check.

func WithHTTPClient

func WithHTTPClient(client *http.Client) Option

WithHTTPClient sets the http.Client to use.

func WithInitialDelay

func WithInitialDelay(delay time.Duration) Option

WithInitialDelay sets the initial delay for the health check.

func WithInterval

func WithInterval(interval time.Duration) Option

WithInterval sets the interval for the health check.

func WithRequestTimeout

func WithRequestTimeout(timeout time.Duration) Option

WithRequestTimeout sets the request timeout for the health check.

func WithSuccessStatusCode

func WithSuccessStatusCode(code int) Option

WithSuccessStatusCode sets the status code for the health check.

type RouterOptions

type RouterOptions func(log logger.Logger) (string, http.Handler)

func NewJSONDataRouterOptions

func NewJSONDataRouterOptions[T any](path string, getter func() (T, error)) RouterOptions

func NewRouterOptions

func NewRouterOptions(path string, handler http.Handler) RouterOptions

type Server

type Server interface {
	Run(context.Context, int) error
	Ready()
	NotReady()
}

Server is the interface for the healthz server.

func NewServer

func NewServer(log logger.Logger, options ...RouterOptions) Server

NewServer returns a new healthz server.