api

Documentation

Index

• Constants
• func NewPromHTTPClient(addr, path string, tlsConfig *tls.Config) (prom_api_client.API, error)
• func NewPromReadClient(index int, addr string, timeout time.Duration, tlsConfig *config.TLSConfig) (remote.ReadClient, error)
• type DiscoveryAgent
• type PromAPI
  • func NewPromAPI(promQLEngine *promql.Engine, log *logger.Logger) *PromAPI
  • func (api *PromAPI) RouterForStorage(storage storage.Storage, ruleManager rules.RuleManager, ...) *route.Router
• type ReloadAPI
  • func NewReloadAPI(reloadConfig func(), log *logger.Logger) *ReloadAPI
  • func (api *ReloadAPI) Register(r *route.Router)
  • func (api *ReloadAPI) Router() *route.Router
• type Rule
• type RulesAPI
  • func NewRulesAPI(ruleManager rules.RuleManager, log *logger.Logger) *RulesAPI
  • func (api *RulesAPI) Register(r *route.Router)
  • func (api *RulesAPI) Router() *route.Router
• type ScrapeManager

Constants

const (
	REMOTE_READ_SAMPLE_LIMIT       = 20000000
	REMOTE_READ_CONCURRENCY_LIMIT  = 50
	REMOTE_READ_MAX_BYTES_IN_FRAME = 1048576 // 1MB recommended by protobuf
)

Functions

func NewPromHTTPClient

func NewPromHTTPClient(addr, path string, tlsConfig *tls.Config) (prom_api_client.API, error)

func NewPromReadClient

func NewPromReadClient(index int, addr string, timeout time.Duration,
	tlsConfig *config.TLSConfig) (remote.ReadClient, error)

Types

type DiscoveryAgent

type DiscoveryAgent interface {
	ApplyScrapeConfig(configs []*config.ScrapeConfig)
}

type PromAPI

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

func NewPromAPI

func NewPromAPI(promQLEngine *promql.Engine, log *logger.Logger) *PromAPI

func (*PromAPI) RouterForStorage

func (api *PromAPI) RouterForStorage(storage storage.Storage, ruleManager rules.RuleManager, gatherer prometheus.Gatherer, registerer prometheus.Registerer) *route.Router

type ReloadAPI

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

func NewReloadAPI

func NewReloadAPI(reloadConfig func(), log *logger.Logger) *ReloadAPI

func (*ReloadAPI) Register

func (api *ReloadAPI) Register(r *route.Router)

func (*ReloadAPI) Router

func (api *ReloadAPI) Router() *route.Router

type Rule

type Rule struct {
	Record      string            `yaml:"record,omitempty"`
	Alert       string            `yaml:"alert,omitempty"`
	Expr        string            `yaml:"expr"`
	For         string            `yaml:"for,omitempty"`
	Labels      map[string]string `yaml:"labels,omitempty"`
	Annotations map[string]string `yaml:"annotations,omitempty"`
}

type RulesAPI

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

func NewRulesAPI

func NewRulesAPI(ruleManager rules.RuleManager, log *logger.Logger) *RulesAPI

func (*RulesAPI) Register

func (api *RulesAPI) Register(r *route.Router)

func (*RulesAPI) Router

func (api *RulesAPI) Router() *route.Router

type ScrapeManager

type ScrapeManager interface {
	ApplyConfig(cfg *config.Config) error
}