prometheus

Documentation

Index

• type BaseMetricsQuery
• type Client
  • func NewClient() (*Client, error)
  • func (in *Client) API() prom_v1.API
  • func (in *Client) Address() string
  • func (in *Client) FetchHistogramRange(metricName, labels, grouping string, q *BaseMetricsQuery) Histogram
  • func (in *Client) FetchRange(metricName, labels, grouping, aggregator string, q *BaseMetricsQuery) *Metric
  • func (in *Client) FetchRateRange(metricName, labels, grouping string, q *BaseMetricsQuery) *Metric
  • func (in *Client) GetAllRequestRates(namespace string, ratesInterval string, queryTime time.Time) (model.Vector, error)
  • func (in *Client) GetAppRequestRates(namespace, app, ratesInterval string, queryTime time.Time) (model.Vector, model.Vector, error)
  • func (in *Client) GetConfiguration() (prom_v1.ConfigResult, error)
  • func (in *Client) GetFlags() (prom_v1.FlagsResult, error)
  • func (in *Client) GetMetrics(query *IstioMetricsQuery) Metrics
  • func (in *Client) GetNamespaceServicesRequestRates(namespace string, ratesInterval string, queryTime time.Time) (model.Vector, error)
  • func (in *Client) GetServiceRequestRates(namespace, service, ratesInterval string, queryTime time.Time) (model.Vector, error)
  • func (in *Client) GetWorkloadRequestRates(namespace, workload, ratesInterval string, queryTime time.Time) (model.Vector, model.Vector, error)
  • func (in *Client) Inject(api prom_v1.API)
• type ClientInterface
• type CustomMetricsQuery
  • func (q *CustomMetricsQuery) FillDefaults()
• type Histogram
• type IstioMetricsQuery
  • func (q *IstioMetricsQuery) FillDefaults()
• type Metric
• type Metrics

Types

type BaseMetricsQuery

type BaseMetricsQuery struct {
	prom_v1.Range
	RateInterval string
	RateFunc     string
	Quantiles    []string
	Avg          bool
	ByLabels     []string
}

BaseMetricsQuery holds common parameters for all kinds of queries

type Client

type Client struct {
	ClientInterface
	// contains filtered or unexported fields
}

Client for Prometheus API. It hides the way we query Prometheus offering a layer with a high level defined API.

func NewClient

func NewClient() (*Client, error)

NewClient creates a new client to the Prometheus API. It returns an error on any problem.

func (*Client) API

func (in *Client) API() prom_v1.API

API returns the Prometheus V1 HTTP API for performing calls not supported natively by this client

func (*Client) Address

func (in *Client) Address() string

Address return the configured Prometheus service URL

func (*Client) FetchHistogramRange

func (in *Client) FetchHistogramRange(metricName, labels, grouping string, q *BaseMetricsQuery) Histogram

FetchHistogramRange fetches bucketed metric as histogram in given range

func (*Client) FetchRange

func (in *Client) FetchRange(metricName, labels, grouping, aggregator string, q *BaseMetricsQuery) *Metric

FetchRange fetches a simple metric (gauge or counter) in given range

func (*Client) FetchRateRange

func (in *Client) FetchRateRange(metricName, labels, grouping string, q *BaseMetricsQuery) *Metric

FetchRateRange fetches a counter's rate in given range

func (*Client) GetAllRequestRates

func (in *Client) GetAllRequestRates(namespace string, ratesInterval string, queryTime time.Time) (model.Vector, error)

GetAllRequestRates queries Prometheus to fetch request counter rates, over a time interval, for requests into, internal to, or out of the namespace. Note that it does not discriminate on "reporter", so rates can be inflated due to duplication, and therefore should be used mainly for calculating ratios (e.g total rates / error rates). Returns (rates, error)

func (*Client) GetAppRequestRates

func (in *Client) GetAppRequestRates(namespace, app, ratesInterval string, queryTime time.Time) (model.Vector, model.Vector, error)

GetAppRequestRates queries Prometheus to fetch request counters rates over a time interval for a given app, both in and out. Note that it does not discriminate on "reporter", so rates can be inflated due to duplication, and therefore should be used mainly for calculating ratios (e.g total rates / error rates). Returns (in, out, error)

func (*Client) GetConfiguration

func (in *Client) GetConfiguration() (prom_v1.ConfigResult, error)

func (*Client) GetFlags

func (in *Client) GetFlags() (prom_v1.FlagsResult, error)

