health

package

v0.230.0 Latest Latest Go to latest Published: Mar 6, 2025 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/alexfalkowski/web

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

Constants ¶

This section is empty.

Variables ¶

View Source

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.

Source Files ¶

View all Source files

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