models

Documentation

Index

• Constants
• type MatchType
  • func (m MatchType) String() string
• type Matcher
  • func NewMatcher(t MatchType, n, v string) (*Matcher, error)
  • func (m *Matcher) Matches(s string) bool
  • func (m *Matcher) String() string
• type Matchers
  • func (m Matchers) ToTags() (Tags, error)
• type Metric
• type Metrics
• type RequestParams
• type Tags
  • func (t Tags) ID() string
  • func (t Tags) IDWithExcludes(excludeKeys ...string) uint64
  • func (t Tags) IDWithKeys(includeKeys ...string) uint64
  • func (t Tags) WithoutName() Tags

Constants

const (
	// MetricName is an internal name used to denote the name of the metric.
	// TODO: Get these from the storage
	MetricName = "__name__"
)

Types

type MatchType

type MatchType int

MatchType is an enum for label matching types.

const (
	MatchEqual MatchType = iota
	MatchNotEqual
	MatchRegexp
	MatchNotRegexp
)

Possible MatchTypes.

func (MatchType) String

func (m MatchType) String() string

type Matcher

type Matcher struct {
	Type  MatchType `json:"type"`
	Name  string    `json:"name"`
	Value string    `json:"value"`
	// contains filtered or unexported fields
}

Matcher models the matching of a label.

func NewMatcher

func NewMatcher(t MatchType, n, v string) (*Matcher, error)

NewMatcher returns a matcher object.

func (*Matcher) Matches

func (m *Matcher) Matches(s string) bool

Matches returns whether the matcher matches the given string value.

func (*Matcher) String

func (m *Matcher) String() string

type Matchers

type Matchers []*Matcher

Matchers is of matchers

func (Matchers) ToTags

func (m Matchers) ToTags() (Tags, error)

ToTags converts Matchers to Tags NB (braskin): this only works for exact matches

type Metric

type Metric struct {
	Namespace string
	ID        string
	Tags      Tags
}

Metric is the individual metric that gets returned from the search endpoint

type Metrics

type Metrics []*Metric

Metrics is a list of individual metrics

type RequestParams

type RequestParams struct {
	Start time.Time
	End   time.Time
	// Now captures the current time and fixes it throughout the request, we may let people override it in the future
	Now     time.Time
	Timeout time.Duration
	Step    time.Duration
	Target  string
	Debug   bool
}

RequestParams represents the params from the request

type Tags

type Tags map[string]string

Tags is a key/value map of metric tags.

func (Tags) ID

func (t Tags) ID() string

ID returns a string representation of the tags

func (Tags) IDWithExcludes

func (t Tags) IDWithExcludes(excludeKeys ...string) uint64

IDWithExcludes returns a string representation of the tags excluding some tag keys

func (Tags) IDWithKeys

func (t Tags) IDWithKeys(includeKeys ...string) uint64

IDWithKeys returns a string representation of the tags only including the given keys

func (Tags) WithoutName

func (t Tags) WithoutName() Tags

WithoutName copies the tags excluding the name tag