ts

Documentation

Overview

Package ts is a generated GoMock package.

Index

• func Memset(data []float64, value float64)
• func MemsetInt(data []int, value int)
• type Datapoint
• type Datapoints
  • func (d Datapoints) AlignToBounds(bounds models.Bounds, lookbackDuration time.Duration) []Datapoints
  • func (d Datapoints) AlignToBoundsNoWriteForward(bounds models.Bounds, lookbackDuration time.Duration) []Datapoints
  • func (d Datapoints) DatapointAt(n int) Datapoint
  • func (d Datapoints) Datapoints() []Datapoint
  • func (d Datapoints) Len() int
  • func (d Datapoints) ValueAt(n int) float64
  • func (d Datapoints) Values() []float64
• type FixedResolutionMutableValues
  • func NewFixedStepValues(resolution time.Duration, numSteps int, initialValue float64, ...) FixedResolutionMutableValues
• type MockValues
  • func NewMockValues(ctrl *gomock.Controller) *MockValues
  • func (m *MockValues) AlignToBounds(arg0 models.Bounds, arg1 time.Duration) []Datapoints
  • func (m *MockValues) AlignToBoundsNoWriteForward(arg0 models.Bounds, arg1 time.Duration) []Datapoints
  • func (m *MockValues) DatapointAt(arg0 int) Datapoint
  • func (m *MockValues) Datapoints() []Datapoint
  • func (m *MockValues) EXPECT() *MockValuesMockRecorder
  • func (m *MockValues) Len() int
  • func (m *MockValues) ValueAt(arg0 int) float64
• type MockValuesMockRecorder
  • func (mr *MockValuesMockRecorder) AlignToBounds(arg0, arg1 interface{}) *gomock.Call
  • func (mr *MockValuesMockRecorder) AlignToBoundsNoWriteForward(arg0, arg1 interface{}) *gomock.Call
  • func (mr *MockValuesMockRecorder) DatapointAt(arg0 interface{}) *gomock.Call
  • func (mr *MockValuesMockRecorder) Datapoints() *gomock.Call
  • func (mr *MockValuesMockRecorder) Len() *gomock.Call
  • func (mr *MockValuesMockRecorder) ValueAt(arg0 interface{}) *gomock.Call
• type MutableValues
• type Series
  • func NewSeries(name []byte, vals Values, tags models.Tags) *Series
  • func (s *Series) Len() int
  • func (s *Series) Name() []byte
  • func (s *Series) Values() Values
• type SeriesList
• type Values

Functions

func Memset

func Memset(data []float64, value float64)

Memset is a faster way to initialize a float64 array.

• Inspired from https://github.com/tmthrgd/go-memset. Can't use that library here directly since the library works on byte interface. 0 case is optimized due to https://github.com/golang/go/issues/5373 but for non zero case, we use the copy() optimization.

BenchmarkMemsetZeroValues-4 1000000 1344 ns/op 0 B/op 0 allocs/op BenchmarkLoopZeroValues-4 500000 3217 ns/op 0 B/op 0 allocs/op BenchmarkMemsetNonZeroValues-4 1000000 1537 ns/op 0 B/op 0 allocs/op BenchmarkLoopNonZeroValues-4 500000 3236 ns/op 0 B/op 0 allocs/op *

func MemsetInt

func MemsetInt(data []int, value int)

MemsetInt is a faster way to initialize an int array.

Types

type Datapoint

type Datapoint struct {
	Timestamp time.Time
	Value     float64
}

A Datapoint is a single data value reported at a given time

type Datapoints

type Datapoints []Datapoint

Datapoints is a list of datapoints.

func (Datapoints) AlignToBounds

func (d Datapoints) AlignToBounds(
	bounds models.Bounds,
	lookbackDuration time.Duration,
) []Datapoints

AlignToBounds returns values aligned to given bounds. To belong to a step, values should be <= stepTime and not stale.

func (Datapoints) AlignToBoundsNoWriteForward

func (d Datapoints) AlignToBoundsNoWriteForward(
	bounds models.Bounds,
	lookbackDuration time.Duration,
) []Datapoints

AlignToBoundsNoWriteForward returns values aligned to the start time and duration, but does not write points forward after aligning them. This differs from AlignToBounds which will write points forwards if no additional values are found in the values, adding an empty point instead.

func (Datapoints) DatapointAt

func (d Datapoints) DatapointAt(n int) Datapoint

DatapointAt returns the value at the nth element.

func (Datapoints) Datapoints

func (d Datapoints) Datapoints() []Datapoint

Datapoints returns all the datapoints.

func (Datapoints) Len

func (d Datapoints) Len() int

Len is the length of the array.

func (Datapoints) ValueAt

func (d Datapoints) ValueAt(n int) float64

ValueAt returns the value at the nth element.

func (Datapoints) Values

func (d Datapoints) Values() []float64

Values returns the values representation.

type FixedResolutionMutableValues

type FixedResolutionMutableValues interface {
	MutableValues
	Resolution() time.Duration
	StepAtTime(t time.Time) int
	StartTimeForStep(n int) time.Time
	// Time when the series starts
	StartTime() time.Time
}

