health

Documentation

Index

• Variables
• func NewHealthObserver(healthServer *server.Server) *http.HealthObserver
• func NewLivenessObserver(healthServer *server.Server) *http.LivenessObserver
• func NewReadinessObserver(healthServer *server.Server) *http.ReadinessObserver
• func NewRegistrations(params Params) health.Registrations
• type Config
• type Params

Variables

var Module = fx.Options(
	fx.Provide(NewHealthObserver), fx.Provide(NewLivenessObserver), fx.Provide(NewReadinessObserver),
	fx.Provide(NewRegistrations), health.Module,
)

Module for fx.

Functions

func NewHealthObserver

func NewHealthObserver(healthServer *server.Server) *http.HealthObserver

NewHealthObserver for HTTP.

func NewLivenessObserver

func NewLivenessObserver(healthServer *server.Server) *http.LivenessObserver

NewLivenessObserver for HTTP.

func NewReadinessObserver

func NewReadinessObserver(healthServer *server.Server) *http.ReadinessObserver

NewReadinessObserver for HTTP.

func NewRegistrations

func NewRegistrations(params Params) health.Registrations

NewRegistrations for health.

Types

type Config

type Config struct {
	Duration string `yaml:"duration,omitempty" json:"duration,omitempty" toml:"duration,omitempty"`
	Timeout  string `yaml:"timeout,omitempty" json:"timeout,omitempty" toml:"timeout,omitempty"`
}

Config for health.

type Params

type Params struct {
	fx.In

	Health *Config
}

Params for health.