metric

Documentation

Overview

package metric represents Prometheus metric samples as objects.

Class

There is only one class: `metric:metric`

Object

A metric sample, which includes a metric time series (name and labels), a timestamp and a value.

Query

Queries are PromQL time series selector strings, prefixed by `metric:metric:` for example:

metric:metric:http_requests_total{environment=~"staging|testing|development",method!="GET"}

Store

Prometheus is the store, store configuration:

domain: metric
metric: URL_OF_PROMETHEUS

Index

• Constants
• Variables
• func NewStore(baseURL string, hc *http.Client) (korrel8r.Store, error)
• type Class
  • func (c Class) Description() string
  • func (c Class) Domain() korrel8r.Domain
  • func (c Class) Name() string
  • func (c Class) New() korrel8r.Object
  • func (c Class) Preview(o korrel8r.Object) string
  • func (c Class) String() string
• type Object
• type Query
  • func (q Query) Class() korrel8r.Class
  • func (q Query) Data() string
  • func (q Query) String() string
• type Store
  • func (s *Store) Domain() korrel8r.Domain
  • func (s *Store) Get(ctx context.Context, query korrel8r.Query, c *korrel8r.Constraint, ...) error

Constants

const StoreKeyMetricURL = "metric"

Variables

var (
	Domain = domain{}
)

Functions

func NewStore

func NewStore(baseURL string, hc *http.Client) (korrel8r.Store, error)

Types

type Class

type Class struct{} // Singleton class

func (Class) Description

func (c Class) Description() string

func (Class) Domain

func (c Class) Domain() korrel8r.Domain

func (Class) Name

func (c Class) Name() string

func (Class) New

func (c Class) New() korrel8r.Object

func (Class) Preview

func (c Class) Preview(o korrel8r.Object) string

func (Class) String

func (c Class) String() string

type Object

type Object *model.Sample

type Query

type Query struct {
	PromQL string // `json:",omitempty"`
}

func (Query) Class

func (q Query) Class() korrel8r.Class

func (Query) Data

func (q Query) Data() string

func (Query) String

func (q Query) String() string

type Store

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

func (*Store) Domain

func (s *Store) Domain() korrel8r.Domain

func (*Store) Get

func (s *Store) Get(ctx context.Context, query korrel8r.Query, c *korrel8r.Constraint, result korrel8r.Appender) error