FixedResolutionMutableValues are mutable values with fixed resolution between steps

func NewFixedStepValues

func NewFixedStepValues(
	resolution time.Duration,
	numSteps int,
	initialValue float64,
	startTime time.Time,
) FixedResolutionMutableValues

NewFixedStepValues returns mutable values with fixed resolution

type MockValues

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

MockValues is a mock of Values interface

func NewMockValues

func NewMockValues(ctrl *gomock.Controller) *MockValues

NewMockValues creates a new mock instance

func (*MockValues) AlignToBounds

func (m *MockValues) AlignToBounds(arg0 models.Bounds, arg1 time.Duration) []Datapoints

AlignToBounds mocks base method

func (*MockValues) AlignToBoundsNoWriteForward

func (m *MockValues) AlignToBoundsNoWriteForward(arg0 models.Bounds, arg1 time.Duration) []Datapoints

AlignToBoundsNoWriteForward mocks base method

func (*MockValues) DatapointAt

func (m *MockValues) DatapointAt(arg0 int) Datapoint

DatapointAt mocks base method

func (*MockValues) Datapoints

func (m *MockValues) Datapoints() []Datapoint

Datapoints mocks base method

func (*MockValues) EXPECT

func (m *MockValues) EXPECT() *MockValuesMockRecorder

EXPECT returns an object that allows the caller to indicate expected use

func (*MockValues) Len

func (m *MockValues) Len() int

Len mocks base method

func (*MockValues) ValueAt

func (m *MockValues) ValueAt(arg0 int) float64

ValueAt mocks base method

type MockValuesMockRecorder

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

MockValuesMockRecorder is the mock recorder for MockValues

func (*MockValuesMockRecorder) AlignToBounds

func (mr *MockValuesMockRecorder) AlignToBounds(arg0, arg1 interface{}) *gomock.Call

AlignToBounds indicates an expected call of AlignToBounds

func (*MockValuesMockRecorder) AlignToBoundsNoWriteForward

func (mr *MockValuesMockRecorder) AlignToBoundsNoWriteForward(arg0, arg1 interface{}) *gomock.Call

AlignToBoundsNoWriteForward indicates an expected call of AlignToBoundsNoWriteForward

func (*MockValuesMockRecorder) DatapointAt

func (mr *MockValuesMockRecorder) DatapointAt(arg0 interface{}) *gomock.Call

DatapointAt indicates an expected call of DatapointAt

func (*MockValuesMockRecorder) Datapoints

func (mr *MockValuesMockRecorder) Datapoints() *gomock.Call

Datapoints indicates an expected call of Datapoints

func (*MockValuesMockRecorder) Len

func (mr *MockValuesMockRecorder) Len() *gomock.Call

Len indicates an expected call of Len

func (*MockValuesMockRecorder) ValueAt

func (mr *MockValuesMockRecorder) ValueAt(arg0 interface{}) *gomock.Call

ValueAt indicates an expected call of ValueAt

type MutableValues

type MutableValues interface {
	Values

	// Sets the value at the given entry
	SetValueAt(n int, v float64)
}

MutableValues is the interface for values that can be updated

type Series

type Series struct {
	Tags models.Tags
	// contains filtered or unexported fields
}

Series is the public interface to a block of timeseries values. Each block has a start time, a logical number of steps, and a step size indicating the number of milliseconds represented by each point.

func NewSeries

func NewSeries(name []byte, vals Values, tags models.Tags) *Series

NewSeries creates a new Series at a given start time, backed by the provided values.

func (*Series) Len

func (s *Series) Len() int

Len returns the number of values in the time series. Used for aggregation.

func (*Series) Name

func (s *Series) Name() []byte

Name returns the name of the timeseries block

func (*Series) Values

func (s *Series) Values() Values

Values returns the underlying values interface.

type SeriesList

type SeriesList []*Series

SeriesList represents a slice of series pointers.

type Values

type Values interface {
	// Len returns the number of values present
	Len() int

	// ValueAt returns the value at the nth element
	ValueAt(n int) float64

	// DatapointAt returns the datapoint at the nth element
	DatapointAt(n int) Datapoint

	// Datapoints returns all the datapoints
	Datapoints() []Datapoint

	// AlignToBounds returns values aligned to given bounds. To belong to a step,
	// values should be <= stepTime and not stale.
	AlignToBounds(
		bounds models.Bounds,
		lookbackDuration time.Duration,
	) []Datapoints

	// AlignToBoundsNoWriteForward returns values aligned to the start time
	// and duration, but does not write points forward after aligning them. This
	// differs from AlignToBounds which will write points forwards if no
	// additional values are found in the values, adding an empty point instead.
	AlignToBoundsNoWriteForward(
		bounds models.Bounds,
		lookbackDuration time.Duration,
	) []Datapoints
}

Values holds the values for a timeseries. It provides a minimal interface for storing and retrieving values in the series, with Series providing a more convenient interface for applications to build on top of. Values objects are not specific to a given time, allowing them to be pre-allocated, pooled, and re-used across multiple series. There are multiple implementations of Values so that we can optimize storage based on the density of the series.