health

Documentation

Index

• type Condition
• type Controller
  • func NewController(logger *logrus.Logger, interval time.Duration, conditions ...Condition) *Controller
  • func (c *Controller) IsOutOfDiskSpace() bool
  • func (c *Controller) NotificationText() string
  • func (c *Controller) Start()
  • func (c *Controller) Stop()
  • func (c *Controller) Unhealthy() []StatusMessage
• type DiskPressure
  • func (d DiskPressure) Probe() (StatusMessage, error)
• type Status
  • func (s Status) String() string
• type StatusMessage

Types

type Condition

type Condition interface {
	Probe() (StatusMessage, error)
}

Condition represents an aspect of pyroscope server health.

type Controller

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

Controller performs probes of health conditions.

func NewController

func NewController(logger *logrus.Logger, interval time.Duration, conditions ...Condition) *Controller

func (*Controller) IsOutOfDiskSpace

func (c *Controller) IsOutOfDiskSpace() bool

func (*Controller) NotificationText

func (c *Controller) NotificationText() string

NotificationText satisfies server.Notifier.

TODO(kolesnikovae): I think we need to make UI notifications

structured (explicit status field) and support multiple messages.
At the moment there can be only one notification.

func (*Controller) Start

func (c *Controller) Start()

func (*Controller) Stop

func (c *Controller) Stop()

func (*Controller) Unhealthy

func (c *Controller) Unhealthy() []StatusMessage

type DiskPressure

type DiskPressure struct {
	Threshold bytesize.ByteSize
	Path      string
}

func (DiskPressure) Probe

func (d DiskPressure) Probe() (StatusMessage, error)

type Status

type Status int

const (
	NoData Status = iota
	Healthy
	Warning
	Critical
)

func (Status) String

func (s Status) String() string

type StatusMessage

type StatusMessage struct {
	Status
	// The message is displayed to users.
	Message string
}