ts

package
Version: v1.4.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 18, 2022 License: Apache-2.0 Imports: 6 Imported by: 43

Documentation

Overview

Package ts is a generated GoMock package.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AlignedDatapoints added in v0.15.0

type AlignedDatapoints []Datapoints

AlignedDatapoints is a list of aligned datapoints.

type Datapoint

type Datapoint struct {
	Timestamp xtime.UnixNano
	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 added in v0.4.6

func (d Datapoints) AlignToBounds(
	bounds models.Bounds,
	lookbackDuration time.Duration,
	buffer AlignedDatapoints,
) AlignedDatapoints

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

func (Datapoints) AlignToBoundsNoWriteForward added in v0.6.0

func (d Datapoints) AlignToBoundsNoWriteForward(
	bounds models.Bounds,
	lookbackDuration time.Duration,
	buffer AlignedDatapoints,
) AlignedDatapoints

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 added in v0.4.6

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) Reset added in v0.15.0

func (d Datapoints) Reset(values []float64) []float64

Reset resets the passed in value slice with the current value representation.

func (Datapoints) ValueAt

func (d Datapoints) ValueAt(n int) float64

ValueAt returns the value at the nth element.

func (Datapoints) Values added in v0.4.6

func (d Datapoints) Values() []float64

Values returns the values representation.

type FixedResolutionMutableValues

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

FixedResolutionMutableValues are mutable values with fixed resolution between steps

func NewFixedStepValues

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

NewFixedStepValues returns mutable values with fixed resolution TODO: remove this.

type M3MetricType added in v0.15.17

type M3MetricType uint8

M3MetricType is the enum for M3 metric types. NB: the current use case for this is Graphite metrics. Also see PromMetricType (below). In future, it is worth considering a merge of these two enumerations.

const (
	// M3MetricTypeGauge is the gauge metric type.
	M3MetricTypeGauge M3MetricType = iota

	// M3MetricTypeCounter is the counter metric type.
	M3MetricTypeCounter

	// M3MetricTypeTimer is the timer metric type.
	M3MetricTypeTimer
)

type Metadata added in v0.15.3

type Metadata struct {
	DropUnaggregated bool
}

Metadata is metadata associated with a time series.

type MockValues added in v0.10.0

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

MockValues is a mock of Values interface.

func NewMockValues added in v0.10.0

func NewMockValues(ctrl *gomock.Controller) *MockValues

NewMockValues creates a new mock instance.

func (*MockValues) AlignToBounds added in v0.10.0

func (m *MockValues) AlignToBounds(arg0 models.Bounds, arg1 time.Duration, arg2 AlignedDatapoints) AlignedDatapoints

AlignToBounds mocks base method.

func (*MockValues) AlignToBoundsNoWriteForward added in v0.10.0

func (m *MockValues) AlignToBoundsNoWriteForward(arg0 models.Bounds, arg1 time.Duration, arg2 AlignedDatapoints) AlignedDatapoints

AlignToBoundsNoWriteForward mocks base method.

func (*MockValues) DatapointAt added in v0.10.0

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

DatapointAt mocks base method.

func (*MockValues) Datapoints added in v0.10.0

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

Datapoints mocks base method.

func (*MockValues) EXPECT added in v0.10.0

func (m *MockValues) EXPECT() *MockValuesMockRecorder

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

func (*MockValues) Len added in v0.10.0

func (m *MockValues) Len() int

Len mocks base method.

func (*MockValues) ValueAt added in v0.10.0

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

ValueAt mocks base method.

type MockValuesMockRecorder added in v0.10.0

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

MockValuesMockRecorder is the mock recorder for MockValues.

func (*MockValuesMockRecorder) AlignToBounds added in v0.10.0

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

AlignToBounds indicates an expected call of AlignToBounds.

func (*MockValuesMockRecorder) AlignToBoundsNoWriteForward added in v0.10.0

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

AlignToBoundsNoWriteForward indicates an expected call of AlignToBoundsNoWriteForward.

func (*MockValuesMockRecorder) DatapointAt added in v0.10.0

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

DatapointAt indicates an expected call of DatapointAt.

func (*MockValuesMockRecorder) Datapoints added in v0.10.0

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

Datapoints indicates an expected call of Datapoin

func (*MockValuesMockRecorder) Len added in v0.10.0

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

Len indicates an expected call of Len.

func (*MockValuesMockRecorder) ValueAt added in v0.10.0

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 PromMetricType added in v0.15.17

type PromMetricType uint8

PromMetricType is the enum for Prometheus metric types.

const (
	// PromMetricTypeUnknown is the unknown Prometheus metric type.
	PromMetricTypeUnknown PromMetricType = iota

	// PromMetricTypeCounter is the counter Prometheus metric type.
	PromMetricTypeCounter

	// PromMetricTypeGauge is the gauge Prometheus metric type.
	PromMetricTypeGauge

	// PromMetricTypeHistogram is the histogram Prometheus metric type.
	PromMetricTypeHistogram

	// PromMetricTypeGaugeHistogram is the gauge histogram Prometheus metric type.
	PromMetricTypeGaugeHistogram

	// PromMetricTypeSummary is the summary Prometheus metric type.
	PromMetricTypeSummary

	// PromMetricTypeInfo is the info Prometheus metric type.
	PromMetricTypeInfo

	// PromMetricTypeStateSet is the state set Prometheus metric type.
	PromMetricTypeStateSet
)

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 SeriesAttributes added in v0.15.0

type SeriesAttributes struct {
	M3Type            M3MetricType
	PromType          PromMetricType
	Source            SourceType
	HandleValueResets bool
}

SeriesAttributes has attributes about the time series.

func DefaultSeriesAttributes added in v0.15.0

func DefaultSeriesAttributes() SeriesAttributes

DefaultSeriesAttributes returns a default series attributes.

type SeriesList

type SeriesList []*Series

SeriesList represents a slice of series pointers.

type SourceType added in v0.15.0

type SourceType uint8

SourceType is the enum for metric source types.

const (
	// SourceTypePrometheus is the prometheus source type.
	SourceTypePrometheus SourceType = iota

	// SourceTypeGraphite is the graphite source type.
	SourceTypeGraphite

	// SourceTypeOpenMetrics is the Open Metrics source type.
	SourceTypeOpenMetrics
)

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. Takes an optional buffer to
	// allow for memory re-use.
	AlignToBounds(
		bounds models.Bounds,
		lookbackDuration time.Duration,
		buffer AlignedDatapoints,
	) AlignedDatapoints

	// 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.
	// Takes an optional buffer to allow for memory re-use.
	AlignToBoundsNoWriteForward(
		bounds models.Bounds,
		lookbackDuration time.Duration,
		buffer AlignedDatapoints,
	) AlignedDatapoints
}

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL