Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

health

package module

Go to main page

Versions in this module

v1

v1.3.0

Aug 12, 2026

v1.2.0

Mar 6, 2026

v1.1.0

Feb 4, 2026

Changes in this version

type Config

+ TrustedProxies []string

+ func (c *Config) IsTrustedProxy(ipStr string) bool

+ func (c Config) WithTrustedProxies(ips []string) Config

v1.0.0

Jan 25, 2026

Changes in this version

+ func FiberHandler(aggregator *Aggregator) fiber.Handler

+ func FiberLivenessHandler(serviceName string) fiber.Handler

+ func FiberReadinessHandler(aggregator *Aggregator) fiber.Handler

+ func HTTPStatusCode(status Status) int

+ func Handler(aggregator *Aggregator) http.HandlerFunc

+ func LivenessHandler(serviceName string) http.HandlerFunc

+ func ReadinessHandler(aggregator *Aggregator) http.HandlerFunc

+ func SimpleFiberHandler(serviceName string) fiber.Handler

+ func SimpleHandler(serviceName string) http.HandlerFunc

+ type AggregatedResult struct

+ Checks map[string]CheckResult

+ Service string

+ Status Status

+ Timestamp time.Time

+ TotalLatency time.Duration

+ func (r AggregatedResult) IsDegraded() bool

+ func (r AggregatedResult) IsHealthy() bool

+ func (r AggregatedResult) MarshalJSON() ([]byte, error)

+ type Aggregator struct

+ func NewAggregator(config Config) *Aggregator

+ func (a *Aggregator) AddChecker(checker Checker) *Aggregator

+ func (a *Aggregator) AddCheckers(checkers ...Checker) *Aggregator

+ func (a *Aggregator) Check(ctx context.Context) AggregatedResult

+ func (a *Aggregator) CheckSequential(ctx context.Context) AggregatedResult

+ func (a *Aggregator) Config() Config

+ func (a *Aggregator) GetCheckerNames() []string

+ func (a *Aggregator) RemoveChecker(name string) *Aggregator

+ func (a *Aggregator) SetConfig(config Config)

+ type CheckResult struct

+ Error string

+ Latency time.Duration

+ Message string

+ Metadata map[string]any

+ Name string

+ Status Status

+ Timestamp time.Time

+ func (r CheckResult) MarshalJSON() ([]byte, error)

+ type Checker interface

+ Check func(ctx context.Context) CheckResult

+ Name func() string

+ type CheckerFunc struct

+ func NewCheckerFunc(name string, fn func(ctx context.Context) CheckResult) *CheckerFunc

+ func (c *CheckerFunc) Check(ctx context.Context) CheckResult

+ func (c *CheckerFunc) Name() string

+ type Config struct

+ CriticalChecks []string

+ IPWhitelist []string

+ IncludeChecks bool

+ IncludeDetails bool

+ ServiceName string

+ Timeout time.Duration

+ func DefaultConfig() Config

+ func (c *Config) IsCritical(name string) bool

+ func (c *Config) IsIPAllowed(ipStr string) bool

+ func (c Config) WithChecks(include bool) Config

+ func (c Config) WithCriticalChecks(checks []string) Config

+ func (c Config) WithDetails(include bool) Config

+ func (c Config) WithIPWhitelist(ips []string) Config

+ func (c Config) WithServiceName(name string) Config

+ func (c Config) WithTimeout(timeout time.Duration) Config

+ type CustomChecker struct

+ func NewCustomChecker(name string, checkFn func(ctx context.Context) error) *CustomChecker

+ func (c *CustomChecker) Check(ctx context.Context) CheckResult

+ func (c *CustomChecker) Name() string

+ func (c *CustomChecker) WithMetadata(metadata map[string]any) *CustomChecker

+ func (c *CustomChecker) WithTimeout(timeout time.Duration) *CustomChecker

+ type DBChecker struct

+ func NewDBChecker(db *sql.DB) *DBChecker

+ func NewDBCheckerWithName(name string, db *sql.DB) *DBChecker

+ func (c *DBChecker) Check(ctx context.Context) CheckResult

+ func (c *DBChecker) Name() string

+ func (c *DBChecker) WithTimeout(timeout time.Duration) *DBChecker

+ type DisabledChecker struct

+ func NewDisabledChecker(name string) *DisabledChecker

+ func (c *DisabledChecker) Check(_ context.Context) CheckResult

+ func (c *DisabledChecker) Name() string

+ func (c *DisabledChecker) WithMessage(message string) *DisabledChecker

+ type HTTPChecker struct

+ func NewHTTPChecker(name, url string) *HTTPChecker

+ func (c *HTTPChecker) Check(ctx context.Context) CheckResult

+ func (c *HTTPChecker) Name() string

+ func (c *HTTPChecker) WithClient(client *http.Client) *HTTPChecker

+ func (c *HTTPChecker) WithExpectedCode(code int) *HTTPChecker

+ func (c *HTTPChecker) WithMethod(method string) *HTTPChecker

+ func (c *HTTPChecker) WithTimeout(timeout time.Duration) *HTTPChecker

+ type RedisChecker struct

+ func NewRedisChecker(client *redis.Client) *RedisChecker

+ func NewRedisCheckerWithName(name string, client *redis.Client) *RedisChecker

+ func (c *RedisChecker) Check(ctx context.Context) CheckResult

+ func (c *RedisChecker) Name() string

+ func (c *RedisChecker) WithTimeout(timeout time.Duration) *RedisChecker

+ type Status string

+ const StatusDegraded

+ const StatusDisabled

+ const StatusHealthy

+ const StatusUnhealthy

+ const StatusUnknown

+ func (s Status) IsHealthy() bool

+ func (s Status) String() string

Other modules containing this package

github.com/soulteary/health-kit/v2