func (*Client) GetMetrics

func (in *Client) GetMetrics(query *IstioMetricsQuery) Metrics

GetMetrics returns the Metrics related to the provided query options.

func (*Client) GetNamespaceServicesRequestRates

func (in *Client) GetNamespaceServicesRequestRates(namespace string, ratesInterval string, queryTime time.Time) (model.Vector, error)

GetNamespaceServicesRequestRates queries Prometheus to fetch request counter rates, over a time interval, limited to requests for services in the namespace. Note that it does not discriminate on "reporter", so rates can be inflated due to duplication, and therefore should be used mainly for calculating ratios (e.g total rates / error rates). Returns (rates, error)

func (*Client) GetServiceRequestRates

func (in *Client) GetServiceRequestRates(namespace, service, ratesInterval string, queryTime time.Time) (model.Vector, error)

GetServiceRequestRates queries Prometheus to fetch request counters rates over a time interval for a given service (hence only inbound). Note that it does not discriminate on "reporter", so rates can be inflated due to duplication, and therefore should be used mainly for calculating ratios (e.g total rates / error rates). Returns (in, error)

func (*Client) GetWorkloadRequestRates

func (in *Client) GetWorkloadRequestRates(namespace, workload, ratesInterval string, queryTime time.Time) (model.Vector, model.Vector, error)

GetWorkloadRequestRates queries Prometheus to fetch request counters rates over a time interval for a given workload, both in and out. Note that it does not discriminate on "reporter", so rates can be inflated due to duplication, and therefore should be used mainly for calculating ratios (e.g total rates / error rates). Returns (in, out, error)

func (*Client) Inject

func (in *Client) Inject(api prom_v1.API)

Inject allows for replacing the API with a mock For testing

type ClientInterface

type ClientInterface interface {
	FetchHistogramRange(metricName, labels, grouping string, q *BaseMetricsQuery) Histogram
	FetchRange(metricName, labels, grouping, aggregator string, q *BaseMetricsQuery) *Metric
	FetchRateRange(metricName, labels, grouping string, q *BaseMetricsQuery) *Metric
	GetAllRequestRates(namespace, ratesInterval string, queryTime time.Time) (model.Vector, error)
	GetAppRequestRates(namespace, app, ratesInterval string, queryTime time.Time) (model.Vector, model.Vector, error)
	GetConfiguration() (prom_v1.ConfigResult, error)
	GetFlags() (prom_v1.FlagsResult, error)
	GetMetrics(query *IstioMetricsQuery) Metrics
	GetNamespaceServicesRequestRates(namespace, ratesInterval string, queryTime time.Time) (model.Vector, error)
	GetServiceRequestRates(namespace, service, ratesInterval string, queryTime time.Time) (model.Vector, error)
	GetWorkloadRequestRates(namespace, workload, ratesInterval string, queryTime time.Time) (model.Vector, model.Vector, error)
}

ClientInterface for mocks (only mocked function are necessary here)

type CustomMetricsQuery

type CustomMetricsQuery struct {
	BaseMetricsQuery
	Namespace         string
	App               string
	Version           string
	RawDataAggregator string
}

CustomMetricsQuery holds query parameters for a custom metrics query

func (*CustomMetricsQuery) FillDefaults

func (q *CustomMetricsQuery) FillDefaults()

FillDefaults fills the struct with default parameters

type Histogram

type Histogram = map[string]*Metric

Histogram contains Metric objects for several histogram-kind statistics

type IstioMetricsQuery

type IstioMetricsQuery struct {
	BaseMetricsQuery
	Filters         []string
	Namespace       string
	App             string
	Workload        string
	Service         string
	Direction       string // outbound | inbound
	RequestProtocol string // e.g. http | grpc
	Reporter        string // source | destination, defaults to source if not provided
	Aggregate       string
	AggregateValue  string
}

IstioMetricsQuery holds query parameters for a typical metrics query

func (*IstioMetricsQuery) FillDefaults

func (q *IstioMetricsQuery) FillDefaults()

FillDefaults fills the struct with default parameters

type Metric

type Metric struct {
	Matrix model.Matrix `json:"matrix"`
	Err    error        `json:"-"`
}

Metric holds the Prometheus Matrix model, which contains one or more time series (depending on grouping)

type Metrics

type Metrics struct {
	Metrics    map[string]*Metric   `json:"metrics"`
	Histograms map[string]Histogram `json:"histograms"`
}

Metrics contains all simple metrics and histograms data