health_handler

Documentation

Index

• Variables
• func RegisterHealthServiceServer(s server.Server, sh HealthServiceServer, opts ...server.HandlerOption) error
• type CheckFunc
• type Handler
  • func NewHandler(opts ...Option) *Handler
  • func (h *Handler) Healthy(ctx context.Context, req *codecpb.Frame, rsp *codecpb.Frame) error
  • func (h *Handler) Live(ctx context.Context, req *codecpb.Frame, rsp *codecpb.Frame) error
  • func (h *Handler) Ready(ctx context.Context, req *codecpb.Frame, rsp *codecpb.Frame) error
  • func (h *Handler) Version(ctx context.Context, req *codecpb.Frame, rsp *codecpb.Frame) error
• type HealthServiceClient
  • func NewHealthServiceClient(name string, c client.Client) HealthServiceClient
• type HealthServiceServer
• type Option
  • func HealthChecks(fns ...CheckFunc) Option
  • func LiveChecks(fns ...CheckFunc) Option
  • func Name(name string) Option
  • func ReadyChecks(fns ...CheckFunc) Option
  • func Service(s ...Stater) Option
  • func Version(version string) Option
• type Options
• type Stater

Variables

var (
	HealthServiceName = "HealthService"
)

var (
	HealthServiceServerEndpoints = []v3.EndpointMetadata{
		{
			Name:   "HealthService.Healthy",
			Path:   "/health",
			Method: "GET",
			Body:   "",
			Stream: false,
		},
		{
			Name:   "HealthService.Healthy",
			Path:   "/healthz",
			Method: "GET",
			Body:   "",
			Stream: false,
		},
		{
			Name:   "HealthService.Live",
			Path:   "/live",
			Method: "GET",
			Body:   "",
			Stream: false,
		},
		{
			Name:   "HealthService.Live",
			Path:   "/livez",
			Method: "GET",
			Body:   "",
			Stream: false,
		},
		{
			Name:   "HealthService.Ready",
			Path:   "/ready",
			Method: "GET",
			Body:   "",
			Stream: false,
		},
		{
			Name:   "HealthService.Ready",
			Path:   "/readyz",
			Method: "GET",
			Body:   "",
			Stream: false,
		},
		{
			Name:   "HealthService.Version",
			Path:   "/version",
			Method: "GET",
			Body:   "",
			Stream: false,
		},
	}
)

Functions

func RegisterHealthServiceServer

func RegisterHealthServiceServer(s server.Server, sh HealthServiceServer, 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) Healthy

func (h *Handler) Healthy(ctx context.Context, req *codecpb.Frame, rsp *codecpb.Frame) error

func (*Handler) Live

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

func (*Handler) Ready

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

func (*Handler) Version

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

type HealthServiceClient

type HealthServiceClient interface {
	Healthy(ctx context.Context, req *codec.Frame, opts ...client.CallOption) (*codec.Frame, error)
	Live(ctx context.Context, req *codec.Frame, opts ...client.CallOption) (*codec.Frame, error)
	Ready(ctx context.Context, req *codec.Frame, opts ...client.CallOption) (*codec.Frame, error)
	Version(ctx context.Context, req *codec.Frame, opts ...client.CallOption) (*codec.Frame, error)
}

func NewHealthServiceClient

func NewHealthServiceClient(name string, c client.Client) HealthServiceClient

type HealthServiceServer

type HealthServiceServer interface {
	Healthy(ctx context.Context, req *codec.Frame, rsp *codec.Frame) error
	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 HealthChecks

func HealthChecks(fns ...CheckFunc) Option

func LiveChecks

func LiveChecks(fns ...CheckFunc) Option

func Name

func Name(name string) Option

func ReadyChecks

func ReadyChecks(fns ...CheckFunc) Option

func Service

func Service(s ...Stater) Option

func Version

func Version(version string) Option

type Options

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

type Stater

type Stater interface {
	Live() bool
	Ready() bool
	Health() bool
}