status

Documentation

Index

• Constants
• Variables
• func AddHandler(h Handler)
• type Code
• type Handler
  • func SimpleHandler(f func() error) Handler
  • func (f Handler) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type Status
  • func New(healthy bool, detail interface{}) (Status, error)

Constants

const Path = "/.well-known/status"

Variables

var (
	Healthy   = Status{Status: CodeHealthy}
	Unhealthy = Status{Status: CodeUnhealthy}

	HealthyHandler Handler = func() Status { return Healthy }
)

Functions

func AddHandler

func AddHandler(h Handler)

Types

type Code

type Code string

const (
	CodeHealthy   Code = "healthy"
	CodeUnhealthy Code = "unhealthy"
)

type Handler

type Handler func() Status

func SimpleHandler

func SimpleHandler(f func() error) Handler

func (Handler) ServeHTTP

func (f Handler) ServeHTTP(w http.ResponseWriter, req *http.Request)

type Status

type Status struct {
	Status  Code             `json:"status"`
	Detail  *json.RawMessage `json:"detail,omitempty"`
	Version string           `json:"version,omitempty"`
}

func New

func New(healthy bool, detail interface{}) (Status, error)