ingest

Documentation

Overview

Package ingest is a generated GoMock package.

Index

• type BatchError
• type DownsampleAndWriteIter
• type DownsamplerAndWriter
  • func NewDownsamplerAndWriter(store storage.Storage, downsampler downsample.Downsampler, ...) DownsamplerAndWriter
• type IterValue
• type LatencyBuckets
  • func NewLatencyBuckets() (LatencyBuckets, error)
• type MockDownsamplerAndWriter
  • func NewMockDownsamplerAndWriter(ctrl *gomock.Controller) *MockDownsamplerAndWriter
  • func (m *MockDownsamplerAndWriter) EXPECT() *MockDownsamplerAndWriterMockRecorder
  • func (m *MockDownsamplerAndWriter) Storage() storage.Storage
  • func (m *MockDownsamplerAndWriter) Write(arg0 context.Context, arg1 models.Tags, arg2 ts.Datapoints, arg3 time.Unit, ...) error
  • func (m *MockDownsamplerAndWriter) WriteBatch(arg0 context.Context, arg1 DownsampleAndWriteIter, arg2 WriteOptions) BatchError
• type MockDownsamplerAndWriterMockRecorder
  • func (mr *MockDownsamplerAndWriterMockRecorder) Storage() *gomock.Call
  • func (mr *MockDownsamplerAndWriterMockRecorder) Write(arg0, arg1, arg2, arg3, arg4, arg5 interface{}) *gomock.Call
  • func (mr *MockDownsamplerAndWriterMockRecorder) WriteBatch(arg0, arg1, arg2 interface{}) *gomock.Call
• type WriteOptions

Types

type BatchError

type BatchError interface {
	error
	Errors() []error
	LastError() error
}

BatchError allows for access to individual errors.

type DownsampleAndWriteIter

type DownsampleAndWriteIter interface {
	Next() bool
	Current() IterValue
	Reset() error
	Error() error
	SetCurrentMetadata(ts.Metadata)
}

DownsampleAndWriteIter is an interface that can be implemented to use the WriteBatch method.

type DownsamplerAndWriter

type DownsamplerAndWriter interface {
	Write(
		ctx context.Context,
		tags models.Tags,
		datapoints ts.Datapoints,
		unit xtime.Unit,
		annotation []byte,
		overrides WriteOptions,
	) error

	WriteBatch(
		ctx context.Context,
		iter DownsampleAndWriteIter,
		overrides WriteOptions,
	) BatchError

	Storage() storage.Storage
}

DownsamplerAndWriter is the interface for the downsamplerAndWriter which writes metrics to the downsampler as well as to storage in unaggregated form.

func NewDownsamplerAndWriter

func NewDownsamplerAndWriter(
	store storage.Storage,
	downsampler downsample.Downsampler,
	workerPool xsync.PooledWorkerPool,
	instrumentOpts instrument.Options,
) DownsamplerAndWriter

NewDownsamplerAndWriter creates a new downsampler and writer.

type IterValue

type IterValue struct {
	Tags       models.Tags
	Datapoints ts.Datapoints
	Attributes ts.SeriesAttributes
	Unit       xtime.Unit
	Metadata   ts.Metadata
	Annotation []byte
}

IterValue is the value returned by the iterator.

type LatencyBuckets

type LatencyBuckets struct {
	WriteLatencyBuckets  tally.DurationBuckets
	IngestLatencyBuckets tally.DurationBuckets
}

LatencyBuckets are a set of latency buckets useful for measuring things.

func NewLatencyBuckets

func NewLatencyBuckets() (LatencyBuckets, error)

NewLatencyBuckets returns write and ingest latency buckets useful for measuring ingest latency (i.e. time from datapoint/sample created to time ingested) and write latency (i.e. time from received a sample from remote source to completion of that write locally).

type MockDownsamplerAndWriter

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

MockDownsamplerAndWriter is a mock of DownsamplerAndWriter interface.

func NewMockDownsamplerAndWriter

func NewMockDownsamplerAndWriter(ctrl *gomock.Controller) *MockDownsamplerAndWriter

NewMockDownsamplerAndWriter creates a new mock instance.

func (*MockDownsamplerAndWriter) EXPECT

func (m *MockDownsamplerAndWriter) EXPECT() *MockDownsamplerAndWriterMockRecorder

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

func (*MockDownsamplerAndWriter) Storage

func (m *MockDownsamplerAndWriter) Storage() storage.Storage

Storage mocks base method.

func (*MockDownsamplerAndWriter) Write

func (m *MockDownsamplerAndWriter) Write(arg0 context.Context, arg1 models.Tags, arg2 ts.Datapoints, arg3 time.Unit, arg4 []byte, arg5 WriteOptions) error

Write mocks base method.

func (*MockDownsamplerAndWriter) WriteBatch

func (m *MockDownsamplerAndWriter) WriteBatch(arg0 context.Context, arg1 DownsampleAndWriteIter, arg2 WriteOptions) BatchError

WriteBatch mocks base method.

type MockDownsamplerAndWriterMockRecorder

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

MockDownsamplerAndWriterMockRecorder is the mock recorder for MockDownsamplerAndWriter.

func (*MockDownsamplerAndWriterMockRecorder) Storage

func (mr *MockDownsamplerAndWriterMockRecorder) Storage() *gomock.Call

Storage indicates an expected call of Storage.

func (*MockDownsamplerAndWriterMockRecorder) Write

func (mr *MockDownsamplerAndWriterMockRecorder) Write(arg0, arg1, arg2, arg3, arg4, arg5 interface{}) *gomock.Call

Write indicates an expected call of Write.

func (*MockDownsamplerAndWriterMockRecorder) WriteBatch

func (mr *MockDownsamplerAndWriterMockRecorder) WriteBatch(arg0, arg1, arg2 interface{}) *gomock.Call

WriteBatch indicates an expected call of WriteBatch.

type WriteOptions

type WriteOptions struct {
	DownsampleMappingRules []downsample.AutoMappingRule
	WriteStoragePolicies   []policy.StoragePolicy

	DownsampleOverride bool
	WriteOverride      bool
}

WriteOptions contains overrides for the downsampling mapping rules and storage policies for a given write.