health

package

v0.37.2 Latest Latest Go to latest Published: Feb 15, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

Condition represents an aspect of pyroscope server health.

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

Controller performs probes of health conditions.

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

func (c *Controller) IsOutOfDiskSpace() bool

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 (c *Controller) Start()

func (c *Controller) Stop()

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

type DiskPressure struct {
	Threshold float64
	Path      string
}

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

type Status int

const (
	NoData Status = iota
	Healthy
	Warning
	Critical
)

func (s Status) String() string

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