healthx

Documentation

Index

• Constants
• Variables
• type Handler
  • func NewHandler(in struct{ ... }) *Handler
  • func (h *Handler) Status(rw http.ResponseWriter, r *http.Request)
• type Report
• type Resource
  • func (r *Resource) Report(ctx context.Context) Report

Constants

const (
	UP   = "UP"
	DOWN = "DOWN"
)

Variables

var Module = fx.Provide(NewHandler)

Types

type Handler

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

func NewHandler

func NewHandler(in struct {
	fx.In
	Resources []*Resource `group:"health_resource"`
}) *Handler

NewHandler is the constructor for handler.

func (*Handler) Status

func (h *Handler) Status(rw http.ResponseWriter, r *http.Request)

type Report

type Report struct {
	Name   string `json:"name"`
	Status string `json:"status"`
	Error  string `json:"error,omitempty"`
}

type Resource

type Resource struct {
	Name    string
	Checker func(ctx context.Context) error
}

func (*Resource) Report

func (r *Resource) Report(ctx context.Context) Report