web

Documentation

Index

• type AlertByStateCount
• type AlertStatus
• type Handler
  • func New(logger log.Logger, o *Options) *Handler
  • func (h *Handler) ApplyConfig(conf *config.Config) error
  • func (h *Handler) Quit() <-chan struct{}
  • func (h *Handler) Ready()
  • func (h *Handler) Reload() <-chan chan error
  • func (h *Handler) Run(ctx context.Context) error
• type Options
• type PrometheusVersion

Types

type AlertByStateCount

type AlertByStateCount struct {
	Inactive int32
	Pending  int32
	Firing   int32
}

type AlertStatus

type AlertStatus struct {
	Groups               []*rules.Group
	AlertStateToRowClass map[rules.AlertState]string
	Counts               AlertByStateCount
}

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(logger log.Logger, o *Options) *Handler

New initializes a new web Handler.

func (*Handler) ApplyConfig

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

ApplyConfig updates the config field of the Handler struct

func (*Handler) Quit

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

Quit returns the receive-only quit channel.

func (*Handler) Ready

func (h *Handler) Ready()

Ready sets Handler to be ready.

func (*Handler) Reload

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

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

func (*Handler) Run

func (h *Handler) Run(ctx context.Context) error

Run serves the HTTP endpoints.

type Options

type Options struct {
	Context     context.Context
	TSDB        func() *tsdb.DB
	TSDBCfg     prometheus_tsdb.Options
	Storage     storage.Storage
	QueryEngine *promql.Engine
	Version     *PrometheusVersion
	Flags       map[string]string

	ListenAddress              string
	CORSOrigin                 *regexp.Regexp
	ReadTimeout                time.Duration
	MaxConnections             int
	ExternalURL                *url.URL
	RoutePrefix                string
	UseLocalAssets             bool
	UserAssetsPath             string
	ConsoleTemplatesPath       string
	ConsoleLibrariesPath       string
	EnableLifecycle            bool
	EnableAdminAPI             bool
	PageTitle                  string
	RemoteReadSampleLimit      int
	RemoteReadConcurrencyLimit int
	RemoteReadBytesInFrame     int

	Gatherer   prometheus.Gatherer
	Registerer prometheus.Registerer
}

Options for the web Handler.

type PrometheusVersion

type PrometheusVersion = api_v1.PrometheusVersion

PrometheusVersion contains build information about Prometheus.