healthz

Documentation

Overview

Package healthz provides a simple and extensible health check mechanism for HTTP services. It allows the registration of multiple health check functions and exposes an HTTP endpoint to report the health status of the service. This can be useful for monitoring and ensuring the reliability of the service in production environments.

Index

• func Register(name string, fn HealthCheck)
• type HealthCheck
• type HealthChecker
  • func NewHealthz() HealthChecker

Functions

func Register

func Register(name string, fn HealthCheck)

Register a health check function can be used to add specific health checks

Types

type HealthCheck

type HealthCheck func() error

type HealthChecker

type HealthChecker interface {
	// EndpointHandler returns an http.HandlerFunc that checks the health of the
	// service.
	EndpointHandler() http.HandlerFunc
}

func NewHealthz

func NewHealthz() HealthChecker