models

Documentation

Index

• Variables
• type Bounds
  • func (b Bounds) Blocks(t time.Time) int
  • func (b Bounds) Contains(t time.Time) bool
  • func (b Bounds) End() time.Time
  • func (b Bounds) Equals(other Bounds) bool
  • func (b Bounds) Nearest(t time.Time) Bounds
  • func (b Bounds) Next(n int) Bounds
  • func (b Bounds) Previous(n int) Bounds
  • func (b Bounds) Steps() int
  • func (b Bounds) String() string
  • func (b Bounds) TimeForIndex(idx int) (time.Time, error)
• type MatchType
  • func (m MatchType) String() string
• type Matcher
  • func NewMatcher(t MatchType, n, v []byte) (*Matcher, error)
  • func (m *Matcher) Matches(s []byte) bool
  • func (m *Matcher) String() string
• type Matchers
  • func (m Matchers) ToTags() (Tags, error)
• type Metric
• type Metrics
• type RequestParams
  • func (r RequestParams) ExclusiveEnd() time.Time
• type Tag
• type Tags
  • func EmptyTags() Tags
  • func Normalize(tags Tags) Tags
  • func (t Tags) Add(tags Tags) Tags
  • func (t Tags) AddTag(tag Tag) Tags
  • func (t Tags) Clone() Tags
  • func (t Tags) Get(key []byte) ([]byte, bool)
  • func (t Tags) ID() string
  • func (t Tags) IDLen() int
  • func (t Tags) IDMarshalTo(b []byte) []byte
  • func (t Tags) IDWithExcludes(excludeKeys ...[]byte) uint64
  • func (t Tags) IDWithKeys(includeKeys ...[]byte) uint64
  • func (t Tags) Len() int
  • func (t Tags) Less(i, j int) bool
  • func (t Tags) Swap(i, j int)
  • func (t Tags) TagsWithKeys(includeKeys [][]byte) Tags
  • func (t Tags) TagsWithoutKeys(excludeKeys [][]byte) Tags
  • func (t Tags) WithoutName() Tags

Variables

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

Types

type Bounds

type Bounds struct {
	Start    time.Time
	Duration time.Duration
	StepSize time.Duration
}

Bounds are the time bounds, start time is inclusive but end is exclusive

func (Bounds) Blocks

func (b Bounds) Blocks(t time.Time) int

Blocks returns the number of blocks until time t

func (Bounds) Contains

func (b Bounds) Contains(t time.Time) bool

Contains returns whether the time lies between the bounds.

func (Bounds) End

func (b Bounds) End() time.Time

End calculates the end time for the block and is exclusive

func (Bounds) Equals

func (b Bounds) Equals(other Bounds) bool

Equals is true if two bounds are equal, including stepsize

func (Bounds) Nearest

func (b Bounds) Nearest(t time.Time) Bounds

Nearest returns the nearest bound before the given time

func (Bounds) Next

func (b Bounds) Next(n int) Bounds

Next returns the nth next bound from the current bound

func (Bounds) Previous

func (b Bounds) Previous(n int) Bounds

Previous returns the nth previous bound from the current bound

func (Bounds) Steps

func (b Bounds) Steps() int

Steps calculates the number of steps for the bounds

func (Bounds) String

func (b Bounds) String() string

String representation of the bounds

func (Bounds) TimeForIndex

func (b Bounds) TimeForIndex(idx int) (time.Time, error)

TimeForIndex returns the start time for a given index assuming a uniform step size

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  []byte    `json:"name"`
	Value []byte    `json:"value"`
	// contains filtered or unexported fields
}

Matcher models the matching of a label. NB: when serialized to JSON these will be base64'd

func NewMatcher

func NewMatcher(t MatchType, n, v []byte) (*Matcher, error)

NewMatcher returns a matcher object.

func (*Matcher) Matches

func (m *Matcher) Matches(s []byte) 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 {
	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
	Query      string
	Debug      bool
	IncludeEnd bool
}

RequestParams represents the params from the request

func (RequestParams) ExclusiveEnd

func (r RequestParams) ExclusiveEnd() time.Time

ExclusiveEnd returns the end exclusive

type Tag

type Tag struct {
	Name, Value []byte
}

Tag is a key/value metric tag pair

type Tags

type Tags []Tag

Tags is a list of key/value metric tag pairs

func EmptyTags

func EmptyTags() Tags

EmptyTags returns empty model tags

func Normalize

func Normalize(tags Tags) Tags

Normalize normalizes the tags by sorting them in place. In future, it might also ensure other things like uniqueness

func (Tags) Add

func (t Tags) Add(tags Tags) Tags

Add is used to add a list of tags and maintain sorted order

func (Tags) AddTag

func (t Tags) AddTag(tag Tag) Tags

AddTag is used to add a single tag and maintain sorted order

func (Tags) Clone

func (t Tags) Clone() Tags

Clone returns a copy of the tags

func (Tags) Get

func (t Tags) Get(key []byte) ([]byte, bool)

Get returns the value for the tag with the given name.

func (Tags) ID

func (t Tags) ID() string

ID returns a string representation of the tags

func (Tags) IDLen

func (t Tags) IDLen() int

IDLen returns the length of the ID that would be generated from the tags.

func (Tags) IDMarshalTo

func (t Tags) IDMarshalTo(b []byte) []byte

IDMarshalTo writes out the ID representation of the tags into the provided buffer.

func (Tags) IDWithExcludes

func (t Tags) IDWithExcludes(excludeKeys ...[]byte) uint64

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

func (Tags) IDWithKeys

func (t Tags) IDWithKeys(includeKeys ...[]byte) uint64

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

func (Tags) Len

func (t Tags) Len() int

func (Tags) Less

func (t Tags) Less(i, j int) bool

func (Tags) Swap

func (t Tags) Swap(i, j int)

func (Tags) TagsWithKeys

func (t Tags) TagsWithKeys(includeKeys [][]byte) Tags

TagsWithKeys returns only the tags which have the given keys

func (Tags) TagsWithoutKeys

func (t Tags) TagsWithoutKeys(excludeKeys [][]byte) Tags

TagsWithoutKeys returns only the tags which do not have the given keys

func (Tags) WithoutName

func (t Tags) WithoutName() Tags

WithoutName copies the tags excluding the name tag