runtime

Documentation

Overview

Package runtime is a generated GoMock package.

Index

• type MockOptionsWatcher
  • func NewMockOptionsWatcher(ctrl *gomock.Controller) *MockOptionsWatcher
  • func (m *MockOptionsWatcher) EXPECT() *MockOptionsWatcherMockRecorder
  • func (m *MockOptionsWatcher) SetRuntimeOptions(arg0 Options)
• type MockOptionsWatcherMockRecorder
  • func (mr *MockOptionsWatcherMockRecorder) SetRuntimeOptions(arg0 interface{}) *gomock.Call
• type Options
  • func NewOptions() Options
• type OptionsManager
  • func NewOptionsManager(initialValue Options) OptionsManager
• type OptionsWatcher

Types

type MockOptionsWatcher

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

MockOptionsWatcher is a mock of OptionsWatcher interface.

func NewMockOptionsWatcher

func NewMockOptionsWatcher(ctrl *gomock.Controller) *MockOptionsWatcher

NewMockOptionsWatcher creates a new mock instance.

func (*MockOptionsWatcher) EXPECT

func (m *MockOptionsWatcher) EXPECT() *MockOptionsWatcherMockRecorder

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

func (*MockOptionsWatcher) SetRuntimeOptions

func (m *MockOptionsWatcher) SetRuntimeOptions(arg0 Options)

SetRuntimeOptions mocks base method.

type MockOptionsWatcherMockRecorder

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

MockOptionsWatcherMockRecorder is the mock recorder for MockOptionsWatcher.

func (*MockOptionsWatcherMockRecorder) SetRuntimeOptions

func (mr *MockOptionsWatcherMockRecorder) SetRuntimeOptions(arg0 interface{}) *gomock.Call

SetRuntimeOptions indicates an expected call of SetRuntimeOptions.

type Options

type Options interface {
	// SetWriteValuesPerMetricLimitPerSecond sets the rate limit used
	// to cap the maximum number of values allowed to be written per second.
	SetWriteValuesPerMetricLimitPerSecond(value int64) Options

	// WriteValuesPerMetricLimitPerSecond returns the rate limit used
	// to cap the maximum number of values allowed to be written per second.
	WriteValuesPerMetricLimitPerSecond() int64

	// SetWriteNewMetricLimitPerShardPerSecond sets the rate limit used
	// to cap the maximum number of new metrics allowed to be written per shard per second.
	SetWriteNewMetricLimitPerShardPerSecond(value int64) Options

	// WriteNewMetricLimitPerShardPerSecond returns the rate limit used
	// to cap the maximum number of new metrics allowed to be written per shard per second.
	WriteNewMetricLimitPerShardPerSecond() int64

	// SetWriteNewMetricNoLimitWarmupDuration sets the warmup duration during which
	// rate limiting is not applied for writing new metric series for the purpose
	// of not aggresively limiting new series insertion rate when an instance just
	// comes online and is ingesting a large number of new series during startup.
	// The warmup duration is in effect starting from the time when the first entry
	// is insert into the shard.
	SetWriteNewMetricNoLimitWarmupDuration(value time.Duration) Options

	// WriteNewMetricNoLimitWarmupDuration returns the warmup duration during which
	// rate limiting is not applied for writing new metric series for the purpose
	// of not aggresively limiting new series insertion rate when an instance just
	// comes online and is ingesting a large number of new series during startup.
	// The warmup duration is in effect starting from the time when the first entry
	// is insert into the shard.
	WriteNewMetricNoLimitWarmupDuration() time.Duration
}

Options provide a set of options that are configurable at runtime.

func NewOptions

func NewOptions() Options

NewOptions creates a new set of runtime options.

type OptionsManager

type OptionsManager interface {
	// SetRuntimeOptions sets the runtime options.
	SetRuntimeOptions(value Options)

	// RuntimeOptions returns the current runtime options.
	RuntimeOptions() Options

	// RegisterWatcher registers a watcher that watches updates to runtime options.
	// When an update arrives, the manager will deliver the update to all registered
	// watchers.
	RegisterWatcher(l OptionsWatcher) xresource.SimpleCloser

	// Close closes the watcher and all descendent watches
	Close()
}

OptionsManager manages runtime options.

func NewOptionsManager

func NewOptionsManager(initialValue Options) OptionsManager

NewOptionsManager creates a new runtime options manager.

type OptionsWatcher

type OptionsWatcher interface {
	// SetRuntimeOptions is called for registerer watchers when the runtime options
	// are updated, passing in the updated options as the argument.
	SetRuntimeOptions(value Options)
}

OptionsWatcher watches for updates to runtime options.