health

Documentation

Index

• Constants
• Variables
• type Check
  • func (check Check) AllUp() bool
• type Health
• type HealthCheckEndpoint
  • func NewHealthCheckEndpoint(service HealthService, server customEcho.EchoHttpServer) *HealthCheckEndpoint
  • func (s *HealthCheckEndpoint) CheckHealth(c echo.Context) error
  • func (s *HealthCheckEndpoint) RegisterEndpoints()
• type HealthParams
• type HealthService
  • func NewHealthService(healthParams HealthParams) HealthService
• type Status
  • func NewStatus(err error) Status
  • func (status Status) IsUp() bool
• type UnhealthyHealthService
  • func NewUnhealthyHealthService() UnhealthyHealthService
  • func (service UnhealthyHealthService) CheckHealth(context.Context) Check

Constants

const (
	StatusUp   = "up"
	StatusDown = "down"
)

Variables

var Module = fx.Options(
	fx.Provide(
		NewHealthService,
		NewHealthCheckEndpoint,
	),
	fx.Invoke(func(endpoint *HealthCheckEndpoint) {
		endpoint.RegisterEndpoints()
	}),
)

Types

type Check

type Check map[string]Status

func (Check) AllUp

func (check Check) AllUp() bool

type Health

type Health interface {
	CheckHealth(ctx context.Context) error
	GetHealthName() string
}

type HealthCheckEndpoint

type HealthCheckEndpoint struct {
	// contains filtered or unexported fields
}

func NewHealthCheckEndpoint

func NewHealthCheckEndpoint(
	service HealthService,
	server customEcho.EchoHttpServer,
) *HealthCheckEndpoint

func (*HealthCheckEndpoint) CheckHealth

func (s *HealthCheckEndpoint) CheckHealth(c echo.Context) error

func (*HealthCheckEndpoint) RegisterEndpoints

func (s *HealthCheckEndpoint) RegisterEndpoints()

type HealthParams

type HealthParams struct {
	fx.In

	Healths []Health `group:"healths"`
}

type HealthService

type HealthService interface {
	CheckHealth(ctx context.Context) Check
}

func NewHealthService

func NewHealthService(
	healthParams HealthParams,
) HealthService

type Status

type Status struct {
	Status string `json:"status"`
}

func NewStatus

func NewStatus(err error) Status

func (Status) IsUp

func (status Status) IsUp() bool

type UnhealthyHealthService

type UnhealthyHealthService struct{}

func NewUnhealthyHealthService

func NewUnhealthyHealthService() UnhealthyHealthService

func (UnhealthyHealthService) CheckHealth

func (service UnhealthyHealthService) CheckHealth(context.Context) Check