metricsreader

Documentation

Index

• Constants
• type BackendReader
  • func NewBackendReader(lg *zap.Logger, cfgGetter config.ConfigGetter, httpCli *http.Client, ...) *BackendReader
  • func (br *BackendReader) AddQueryRule(key string, rule QueryRule)
  • func (br *BackendReader) Close()
  • func (br *BackendReader) GetBackendMetrics() []byte
  • func (br *BackendReader) GetQueryResult(key string) QueryResult
  • func (br *BackendReader) OnElected()
  • func (br *BackendReader) OnRetired()
  • func (br *BackendReader) PreClose()
  • func (br *BackendReader) ReadMetrics(ctx context.Context) error
  • func (br *BackendReader) RemoveQueryRule(key string)
  • func (br *BackendReader) Start(ctx context.Context) error
• type DefaultMetricsReader
  • func NewDefaultMetricsReader(lg *zap.Logger, promFetcher PromInfoFetcher, backendFetcher TopologyFetcher, ...) *DefaultMetricsReader
  • func (dmr *DefaultMetricsReader) AddQueryExpr(key string, queryExpr QueryExpr, queryRule QueryRule)
  • func (dmr *DefaultMetricsReader) Close()
  • func (dmr *DefaultMetricsReader) GetBackendMetrics() []byte
  • func (dmr *DefaultMetricsReader) GetQueryResult(key string) QueryResult
  • func (dmr *DefaultMetricsReader) PreClose()
  • func (dmr *DefaultMetricsReader) RemoveQueryExpr(key string)
  • func (dmr *DefaultMetricsReader) Start(ctx context.Context) error
• type MetricsReader
• type PromInfoFetcher
• type PromReader
  • func NewPromReader(lg *zap.Logger, promFetcher PromInfoFetcher, cfg *config.HealthCheck) *PromReader
  • func (pr *PromReader) AddQueryExpr(key string, queryExpr QueryExpr)
  • func (pr *PromReader) Close()
  • func (pr *PromReader) GetQueryResult(key string) QueryResult
  • func (pr *PromReader) ReadMetrics(ctx context.Context) error
  • func (pr *PromReader) RemoveQueryExpr(key string)
• type QueryExpr
  • func (qe QueryExpr) PromRange(curTime time.Time) promv1.Range
• type QueryResult
  • func (qr QueryResult) Empty() bool
  • func (qr QueryResult) GetSample4Backend(backend policy.BackendCtx) *model.Sample
  • func (qr QueryResult) GetSamplePair4Backend(backend policy.BackendCtx) []model.SamplePair
• type QueryRule
• type TopologyFetcher

Constants

const (
	LabelNameInstance = "instance"
)

Types

type BackendReader

type BackendReader struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewBackendReader

func NewBackendReader(lg *zap.Logger, cfgGetter config.ConfigGetter, httpCli *http.Client, etcdCli *clientv3.Client,
	backendFetcher TopologyFetcher, cfg *config.HealthCheck) *BackendReader

func (*BackendReader) AddQueryRule

func (br *BackendReader) AddQueryRule(key string, rule QueryRule)

func (*BackendReader) Close

func (br *BackendReader) Close()

func (*BackendReader) GetBackendMetrics

func (br *BackendReader) GetBackendMetrics() []byte

func (*BackendReader) GetQueryResult

func (br *BackendReader) GetQueryResult(key string) QueryResult

func (*BackendReader) OnElected

func (br *BackendReader) OnElected()

func (*BackendReader) OnRetired

func (br *BackendReader) OnRetired()

func (*BackendReader) PreClose

func (br *BackendReader) PreClose()

func (*BackendReader) ReadMetrics

func (br *BackendReader) ReadMetrics(ctx context.Context) error

func (*BackendReader) RemoveQueryRule

func (br *BackendReader) RemoveQueryRule(key string)

func (*BackendReader) Start

func (br *BackendReader) Start(ctx context.Context) error

type DefaultMetricsReader

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

func NewDefaultMetricsReader

func NewDefaultMetricsReader(lg *zap.Logger, promFetcher PromInfoFetcher, backendFetcher TopologyFetcher, httpCli *http.Client,
	etcdCli *clientv3.Client, cfg *config.HealthCheck, cfgGetter config.ConfigGetter) *DefaultMetricsReader

