health

Documentation

Overview

Code generated by protoc-gen-micro source: health.proto

Code generated by protoc-gen-micro source: health.proto

Index

• func NewHandler(opts ...Option) *handler
• func NewHealthEndpoints() []*api.Endpoint
• func RegisterHealthServer(s server.Server, sh HealthServer, opts ...server.HandlerOption) error
• type CheckFunc
• 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

Functions

func NewHandler

func NewHandler(opts ...Option) *handler

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 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 {
	LiveChecks  []CheckFunc
	ReadyChecks []CheckFunc
	Version     string
	Name        string
}