healthcheck

package

v0.3.1 Latest Latest Go to latest Published: Jan 21, 2021 License: Apache-2.0 Imports: 4 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/caicloud/nirvana

Links

Open Source Insights

Documentation ¶

Index ¶

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

Constants ¶

View Source

const (
	// LivenessCheck represents liveness check.
	LivenessCheck = "liveness"
	// ReadinessCheck represents readiness check.
	ReadinessCheck = "readiness"
)

View Source

const ExternalConfigName = "healthcheck"

ExternalConfigName is the external config name of health check.

Variables ¶

This section is empty.

Functions ¶

func Checker ¶

func Checker(checker HealthChecker) nirvana.Configurer

Checker returns a configurer to set health checker.

func CheckerWithType ¶ added in v0.2.2

func CheckerWithType(checker HealthCheckerWithType) nirvana.Configurer

CheckerWithType returns a configurer to set health checker with a type parameter.

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 HealthCheckerWithType ¶ added in v0.2.2

type HealthCheckerWithType func(ctx context.Context, checkType string) error

HealthCheckerWithType checks if current server is healthy. The `checkType` parameter indicates the type of health check, such as liveness or readiness.

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.

Source Files ¶

View all Source files

healthz.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL