xhealth

package

v0.0.0-...-73d6a9a Latest Latest Go to latest Published: Jul 31, 2018 License: MIT Imports: 8 Imported by: 1

Details

This section is empty.

This section is empty.

func Module() fx.Option

func ProvideRouteMapping(c HealthHandler, cfg Config) xhttp.RouteMapping

ProvideRouteMapping provide and Server HTTP Route to be registered by the server module.

func RegisterHealthChecks(h HealthHandler, checks ChecksMappings, logger xlog.OptionalLogger)

RegisterHealthChecks register the checks populated in ChecksMappings.

type CheckMapping struct {
	fx.Out

	Checker *Checker `group:"x_health"`
}

CheckMapping wrap the return of a health check.

func NewCheckMapping(name string, checker health.Checker) CheckMapping

type Checker struct {
	Name    string
	Checker health.Checker
}

Checker holds the name and a Checker function to be executed.

type ChecksMappings struct {
	fx.In

	Checks []*Checker `group:"x_health"`
}

ChecksMappings hold all checks registered by the container.

type Config struct {
	Path string
}

Config holds health check configuration.

func LoadConfig(params LoadConfigParams) (Config, error)

type HealthHandler struct {
	fx.In

	Handler *health.Handler `name:"x_healthcheck"`
}

HealthHandler ir necessary to access the healthcheck by name

type HealthHandlerQualifier struct {
	fx.Out

	Handler *health.Handler `name:"x_healthcheck"`
}

HealthHandlerQualifier is necessary to give a name to the health check

func NewHealth() HealthHandlerQualifier

NewHealth create a new healthChecker and register the available checks.

type LoadConfigParams struct {
	fx.In

	Provider config.Provider `optional:"true"`
}