datasource

Documentation

Index

• type Label
• type Metric
  • func (m *Metric) AddLabel(key, value string)
  • func (m *Metric) Label(key string) string
  • func (m *Metric) SetLabel(key, value string)
• type Querier
• type QuerierBuilder
  • func Init() (QuerierBuilder, error)
• type QuerierParams
• type Type
  • func NewGraphiteType() Type
  • func NewPrometheusType() Type
  • func NewRawType(d string) Type
  • func (t *Type) Get() string
  • func (t Type) MarshalYAML() (interface{}, error)
  • func (t *Type) Set(d Type)
  • func (t Type) String() string
  • func (t *Type) UnmarshalYAML(unmarshal func(interface{}) error) error
  • func (t *Type) ValidateExpr(expr string) error
• type VMStorage
  • func NewVMStorage(baseURL, basicAuthUser, basicAuthPass string, lookBack time.Duration, ...) *VMStorage
  • func (s *VMStorage) ApplyParams(params QuerierParams) *VMStorage
  • func (s *VMStorage) BuildWithParams(params QuerierParams) Querier
  • func (s *VMStorage) Clone() *VMStorage
  • func (s *VMStorage) Query(ctx context.Context, query string) ([]Metric, error)
  • func (s *VMStorage) QueryRange(ctx context.Context, query string, start, end time.Time) ([]Metric, error)

Types

type Label

type Label struct {
	Name  string
	Value string
}

Label represents metric's label

type Metric

type Metric struct {
	Labels     []Label
	Timestamps []int64
	Values     []float64
}

Metric is the basic entity which should be return by datasource

func (*Metric) AddLabel

func (m *Metric) AddLabel(key, value string)

AddLabel appends the given label to the label set

func (*Metric) Label

func (m *Metric) Label(key string) string

Label returns the given label value. If label is missing empty string will be returned

func (*Metric) SetLabel

func (m *Metric) SetLabel(key, value string)

SetLabel adds or updates existing one label by the given key and label

type Querier

type Querier interface {
	Query(ctx context.Context, query string) ([]Metric, error)
	QueryRange(ctx context.Context, query string, from, to time.Time) ([]Metric, error)
}

Querier interface wraps Query and QueryRange methods

type QuerierBuilder

type QuerierBuilder interface {
	BuildWithParams(params QuerierParams) Querier
}

QuerierBuilder builds Querier with given params.

func Init

func Init() (QuerierBuilder, error)

Init creates a Querier from provided flag values.

type QuerierParams

type QuerierParams struct {
	DataSourceType     *Type
	EvaluationInterval time.Duration
	// see https://docs.victoriametrics.com/#prometheus-querying-api-enhancements
	ExtraLabels map[string]string
}

QuerierParams params for Querier.

type Type

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

Type represents data source type

func NewGraphiteType

func NewGraphiteType() Type

NewGraphiteType returns graphite datasource type

func NewPrometheusType

func NewPrometheusType() Type

NewPrometheusType returns prometheus datasource type

func NewRawType

func NewRawType(d string) Type

NewRawType returns datasource type from raw string without validation.

func (*Type) Get

func (t *Type) Get() string

Get returns datasource type

func (Type) MarshalYAML

func (t Type) MarshalYAML() (interface{}, error)

MarshalYAML implements the yaml.Unmarshaler interface.

func (*Type) Set

func (t *Type) Set(d Type)

Set changes datasource type

func (Type) String

func (t Type) String() string

String implements String interface with default value.

func (*Type) UnmarshalYAML

func (t *Type) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the yaml.Unmarshaler interface.

func (*Type) ValidateExpr

func (t *Type) ValidateExpr(expr string) error

ValidateExpr validates query expression with datasource ql.

type VMStorage

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

VMStorage represents vmstorage entity with ability to read and write metrics

func NewVMStorage

func NewVMStorage(baseURL, basicAuthUser, basicAuthPass string, lookBack time.Duration, queryStep time.Duration, appendTypePrefix bool, c *http.Client) *VMStorage

NewVMStorage is a constructor for VMStorage

func (*VMStorage) ApplyParams

func (s *VMStorage) ApplyParams(params QuerierParams) *VMStorage

ApplyParams - changes given querier params.

func (*VMStorage) BuildWithParams

func (s *VMStorage) BuildWithParams(params QuerierParams) Querier

BuildWithParams - implements interface.

func (*VMStorage) Clone

func (s *VMStorage) Clone() *VMStorage

Clone makes clone of VMStorage, shares http client.

func (*VMStorage) Query

func (s *VMStorage) Query(ctx context.Context, query string) ([]Metric, error)

Query executes the given query and returns parsed response

func (*VMStorage) QueryRange

func (s *VMStorage) QueryRange(ctx context.Context, query string, start, end time.Time) ([]Metric, error)

QueryRange executes the given query on the given time range. For Prometheus type see https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries Graphite type isn't supported.