health

Documentation

Index

• type API
• type Component
• type Healthcheck
• type HealthcheckStatus
• type Service
  • func NewService(db *sqlx.DB) *Service
  • func (s *Service) Healthcheck(ctx context.Context, fullCheck bool, log *logrus.Entry) *Healthcheck

Types

type API

type API interface {
	Healthcheck(ctx context.Context, fullCheck bool, log *logrus.Entry) *Healthcheck
}

type Component

type Component struct {
	Name     string            `json:"name"`
	Status   HealthcheckStatus `json:"status"`
	Critical bool              `json:"critical"`
}

type Healthcheck

type Healthcheck struct {
	Status     HealthcheckStatus `json:"status"`
	Code       int               `json:"code"`
	Timestamp  time.Time         `json:"timestamp"`
	Components []*Component      `json:"components,omitempty"`
}

type HealthcheckStatus

type HealthcheckStatus string

const (
	HealthcheckOK       HealthcheckStatus = "ok"
	HealthcheckDegraded HealthcheckStatus = "degraded"
	HealthcheckError    HealthcheckStatus = "failure"
)

type Service

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

func NewService

func NewService(db *sqlx.DB) *Service

func (*Service) Healthcheck

func (s *Service) Healthcheck(ctx context.Context, fullCheck bool, log *logrus.Entry) *Healthcheck