web

Documentation

Index

• type AlertStatus
• type Handler
  • func New(st local.Storage, qe *promql.Engine, tm *retrieval.TargetManager, ...) *Handler
  • func (h *Handler) ApplyConfig(conf *config.Config) bool
  • func (h *Handler) ListenError() <-chan error
  • func (h *Handler) Quit() <-chan struct{}
  • func (h *Handler) Reload() <-chan struct{}
  • func (h *Handler) Run()
• type Options
• type PrometheusVersion

Types

type AlertStatus

type AlertStatus struct {
	AlertingRules        []*rules.AlertingRule
	AlertStateToRowClass map[rules.AlertState]string
}

AlertStatus bundles alerting rules and the mapping of alert states to row classes.

type Handler

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

Handler serves various HTTP endpoints of the Prometheus server

func New

func New(
	st local.Storage,
	qe *promql.Engine,
	tm *retrieval.TargetManager,
	rm *rules.Manager,
	version *PrometheusVersion,
	flags map[string]string,
	o *Options,
) *Handler

New initializes a new web Handler.

func (*Handler) ApplyConfig

func (h *Handler) ApplyConfig(conf *config.Config) bool

ApplyConfig updates the status state as the new config requires. Returns true on success.

func (*Handler) ListenError

func (h *Handler) ListenError() <-chan error

ListenError returns the receive-only channel that signals errors while starting the web server.

func (*Handler) Quit

func (h *Handler) Quit() <-chan struct{}

Quit returns the receive-only quit channel.

func (*Handler) Reload

func (h *Handler) Reload() <-chan struct{}

Reload returns the receive-only channel that signals configuration reload requests.

func (*Handler) Run

func (h *Handler) Run()

Run serves the HTTP endpoints.

type Options

type Options struct {
	ListenAddress        string
	ExternalURL          *url.URL
	RoutePrefix          string
	MetricsPath          string
	UseLocalAssets       bool
	UserAssetsPath       string
	ConsoleTemplatesPath string
	ConsoleLibrariesPath string
	EnableQuit           bool
}

Options for the web Handler.

type PrometheusVersion

type PrometheusVersion struct {
	Version   string `json:"version"`
	Revision  string `json:"revision"`
	Branch    string `json:"branch"`
	BuildUser string `json:"buildUser"`
	BuildDate string `json:"buildDate"`
	GoVersion string `json:"goVersion"`
}

PrometheusVersion contains build information about Prometheus.