health

Documentation

Index

• Variables
• func NewHealthEndpoints() []api.Endpoint
• func RegisterHealthServer(s server.Server, sh HealthServer, opts ...server.HandlerOption) error
• type CheckFunc
• type Handler
  • func NewHandler(opts ...Option) *Handler
  • func (h *Handler) Live(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error
  • func (h *Handler) Ready(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error
  • func (h *Handler) Version(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error
• type HealthServer
• type Option
  • func LiveChecks(fns ...CheckFunc) Option
  • func Name(name string) Option
  • func ReadyChecks(fns ...CheckFunc) Option
  • func Version(version string) Option
• type Options

Variables

var (
	HealthName = "Health"

	HealthEndpoints = []api.Endpoint{
		{
			Name:    "Health.Live",
			Path:    []string{"/live"},
			Method:  []string{"GET"},
			Handler: "rpc",
		},
		{
			Name:    "Health.Ready",
			Path:    []string{"/ready"},
			Method:  []string{"GET"},
			Handler: "rpc",
		},
		{
			Name:    "Health.Version",
			Path:    []string{"/version"},
			Method:  []string{"GET"},
			Handler: "rpc",
		},
	}
)

Functions

func NewHealthEndpoints

func NewHealthEndpoints() []api.Endpoint

func RegisterHealthServer

func RegisterHealthServer(s server.Server, sh HealthServer, opts ...server.HandlerOption) error

Types

type CheckFunc

type CheckFunc func(context.Context) error

type Handler

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

func NewHandler

func NewHandler(opts ...Option) *Handler

func (*Handler) Live

func (h *Handler) Live(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error

func (*Handler) Ready

func (h *Handler) Ready(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error

func (*Handler) Version

func (h *Handler) Version(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error

type HealthServer

type HealthServer interface {
	Live(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error
	Ready(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error
	Version(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error
}

type Option

type Option func(*Options)

func LiveChecks

func LiveChecks(fns ...CheckFunc) Option

func Name

func Name(name string) Option

func ReadyChecks

func ReadyChecks(fns ...CheckFunc) Option

func Version

func Version(version string) Option

type Options

type Options struct {
	Version     string
	Name        string
	LiveChecks  []CheckFunc
	ReadyChecks []CheckFunc
}