promapi

Documentation

Index

• func IsUnavailableError(err error) bool
• func RegisterMetrics()
• type APIError
• type ConfigResult
• type ConfigSectionGlobal
• type FailoverGroup
  • func NewFailoverGroup(name string, servers []*Prometheus, strictErrors bool) *FailoverGroup
  • func (fg *FailoverGroup) ClearCache()
  • func (fg *FailoverGroup) Close()
  • func (fg *FailoverGroup) Config(ctx context.Context) (cfg *ConfigResult, err error)
  • func (fg *FailoverGroup) Metadata(ctx context.Context, metric string) (metadata *MetadataResult, err error)
  • func (fg *FailoverGroup) Name() string
  • func (fg *FailoverGroup) Query(ctx context.Context, expr string) (qr *QueryResult, err error)
  • func (fg *FailoverGroup) RangeQuery(ctx context.Context, expr string, start, end time.Time, step time.Duration) (rqr *RangeQueryResult, err error)
  • func (fg *FailoverGroup) StartWorkers()
• type FailoverGroupError
  • func (e *FailoverGroupError) Error() string
  • func (e *FailoverGroupError) IsStrict() bool
  • func (e *FailoverGroupError) URI() string
  • func (e *FailoverGroupError) Unwrap() error
• type MetadataResult
• type Prometheus
  • func NewPrometheus(name, uri string, timeout time.Duration, concurrency int) *Prometheus
  • func (prom *Prometheus) Close()
  • func (p *Prometheus) Config(ctx context.Context) (*ConfigResult, error)
  • func (p *Prometheus) Metadata(ctx context.Context, metric string) (*MetadataResult, error)
  • func (p *Prometheus) Query(ctx context.Context, expr string) (*QueryResult, error)
  • func (p *Prometheus) RangeQuery(ctx context.Context, expr string, start, end time.Time, step time.Duration) (*RangeQueryResult, error)
  • func (prom *Prometheus) StartWorkers()
• type PrometheusConfig
• type QueryError
  • func (qe QueryError) Error() string
  • func (qe QueryError) Unwrap() error
• type QueryResult
• type RangeQueryResult

Functions

func IsUnavailableError

func IsUnavailableError(err error) bool

func RegisterMetrics

func RegisterMetrics()

Types

type APIError

type APIError struct {
	Status    string       `json:"status"`
	ErrorType v1.ErrorType `json:"errorType"`
	Error     string       `json:"error"`
}

type ConfigResult

type ConfigResult struct {
	URI    string
	Config PrometheusConfig
}

type ConfigSectionGlobal

type ConfigSectionGlobal struct {
	ScrapeInterval     time.Duration     `yaml:"scrape_interval"`
	ScrapeTimeout      time.Duration     `yaml:"scrape_timeout"`
	EvaluationInterval time.Duration     `yaml:"evaluation_interval"`
	ExternalLabels     map[string]string `yaml:"external_labels"`
}

type FailoverGroup

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

func NewFailoverGroup

func NewFailoverGroup(name string, servers []*Prometheus, strictErrors bool) *FailoverGroup

func (*FailoverGroup) ClearCache

func (fg *FailoverGroup) ClearCache()

func (*FailoverGroup) Close

func (fg *FailoverGroup) Close()

func (*FailoverGroup) Config

func (fg *FailoverGroup) Config(ctx context.Context) (cfg *ConfigResult, err error)

func (*FailoverGroup) Metadata

func (fg *FailoverGroup) Metadata(ctx context.Context, metric string) (metadata *MetadataResult, err error)

func (*FailoverGroup) Name

func (fg *FailoverGroup) Name() string

func (*FailoverGroup) Query

func (fg *FailoverGroup) Query(ctx context.Context, expr string) (qr *QueryResult, err error)

func (*FailoverGroup) RangeQuery

func (fg *FailoverGroup) RangeQuery(ctx context.Context, expr string, start, end time.Time, step time.Duration) (rqr *RangeQueryResult, err error)

func (*FailoverGroup) StartWorkers

func (fg *FailoverGroup) StartWorkers()

type FailoverGroupError

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

func (*FailoverGroupError) Error

func (e *FailoverGroupError) Error() string

func (*FailoverGroupError) IsStrict

func (e *FailoverGroupError) IsStrict() bool

func (*FailoverGroupError) URI

func (e *FailoverGroupError) URI() string

func (*FailoverGroupError) Unwrap

func (e *FailoverGroupError) Unwrap() error

type MetadataResult

type MetadataResult struct {
	URI      string
	Metadata []v1.Metadata
}

type Prometheus

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

func NewPrometheus

func NewPrometheus(name, uri string, timeout time.Duration, concurrency int) *Prometheus

func (*Prometheus) Close

func (prom *Prometheus) Close()

func (*Prometheus) Config

func (p *Prometheus) Config(ctx context.Context) (*ConfigResult, error)

func (*Prometheus) Metadata

func (p *Prometheus) Metadata(ctx context.Context, metric string) (*MetadataResult, error)

func (*Prometheus) Query

func (p *Prometheus) Query(ctx context.Context, expr string) (*QueryResult, error)

func (*Prometheus) RangeQuery

func (p *Prometheus) RangeQuery(ctx context.Context, expr string, start, end time.Time, step time.Duration) (*RangeQueryResult, error)

func (*Prometheus) StartWorkers

func (prom *Prometheus) StartWorkers()

type PrometheusConfig

type PrometheusConfig struct {
	Global ConfigSectionGlobal `yaml:"global"`
}

type QueryError

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

func (QueryError) Error

func (qe QueryError) Error() string

func (QueryError) Unwrap

func (qe QueryError) Unwrap() error

type QueryResult

type QueryResult struct {
	URI             string
	Series          model.Vector
	DurationSeconds float64
}

type RangeQueryResult

type RangeQueryResult struct {
	URI             string
	Samples         []*model.SampleStream
	Start           time.Time
	End             time.Time
	DurationSeconds float64
}