health

Documentation

Index

• type Checker
  • func NewChecker(cont *controller.Controller, period time.Duration, logger log.Logger, ...) *Checker
  • func (c *Checker) Alive() http.Handler
  • func (c *Checker) SetRunning()
• type Response
  • func (r *Response) MetricLogSummary(name string) (pairs []interface{})

Types

type Checker

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

func NewChecker

func NewChecker(cont *controller.Controller, period time.Duration, logger log.Logger, thresholdRatio float64) *Checker

NewChecker returns a new ready and liveness checkers based on state from the metrics controller.

func (*Checker) Alive

func (c *Checker) Alive() http.Handler

Alive returns a liveness handler.

func (*Checker) SetRunning

func (c *Checker) SetRunning()

SetRunning indicates when the process is ready.

type Response

type Response struct {
	Code      int                       `json:"code"`
	Status    string                    `json:"status"`
	Metrics   map[string][]exportRecord `json:"metrics"`
	Running   bool                      `json:"running"`
	Stackdump string                    `json:"stackdump"`
}

func (*Response) MetricLogSummary

func (r *Response) MetricLogSummary(name string) (pairs []interface{})

MetricLogSummary returns a slice of pairs for the log.Logger.Log() API based on the metric name.