health

Documentation

Index

• type Component
• type Health
• type HealthHandler
  • func For(r *gin.Engine) *HealthHandler
  • func (h *HealthHandler) WithLiveness(sf StatusFunc) *HealthHandler
  • func (h *HealthHandler) WithReadiness(sf StatusFunc) *HealthHandler
• type Status
  • func (s Status) MarshalJSON() ([]byte, error)
  • func (s Status) String() string
• type StatusFunc

Types

type Component

type Component struct {
	Name   string
	Status Status
}

type Health

type Health struct {
	Status     Status      `json:"status"`
	Code       int         `json:"-"`
	Components []Component `json:"components,omitempty"`
}

type HealthHandler

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

func For

func For(r *gin.Engine) *HealthHandler

func (*HealthHandler) WithLiveness

func (h *HealthHandler) WithLiveness(sf StatusFunc) *HealthHandler

func (*HealthHandler) WithReadiness

func (h *HealthHandler) WithReadiness(sf StatusFunc) *HealthHandler

type Status

type Status int

const (
	UP Status = iota
	DOWN
)

func (Status) MarshalJSON

func (s Status) MarshalJSON() ([]byte, error)

func (Status) String

func (s Status) String() string

type StatusFunc

type StatusFunc func() Health