healthcheck

Documentation

Index

• Constants
• func Checker(checker HealthChecker) nirvana.Configurer
• func Disable() nirvana.Configurer
• func Path(path string) nirvana.Configurer
• type HealthChecker
• type Option
  • func NewOption(checker HealthChecker) *Option
  • func (p *Option) Configure(cfg *nirvana.Config) error
  • func (p *Option) Name() string

Constants

const ExternalConfigName = "healthcheck"

ExternalConfigName is the external config name of health check.

Functions

func Checker

func Checker(checker HealthChecker) nirvana.Configurer

Checker returns a configurer to set health checker.

func Disable

func Disable() nirvana.Configurer

Disable returns a configurer to disable healthcheck.

func Path

func Path(path string) nirvana.Configurer

Path returns a configurer to set health check path.

Types

type HealthChecker

type HealthChecker func(ctx context.Context) error

HealthChecker checks if current server is healthy.

type Option

type Option struct {
	Path string `desc:"Health check path"`
	// contains filtered or unexported fields
}

Option contains basic configurations of healthcheck.

func NewOption

func NewOption(checker HealthChecker) *Option

NewOption creates default option.

func (*Option) Configure

func (p *Option) Configure(cfg *nirvana.Config) error

Configure configures nirvana config via current options.

func (*Option) Name

func (p *Option) Name() string

Name returns plugin name.