health

Documentation

Index

• type Options
• 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(opts Options) Server

Types

type Options

type Options struct {
	RouterOptions []RouterOptions
	Targets       *int
	Log           logger.Logger
}

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()
}

Server is the interface for the healthz server.

func NewServer

func NewServer(opts Options) Server

NewServer returns a new healthz server.