func (*DefaultMetricsReader) AddQueryExpr

func (dmr *DefaultMetricsReader) AddQueryExpr(key string, queryExpr QueryExpr, queryRule QueryRule)

func (*DefaultMetricsReader) Close

func (dmr *DefaultMetricsReader) Close()

func (*DefaultMetricsReader) GetBackendMetrics

func (dmr *DefaultMetricsReader) GetBackendMetrics() []byte

func (*DefaultMetricsReader) GetQueryResult

func (dmr *DefaultMetricsReader) GetQueryResult(key string) QueryResult

GetQueryResult returns an empty result if the key or the result is not found.

func (*DefaultMetricsReader) PreClose

func (dmr *DefaultMetricsReader) PreClose()

func (*DefaultMetricsReader) RemoveQueryExpr

func (dmr *DefaultMetricsReader) RemoveQueryExpr(key string)

func (*DefaultMetricsReader) Start

func (dmr *DefaultMetricsReader) Start(ctx context.Context) error

type MetricsReader

type MetricsReader interface {
	Start(ctx context.Context) error
	AddQueryExpr(key string, queryExpr QueryExpr, queryRule QueryRule)
	RemoveQueryExpr(key string)
	GetQueryResult(key string) QueryResult
	GetBackendMetrics() []byte
	PreClose()
	Close()
}

type PromInfoFetcher

type PromInfoFetcher interface {
	GetPromInfo(ctx context.Context) (*infosync.PrometheusInfo, error)
}

PromInfoFetcher is an interface to fetch the Prometheus info from ETCD.

type PromReader

type PromReader struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewPromReader

func NewPromReader(lg *zap.Logger, promFetcher PromInfoFetcher, cfg *config.HealthCheck) *PromReader

func (*PromReader) AddQueryExpr

func (pr *PromReader) AddQueryExpr(key string, queryExpr QueryExpr)

func (*PromReader) Close

func (pr *PromReader) Close()

func (*PromReader) GetQueryResult

func (pr *PromReader) GetQueryResult(key string) QueryResult

func (*PromReader) ReadMetrics

func (pr *PromReader) ReadMetrics(ctx context.Context) error

func (*PromReader) RemoveQueryExpr

func (pr *PromReader) RemoveQueryExpr(key string)

type QueryExpr

type QueryExpr struct {
	PromQL   string
	Range    time.Duration
	HasLabel bool
}

QueryExpr is used for querying Prometheus.

func (QueryExpr) PromRange

func (qe QueryExpr) PromRange(curTime time.Time) promv1.Range

type QueryResult

type QueryResult struct {
	Value      model.Value
	UpdateTime time.Time
}

func (QueryResult) Empty

func (qr QueryResult) Empty() bool

func (QueryResult) GetSample4Backend

func (qr QueryResult) GetSample4Backend(backend policy.BackendCtx) *model.Sample

GetSample4Backend returns metric of a backend from a vector.

func (QueryResult) GetSamplePair4Backend

func (qr QueryResult) GetSamplePair4Backend(backend policy.BackendCtx) []model.SamplePair

GetSamplePair4Backend returns metric of a backend from a matrix.

type QueryRule

type QueryRule struct {
	// Names are the metric names that to be extracted from backend metrics.
	Names []string
	// Retention is the retention time of the metrics. Older metrics are expired.
	Retention time.Duration
	// Metric2Value defines the process from backend metrics (at a timepoint) to a float value.
	// E.g. division or aggregation.
	Metric2Value func(mfs map[string]*dto.MetricFamily) model.SampleValue
	// Range2Value defines the process from a time range of values to a float value.
	// E.g. irate[30s] or increase[1m].
	Range2Value func(pairs []model.SamplePair) model.SampleValue
	// ResultType indicates returning a vector or matrix as the final result.
	ResultType model.ValueType
}

QueryRule is used for processing the result from backend HTTP metrics API. It's too complicated for the BackendReader to parse PromQL, so let the caller to define the process function.

type TopologyFetcher

type TopologyFetcher interface {
	GetTiDBTopology(ctx context.Context) (map[string]*infosync.TiDBTopologyInfo, error)
}

TopologyFetcher is an interface to fetch the tidb topology from ETCD.