web

Documentation

Index

• type Handler
  • func New(logger log.Logger, o *Options) *Handler
  • func (h *Handler) ApplyConfig(conf *config.Config) error
  • func (h *Handler) Listener() (net.Listener, error)
  • func (h *Handler) Quit() <-chan struct{}
  • func (h *Handler) Reload() <-chan chan error
  • func (h *Handler) Run(ctx context.Context, listener net.Listener, webConfig string) error
  • func (h *Handler) SetReady(v bool)
• type LocalStorage
• type Options
• type PrometheusVersion

Types

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) Listener

func (h *Handler) Listener() (net.Listener, error)

Listener creates the TCP listener for web requests.

func (*Handler) Quit

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

Quit returns the receive-only quit channel.

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, listener net.Listener, webConfig string) error

Run serves the HTTP endpoints.

func (*Handler) SetReady

func (h *Handler) SetReady(v bool)

SetReady sets the ready status of our web Handler

type LocalStorage

type LocalStorage interface {
	storage.Storage
	api_v1.TSDBAdminStats
}

type Options

type Options struct {
	Context               context.Context
	TSDBRetentionDuration model.Duration
	TSDBDir               string
	TSDBMaxBytes          units.Base2Bytes
	LocalStorage          LocalStorage
	Storage               storage.Storage
	ExemplarStorage       storage.ExemplarQueryable
	QueryEngine           *promql.Engine
	LookbackDelta         time.Duration
	ScrapeManager         *scrape.Manager
	RuleManager           *rules.Manager
	Notifier              *notifier.Manager
	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
	EnableRemoteWriteReceiver  bool
	EnableOTLPWriteReceiver    bool
	IsAgent                    bool
	AppName                    string

	Gatherer   prometheus.Gatherer
	Registerer prometheus.Registerer
}

Options for the web Handler.

type PrometheusVersion

type PrometheusVersion = api_v1.PrometheusVersion

PrometheusVersion contains build information about Prometheus.