Documentation ¶
Overview ¶
Package config is a generated GoMock package.
Index ¶
- Constants
- func InitialClusterEndpoints(initialCluster []environment.SeedNode) ([]string, error)
- func IsSeedNode(initialCluster []environment.SeedNode, hostID string) bool
- func NewEtcdEmbedConfig(cfg DBConfiguration) (*embed.Config, error)
- type BlockRetrievePolicy
- type BootstrapCommitlogConfiguration
- type BootstrapConfiguration
- type BootstrapConfigurationValidator
- type BootstrapFilesystemConfiguration
- type BucketPoolPolicy
- type CacheConfigurations
- type CalculationType
- type CapacityPoolPolicy
- type CommitLogPolicy
- type CommitLogQueuePolicy
- type Configuration
- type ContextPoolPolicy
- type DBConfiguration
- type FilesystemConfiguration
- func (f FilesystemConfiguration) DataReadBufferSizeOrDefault() int
- func (f FilesystemConfiguration) FilePathPrefixOrDefault() string
- func (f FilesystemConfiguration) ForceBloomFilterMmapMemoryOrDefault() bool
- func (f FilesystemConfiguration) ForceIndexSummariesMmapMemoryOrDefault() bool
- func (f FilesystemConfiguration) InfoReadBufferSizeOrDefault() int
- func (f FilesystemConfiguration) MmapConfigurationOrDefault() MmapConfiguration
- func (f FilesystemConfiguration) ParseNewDirectoryMode() (os.FileMode, error)
- func (f FilesystemConfiguration) ParseNewFileMode() (os.FileMode, error)
- func (f FilesystemConfiguration) SeekReadBufferSizeOrDefault() int
- func (f FilesystemConfiguration) ThroughputCheckEveryOrDefault() int
- func (f FilesystemConfiguration) ThroughputLimitMbpsOrDefault() float64
- func (f FilesystemConfiguration) Validate() error
- func (f FilesystemConfiguration) WriteBufferSizeOrDefault() int
- type HashingConfiguration
- type IndexConfiguration
- type LRUSeriesCachePolicyConfiguration
- type Limits
- type MaxCapacityPoolPolicy
- type MmapConfiguration
- type MmapHugeTLBConfiguration
- type MockBootstrapConfigurationValidator
- func (m *MockBootstrapConfigurationValidator) EXPECT() *MockBootstrapConfigurationValidatorMockRecorder
- func (m *MockBootstrapConfigurationValidator) ValidateBootstrappersOrder(arg0 []string) error
- func (m *MockBootstrapConfigurationValidator) ValidateCommitLogBootstrapperOptions(arg0 commitlog.Options) error
- func (m *MockBootstrapConfigurationValidator) ValidateFilesystemBootstrapperOptions(arg0 fs.Options) error
- func (m *MockBootstrapConfigurationValidator) ValidatePeersBootstrapperOptions(arg0 peers.Options) error
- func (m *MockBootstrapConfigurationValidator) ValidateUninitializedBootstrapperOptions(arg0 uninitialized.Options) error
- type MockBootstrapConfigurationValidatorMockRecorder
- func (mr *MockBootstrapConfigurationValidatorMockRecorder) ValidateBootstrappersOrder(arg0 interface{}) *gomock.Call
- func (mr *MockBootstrapConfigurationValidatorMockRecorder) ValidateCommitLogBootstrapperOptions(arg0 interface{}) *gomock.Call
- func (mr *MockBootstrapConfigurationValidatorMockRecorder) ValidateFilesystemBootstrapperOptions(arg0 interface{}) *gomock.Call
- func (mr *MockBootstrapConfigurationValidatorMockRecorder) ValidatePeersBootstrapperOptions(arg0 interface{}) *gomock.Call
- func (mr *MockBootstrapConfigurationValidatorMockRecorder) ValidateUninitializedBootstrapperOptions(arg0 interface{}) *gomock.Call
- type NamespaceProtoSchema
- type PoolPolicy
- type PoolingPolicy
- type PoolingType
- type PostingsListCacheConfiguration
- type ProtoConfiguration
- type RepairPolicy
- type ReplicatedCluster
- type ReplicationPolicy
- type SeriesCacheConfiguration
- type TickConfiguration
- type TransformConfiguration
- type WriteBatchPoolPolicy
Constants ¶
const ( // DefaultNewFileMode is the default new file mode. DefaultNewFileMode = os.FileMode(0666) // DefaultNewDirectoryMode is the default new directory mode. DefaultNewDirectoryMode = os.FileMode(0755) )
Variables ¶
This section is empty.
Functions ¶
func InitialClusterEndpoints ¶
func InitialClusterEndpoints(initialCluster []environment.SeedNode) ([]string, error)
InitialClusterEndpoints returns the endpoints of the initial cluster
func IsSeedNode ¶
func IsSeedNode(initialCluster []environment.SeedNode, hostID string) bool
IsSeedNode returns whether the given hostID is an etcd node.
func NewEtcdEmbedConfig ¶
func NewEtcdEmbedConfig(cfg DBConfiguration) (*embed.Config, error)
NewEtcdEmbedConfig creates a new embedded etcd config from kv config.
Types ¶
type BlockRetrievePolicy ¶
type BlockRetrievePolicy struct { // FetchConcurrency is the concurrency to fetch blocks from disk. For // spinning disks it is highly recommended to set this value to 1. FetchConcurrency int `yaml:"fetchConcurrency" validate:"min=0"` }
BlockRetrievePolicy is the block retrieve policy.
type BootstrapCommitlogConfiguration ¶ added in v0.4.8
type BootstrapCommitlogConfiguration struct { // ReturnUnfulfilledForCorruptCommitLogFiles controls whether the commitlog bootstrapper // will return unfulfilled for all shard time ranges when it encounters a corrupt commit // file. Note that regardless of this value, the commitlog bootstrapper will still try and // read all the uncorrupted commitlog files and return as much data as it can, but setting // this to true allows the node to attempt a repair if the peers bootstrapper is configured // after the commitlog bootstrapper. ReturnUnfulfilledForCorruptCommitLogFiles bool `yaml:"returnUnfulfilledForCorruptCommitLogFiles"` }
BootstrapCommitlogConfiguration specifies config for the commitlog bootstrapper.
type BootstrapConfiguration ¶
type BootstrapConfiguration struct { // Bootstrappers is the list of bootstrappers, ordered by precedence in // descending order. Bootstrappers []string `yaml:"bootstrappers" validate:"nonzero"` // Filesystem bootstrapper configuration. Filesystem *BootstrapFilesystemConfiguration `yaml:"fs"` // Commitlog bootstrapper configuration. Commitlog *BootstrapCommitlogConfiguration `yaml:"commitlog"` // CacheSeriesMetadata determines whether individual bootstrappers cache // series metadata across all calls (namespaces / shards / blocks). CacheSeriesMetadata *bool `yaml:"cacheSeriesMetadata"` }
BootstrapConfiguration specifies the config for bootstrappers.
func (BootstrapConfiguration) New ¶
func (bsc BootstrapConfiguration) New( validator BootstrapConfigurationValidator, rsOpts result.Options, opts storage.Options, topoMapProvider topology.MapProvider, origin topology.Host, adminClient client.AdminClient, ) (bootstrap.ProcessProvider, error)
New creates a bootstrap process based on the bootstrap configuration.
type BootstrapConfigurationValidator ¶ added in v0.9.2
type BootstrapConfigurationValidator interface { ValidateBootstrappersOrder(names []string) error ValidateFilesystemBootstrapperOptions(opts bfs.Options) error ValidateCommitLogBootstrapperOptions(opts commitlog.Options) error ValidatePeersBootstrapperOptions(opts peers.Options) error ValidateUninitializedBootstrapperOptions(opts uninitialized.Options) error }
BootstrapConfigurationValidator can be used to validate the option sets that the bootstrap configuration builds. Useful for tests and perhaps verifying same options set across multiple bootstrappers.
func NewBootstrapConfigurationValidator ¶ added in v0.9.2
func NewBootstrapConfigurationValidator() BootstrapConfigurationValidator
NewBootstrapConfigurationValidator returns a new bootstrap configuration validator that validates certain options configured by the bootstrap configuration.
type BootstrapFilesystemConfiguration ¶
type BootstrapFilesystemConfiguration struct { // NumProcessorsPerCPU is the number of processors per CPU. NumProcessorsPerCPU float64 `yaml:"numProcessorsPerCPU" validate:"min=0.0"` }
BootstrapFilesystemConfiguration specifies config for the fs bootstrapper.
type BucketPoolPolicy ¶
type BucketPoolPolicy struct { // The pool buckets sizes to use Buckets []CapacityPoolPolicy `yaml:"buckets"` }
BucketPoolPolicy specifies a bucket pool policy.
type CacheConfigurations ¶
type CacheConfigurations struct { // Series cache policy. Series *SeriesCacheConfiguration `yaml:"series"` // PostingsList cache policy. PostingsList *PostingsListCacheConfiguration `yaml:"postingsList"` }
CacheConfigurations is the cache configurations.
func (CacheConfigurations) PostingsListConfiguration ¶ added in v0.6.0
func (c CacheConfigurations) PostingsListConfiguration() PostingsListCacheConfiguration
PostingsListConfiguration returns the postings list cache configuration or default if none is specified.
func (CacheConfigurations) SeriesConfiguration ¶
func (c CacheConfigurations) SeriesConfiguration() SeriesCacheConfiguration
SeriesConfiguration returns the series cache configuration or default if none is specified.
type CalculationType ¶
type CalculationType string
CalculationType is a type of configuration parameter.
const ( // CalculationTypeFixed is a fixed parameter not to be scaled of any parameter. CalculationTypeFixed CalculationType = "fixed" // CalculationTypePerCPU is a parameter that needs to be scaled by number of CPUs. CalculationTypePerCPU CalculationType = "percpu" )
type CapacityPoolPolicy ¶
type CapacityPoolPolicy struct { PoolPolicy `yaml:",inline"` // The capacity of items in the pool. Capacity *int `yaml:"capacity"` }
CapacityPoolPolicy specifies a single pool policy that has a per element capacity.
func (*CapacityPoolPolicy) CapacityOrDefault ¶ added in v0.6.0
func (p *CapacityPoolPolicy) CapacityOrDefault() int
CapacityOrDefault returns the configured capacity if present, or a default value otherwise.
type CommitLogPolicy ¶
type CommitLogPolicy struct { // The max size the commit log will flush a segment to disk after buffering. FlushMaxBytes int `yaml:"flushMaxBytes" validate:"nonzero"` // The maximum amount of time the commit log will wait to flush to disk. FlushEvery time.Duration `yaml:"flushEvery" validate:"nonzero"` // The queue the commit log will keep in front of the current commit log segment. // Modifying values in this policy will control how many pending writes can be // in the commitlog queue before M3DB will begin rejecting writes. Queue CommitLogQueuePolicy `yaml:"queue" validate:"nonzero"` // The actual Golang channel that implements the commit log queue. We separate this // from the Queue field for historical / legacy reasons. Generally speaking, the // values in this config should not need to be modified, but we leave it in for // tuning purposes. Unlike the Queue field, values in this policy control the size // of the channel that backs the queue. Since writes to the commitlog are batched, // setting the size of this policy will control how many batches can be queued, and // indrectly how many writes can be queued, but that is dependent on the batch size // of the client. As a result, we recommend that users avoid tuning this field and // modify the Queue size instead which maps directly to the number of writes. This // works in most cases because the default size of the QueueChannel should be large // enough for almost all workloads assuming a reasonable batch size is used. QueueChannel *CommitLogQueuePolicy `yaml:"queueChannel"` // Deprecated. Left in struct to keep old YAMLs parseable. // TODO(V1): remove DeprecatedBlockSize *time.Duration `yaml:"blockSize"` }
CommitLogPolicy is the commit log policy.
type CommitLogQueuePolicy ¶
type CommitLogQueuePolicy struct { // The type of calculation for the size. CalculationType CalculationType `yaml:"calculationType"` // The size of the commit log, calculated according to the calculation type. Size int `yaml:"size" validate:"nonzero"` }
CommitLogQueuePolicy is the commit log queue policy.
type Configuration ¶
type Configuration struct { // DB is the configuration for a DB node (required). DB *DBConfiguration `yaml:"db"` // Coordinator is the configuration for the coordinator to run (optional). Coordinator *coordinatorcfg.Configuration `yaml:"coordinator"` }
Configuration is the top level configuration that includes both a DB node and a coordinator.
func (*Configuration) InitDefaultsAndValidate ¶ added in v0.6.0
func (c *Configuration) InitDefaultsAndValidate() error
InitDefaultsAndValidate initializes all default values and validates the Configuration. We use this method to validate fields where the validator package falls short.
type ContextPoolPolicy ¶
type ContextPoolPolicy struct { PoolPolicy `yaml:",inline"` // The maximum allowable size for a slice of finalizers that the // pool will allow to be returned (finalizer slices that grow too // large during use will be discarded instead of returning to the // pool where they would consume more memory.) MaxFinalizerCapacity int `yaml:"maxFinalizerCapacity" validate:"min=0"` }
ContextPoolPolicy specifies the policy for the context pool.
func (ContextPoolPolicy) MaxFinalizerCapacityOrDefault ¶ added in v0.6.0
func (p ContextPoolPolicy) MaxFinalizerCapacityOrDefault() int
MaxFinalizerCapacityOrDefault returns the maximum finalizer capacity and fallsback to the default value if its not set.
type DBConfiguration ¶
type DBConfiguration struct { // Index configuration. Index IndexConfiguration `yaml:"index"` // Transforms configuration. Transforms TransformConfiguration `yaml:"transforms"` // Logging configuration. Logging xlog.Configuration `yaml:"logging"` // Metrics configuration. Metrics instrument.MetricsConfiguration `yaml:"metrics"` // The host and port on which to listen for the node service. ListenAddress string `yaml:"listenAddress" validate:"nonzero"` // The host and port on which to listen for the cluster service. ClusterListenAddress string `yaml:"clusterListenAddress" validate:"nonzero"` // The HTTP host and port on which to listen for the node service. HTTPNodeListenAddress string `yaml:"httpNodeListenAddress" validate:"nonzero"` // The HTTP host and port on which to listen for the cluster service. HTTPClusterListenAddress string `yaml:"httpClusterListenAddress" validate:"nonzero"` // The host and port on which to listen for debug endpoints. DebugListenAddress string `yaml:"debugListenAddress"` // HostID is the local host ID configuration. HostID hostid.Configuration `yaml:"hostID"` // Client configuration, used for inter-node communication and when used as a coordinator. Client client.Configuration `yaml:"client"` // The initial garbage collection target percentage. GCPercentage int `yaml:"gcPercentage" validate:"max=100"` // TODO(V1): Move to `limits`. // Write new series limit per second to limit overwhelming during new ID bursts. WriteNewSeriesLimitPerSecond int `yaml:"writeNewSeriesLimitPerSecond"` // TODO(V1): Move to `limits`. // Write new series backoff between batches of new series insertions. WriteNewSeriesBackoffDuration time.Duration `yaml:"writeNewSeriesBackoffDuration"` // The tick configuration, omit this to use default settings. Tick *TickConfiguration `yaml:"tick"` // Bootstrap configuration. Bootstrap BootstrapConfiguration `yaml:"bootstrap"` // The block retriever policy. BlockRetrieve *BlockRetrievePolicy `yaml:"blockRetrieve"` // Cache configurations. Cache CacheConfigurations `yaml:"cache"` // The filesystem configuration for the node. Filesystem FilesystemConfiguration `yaml:"fs"` // The commit log policy for the node. CommitLog CommitLogPolicy `yaml:"commitlog"` // The repair policy for repairing data within a cluster. Repair *RepairPolicy `yaml:"repair"` // The replication policy for replicating data between clusters. Replication *ReplicationPolicy `yaml:"replication"` // The pooling policy. PoolingPolicy PoolingPolicy `yaml:"pooling"` // The environment (static or dynamic) configuration. EnvironmentConfig environment.Configuration `yaml:"config"` // The configuration for hashing Hashing HashingConfiguration `yaml:"hashing"` // Write new series asynchronously for fast ingestion of new ID bursts. WriteNewSeriesAsync bool `yaml:"writeNewSeriesAsync"` // Proto contains the configuration specific to running in the ProtoDataMode. Proto *ProtoConfiguration `yaml:"proto"` // Tracing configures opentracing. If not provided, tracing is disabled. Tracing *opentracing.TracingConfiguration `yaml:"tracing"` // Limits contains configuration for limits that can be applied to M3DB for the purposes // of applying back-pressure or protecting the db nodes. Limits Limits `yaml:"limits"` }
DBConfiguration is the configuration for a DB node.
func (*DBConfiguration) InitDefaultsAndValidate ¶ added in v0.6.0
func (c *DBConfiguration) InitDefaultsAndValidate() error
InitDefaultsAndValidate initializes all default values and validates the Configuration. We use this method to validate fields where the validator package falls short.
type FilesystemConfiguration ¶
type FilesystemConfiguration struct { // File path prefix for reading/writing TSDB files FilePathPrefix *string `yaml:"filePathPrefix"` // Write buffer size WriteBufferSize *int `yaml:"writeBufferSize"` // Data read buffer size DataReadBufferSize *int `yaml:"dataReadBufferSize"` // Info metadata file read buffer size InfoReadBufferSize *int `yaml:"infoReadBufferSize"` // Seek data read buffer size SeekReadBufferSize *int `yaml:"seekReadBufferSize"` // Disk flush throughput limit in Mb/s ThroughputLimitMbps *float64 `yaml:"throughputLimitMbps"` // Disk flush throughput check interval ThroughputCheckEvery *int `yaml:"throughputCheckEvery"` // NewFileMode is the new file permissions mode to use when // creating files - specify as three digits, e.g. 666. NewFileMode *string `yaml:"newFileMode"` // NewDirectoryMode is the new file permissions mode to use when // creating directories - specify as three digits, e.g. 755. NewDirectoryMode *string `yaml:"newDirectoryMode"` // Mmap is the mmap options which features are primarily platform dependent Mmap *MmapConfiguration `yaml:"mmap"` // ForceIndexSummariesMmapMemory forces the mmap that stores the index lookup bytes // to be an anonymous region in memory as opposed to a file-based mmap. ForceIndexSummariesMmapMemory *bool `yaml:"force_index_summaries_mmap_memory"` // ForceBloomFilterMmapMemory forces the mmap that stores the index lookup bytes // to be an anonymous region in memory as opposed to a file-based mmap. ForceBloomFilterMmapMemory *bool `yaml:"force_bloom_filter_mmap_memory"` }
FilesystemConfiguration is the filesystem configuration.
func (FilesystemConfiguration) DataReadBufferSizeOrDefault ¶ added in v0.6.0
func (f FilesystemConfiguration) DataReadBufferSizeOrDefault() int
DataReadBufferSizeOrDefault returns the configured data read buffer size if configured, or a default value otherwise.
func (FilesystemConfiguration) FilePathPrefixOrDefault ¶ added in v0.6.0
func (f FilesystemConfiguration) FilePathPrefixOrDefault() string
FilePathPrefixOrDefault returns the configured file path prefix if configured, or a default value otherwise.
func (FilesystemConfiguration) ForceBloomFilterMmapMemoryOrDefault ¶ added in v0.6.0
func (f FilesystemConfiguration) ForceBloomFilterMmapMemoryOrDefault() bool
ForceBloomFilterMmapMemoryOrDefault returns the configured value for forcing the bloom filter mmaps into anonymous region in memory if configured, or a default value otherwise.
func (FilesystemConfiguration) ForceIndexSummariesMmapMemoryOrDefault ¶ added in v0.6.0
func (f FilesystemConfiguration) ForceIndexSummariesMmapMemoryOrDefault() bool
ForceIndexSummariesMmapMemoryOrDefault returns the configured value for forcing the summaries mmaps into anonymous region in memory if configured, or a default value otherwise.
func (FilesystemConfiguration) InfoReadBufferSizeOrDefault ¶ added in v0.6.0
func (f FilesystemConfiguration) InfoReadBufferSizeOrDefault() int
InfoReadBufferSizeOrDefault returns the configured info read buffer size if configured, or a default value otherwise.
func (FilesystemConfiguration) MmapConfigurationOrDefault ¶ added in v0.6.0
func (f FilesystemConfiguration) MmapConfigurationOrDefault() MmapConfiguration
MmapConfigurationOrDefault returns the configured mmap configuration if configured, or a default value otherwise.
func (FilesystemConfiguration) ParseNewDirectoryMode ¶
func (f FilesystemConfiguration) ParseNewDirectoryMode() (os.FileMode, error)
ParseNewDirectoryMode parses the specified new directory mode.
func (FilesystemConfiguration) ParseNewFileMode ¶
func (f FilesystemConfiguration) ParseNewFileMode() (os.FileMode, error)
ParseNewFileMode parses the specified new file mode.
func (FilesystemConfiguration) SeekReadBufferSizeOrDefault ¶ added in v0.6.0
func (f FilesystemConfiguration) SeekReadBufferSizeOrDefault() int
SeekReadBufferSizeOrDefault returns the configured seek read buffer size if configured, or a default value otherwise.
func (FilesystemConfiguration) ThroughputCheckEveryOrDefault ¶ added in v0.6.0
func (f FilesystemConfiguration) ThroughputCheckEveryOrDefault() int
ThroughputCheckEveryOrDefault returns the configured throughput check every value if configured, or a default value otherwise.
func (FilesystemConfiguration) ThroughputLimitMbpsOrDefault ¶ added in v0.6.0
func (f FilesystemConfiguration) ThroughputLimitMbpsOrDefault() float64
ThroughputLimitMbpsOrDefault returns the configured throughput limit mbps if configured, or a default value otherwise.
func (FilesystemConfiguration) Validate ¶ added in v0.6.0
func (f FilesystemConfiguration) Validate() error
Validate validates the Filesystem configuration. We use this method to validate fields where the validator package falls short.
func (FilesystemConfiguration) WriteBufferSizeOrDefault ¶ added in v0.6.0
func (f FilesystemConfiguration) WriteBufferSizeOrDefault() int
WriteBufferSizeOrDefault returns the configured write buffer size if configured, or a default value otherwise.
type HashingConfiguration ¶
type HashingConfiguration struct { // Murmur32 seed value. Seed uint32 `yaml:"seed"` }
HashingConfiguration is the configuration for hashing.
type IndexConfiguration ¶ added in v0.3.0
type IndexConfiguration struct { // MaxQueryIDsConcurrency controls the maximum number of outstanding QueryID // requests that can be serviced concurrently. Limiting the concurrency is // important to prevent index queries from overloading the database entirely // as they are very CPU-intensive (regex and FST matching). MaxQueryIDsConcurrency int `yaml:"maxQueryIDsConcurrency" validate:"min=0"` // ForwardIndexProbability determines the likelihood that an incoming write is // written to the next block, when arriving close to the block boundary. // // NB: this is an optimization which lessens pressure on the index around // block boundaries by eagerly writing the series to the next block // preemptively. ForwardIndexProbability float64 `yaml:"forwardIndexProbability" validate:"min=0.0,max=1.0"` // ForwardIndexThreshold determines the threshold for forward writes, as a // fraction of the given namespace's bufferFuture. // // NB: this is an optimization which lessens pressure on the index around // block boundaries by eagerly writing the series to the next block // preemptively. ForwardIndexThreshold float64 `yaml:"forwardIndexThreshold" validate:"min=0.0,max=1.0"` }
IndexConfiguration contains index-specific configuration.
type LRUSeriesCachePolicyConfiguration ¶
type LRUSeriesCachePolicyConfiguration struct { MaxBlocks uint `yaml:"maxBlocks" validate:"nonzero"` EventsChannelSize uint `yaml:"eventsChannelSize" validate:"nonzero"` }
LRUSeriesCachePolicyConfiguration contains configuration for the LRU series caching policy.
type Limits ¶ added in v0.11.0
type Limits struct { // MaxOutstandingWriteRequests controls the maximum number of outstanding write requests // that the server will allow before it begins rejecting requests. Note that this value // is independent of the number of values that are being written (due to variable batch // size from the client) but is still very useful for enforcing backpressure due to the fact // that all writes within a single RPC are single-threaded. MaxOutstandingWriteRequests int `yaml:"maxOutstandingWriteRequests" validate:"min=0"` // MaxOutstandingReadRequests controls the maximum number of outstanding read requests that // the server will allow before it begins rejecting requests. Just like MaxOutstandingWriteRequests // this value is independent of the number of time series being read. MaxOutstandingReadRequests int `yaml:"maxOutstandingReadRequests" validate:"min=0"` // MaxOutstandingRepairedBytes controls the maximum number of bytes that can be loaded into memory // as part of the repair process. For example if the value was set to 2^31 then up to 2GiB of // repaired data could be "outstanding" in memory at one time. Once that limit was hit, the repair // process would pause until some of the repaired bytes had been persisted to disk (and subsequently // evicted from memory) at which point it would resume. MaxOutstandingRepairedBytes int64 `yaml:"maxOutstandingRepairedBytes" validate:"min=0"` }
Limits contains configuration for configurable limits that can be applied to M3DB.
type MaxCapacityPoolPolicy ¶
type MaxCapacityPoolPolicy struct { CapacityPoolPolicy `yaml:",inline"` // The max capacity of items in the pool. MaxCapacity *int `yaml:"maxCapacity"` }
MaxCapacityPoolPolicy specifies a single pool policy that has a per element capacity, and a maximum allowed capacity as well.
func (*MaxCapacityPoolPolicy) MaxCapacityOrDefault ¶ added in v0.6.0
func (p *MaxCapacityPoolPolicy) MaxCapacityOrDefault() int
MaxCapacityOrDefault returns the configured maximum capacity if present, or a default value otherwise.
type MmapConfiguration ¶
type MmapConfiguration struct { // HugeTLB is the huge pages configuration which will only take affect // on platforms that support it, currently just linux HugeTLB MmapHugeTLBConfiguration `yaml:"hugeTLB"` }
MmapConfiguration is the mmap configuration.
func DefaultMmapConfiguration ¶
func DefaultMmapConfiguration() MmapConfiguration
DefaultMmapConfiguration is the default mmap configuration.
type MmapHugeTLBConfiguration ¶
type MmapHugeTLBConfiguration struct { // Enabled if true or disabled if false Enabled bool `yaml:"enabled"` // Threshold is the threshold on which to use the huge TLB flag if enabled Threshold int64 `yaml:"threshold"` }
MmapHugeTLBConfiguration is the mmap huge TLB configuration.
type MockBootstrapConfigurationValidator ¶ added in v0.9.2
type MockBootstrapConfigurationValidator struct {
// contains filtered or unexported fields
}
MockBootstrapConfigurationValidator is a mock of BootstrapConfigurationValidator interface
func NewMockBootstrapConfigurationValidator ¶ added in v0.9.2
func NewMockBootstrapConfigurationValidator(ctrl *gomock.Controller) *MockBootstrapConfigurationValidator
NewMockBootstrapConfigurationValidator creates a new mock instance
func (*MockBootstrapConfigurationValidator) EXPECT ¶ added in v0.9.2
func (m *MockBootstrapConfigurationValidator) EXPECT() *MockBootstrapConfigurationValidatorMockRecorder
EXPECT returns an object that allows the caller to indicate expected use
func (*MockBootstrapConfigurationValidator) ValidateBootstrappersOrder ¶ added in v0.9.2
func (m *MockBootstrapConfigurationValidator) ValidateBootstrappersOrder(arg0 []string) error
ValidateBootstrappersOrder mocks base method
func (*MockBootstrapConfigurationValidator) ValidateCommitLogBootstrapperOptions ¶ added in v0.9.2
func (m *MockBootstrapConfigurationValidator) ValidateCommitLogBootstrapperOptions(arg0 commitlog.Options) error
ValidateCommitLogBootstrapperOptions mocks base method
func (*MockBootstrapConfigurationValidator) ValidateFilesystemBootstrapperOptions ¶ added in v0.9.2
func (m *MockBootstrapConfigurationValidator) ValidateFilesystemBootstrapperOptions(arg0 fs.Options) error
ValidateFilesystemBootstrapperOptions mocks base method
func (*MockBootstrapConfigurationValidator) ValidatePeersBootstrapperOptions ¶ added in v0.9.2
func (m *MockBootstrapConfigurationValidator) ValidatePeersBootstrapperOptions(arg0 peers.Options) error
ValidatePeersBootstrapperOptions mocks base method
func (*MockBootstrapConfigurationValidator) ValidateUninitializedBootstrapperOptions ¶ added in v0.9.2
func (m *MockBootstrapConfigurationValidator) ValidateUninitializedBootstrapperOptions(arg0 uninitialized.Options) error
ValidateUninitializedBootstrapperOptions mocks base method
type MockBootstrapConfigurationValidatorMockRecorder ¶ added in v0.9.2
type MockBootstrapConfigurationValidatorMockRecorder struct {
// contains filtered or unexported fields
}
MockBootstrapConfigurationValidatorMockRecorder is the mock recorder for MockBootstrapConfigurationValidator
func (*MockBootstrapConfigurationValidatorMockRecorder) ValidateBootstrappersOrder ¶ added in v0.9.2
func (mr *MockBootstrapConfigurationValidatorMockRecorder) ValidateBootstrappersOrder(arg0 interface{}) *gomock.Call
ValidateBootstrappersOrder indicates an expected call of ValidateBootstrappersOrder
func (*MockBootstrapConfigurationValidatorMockRecorder) ValidateCommitLogBootstrapperOptions ¶ added in v0.9.2
func (mr *MockBootstrapConfigurationValidatorMockRecorder) ValidateCommitLogBootstrapperOptions(arg0 interface{}) *gomock.Call
ValidateCommitLogBootstrapperOptions indicates an expected call of ValidateCommitLogBootstrapperOptions
func (*MockBootstrapConfigurationValidatorMockRecorder) ValidateFilesystemBootstrapperOptions ¶ added in v0.9.2
func (mr *MockBootstrapConfigurationValidatorMockRecorder) ValidateFilesystemBootstrapperOptions(arg0 interface{}) *gomock.Call
ValidateFilesystemBootstrapperOptions indicates an expected call of ValidateFilesystemBootstrapperOptions
func (*MockBootstrapConfigurationValidatorMockRecorder) ValidatePeersBootstrapperOptions ¶ added in v0.9.2
func (mr *MockBootstrapConfigurationValidatorMockRecorder) ValidatePeersBootstrapperOptions(arg0 interface{}) *gomock.Call
ValidatePeersBootstrapperOptions indicates an expected call of ValidatePeersBootstrapperOptions
func (*MockBootstrapConfigurationValidatorMockRecorder) ValidateUninitializedBootstrapperOptions ¶ added in v0.9.2
func (mr *MockBootstrapConfigurationValidatorMockRecorder) ValidateUninitializedBootstrapperOptions(arg0 interface{}) *gomock.Call
ValidateUninitializedBootstrapperOptions indicates an expected call of ValidateUninitializedBootstrapperOptions
type NamespaceProtoSchema ¶ added in v0.9.2
type NamespaceProtoSchema struct { // For application m3db client integration test convenience (where a local dbnode is started as a docker container), // we allow loading user schema from local file into schema registry. SchemaFilePath string `yaml:"schemaFilePath"` MessageName string `yaml:"messageName"` }
NamespaceProtoSchema is the namespace protobuf schema.
func (NamespaceProtoSchema) Validate ¶ added in v0.9.2
func (c NamespaceProtoSchema) Validate() error
Validate validates the NamespaceProtoSchema.
type PoolPolicy ¶
type PoolPolicy struct { // The size of the pool. Size *int `yaml:"size"` // The low watermark to start refilling the pool, if zero none. RefillLowWaterMark *float64 `yaml:"lowWatermark"` // The high watermark to stop refilling the pool, if zero none. RefillHighWaterMark *float64 `yaml:"highWatermark"` }
PoolPolicy specifies a single pool policy.
func (*PoolPolicy) RefillHighWaterMarkOrDefault ¶ added in v0.6.0
func (p *PoolPolicy) RefillHighWaterMarkOrDefault() float64
RefillHighWaterMarkOrDefault returns the configured refill high water mark if present, or a default value otherwise.
func (*PoolPolicy) RefillLowWaterMarkOrDefault ¶ added in v0.6.0
func (p *PoolPolicy) RefillLowWaterMarkOrDefault() float64
RefillLowWaterMarkOrDefault returns the configured refill low water mark if present, or a default value otherwise.
func (*PoolPolicy) SizeOrDefault ¶ added in v0.6.0
func (p *PoolPolicy) SizeOrDefault() int
SizeOrDefault returns the configured size if present, or a default value otherwise.
type PoolingPolicy ¶
type PoolingPolicy struct { // The initial alloc size for a block. BlockAllocSize *int `yaml:"blockAllocSize"` // The thrift bytes pool max bytes slice allocation for a single binary field. ThriftBytesPoolAllocSize *int `yaml:"thriftBytesPoolAllocSize"` // The general pool type (currently only supported: simple). Type *PoolingType `yaml:"type"` // The Bytes pool buckets to use. BytesPool BucketPoolPolicy `yaml:"bytesPool"` // The policy for the Closers pool. ClosersPool PoolPolicy `yaml:"closersPool"` // The policy for the Context pool. ContextPool ContextPoolPolicy `yaml:"contextPool"` // The policy for the DatabaseSeries pool. SeriesPool PoolPolicy `yaml:"seriesPool"` // The policy for the DatabaseBlock pool. BlockPool PoolPolicy `yaml:"blockPool"` // The policy for the Encoder pool. EncoderPool PoolPolicy `yaml:"encoderPool"` // The policy for the Iterator pool. IteratorPool PoolPolicy `yaml:"iteratorPool"` // The policy for the Segment Reader pool. SegmentReaderPool PoolPolicy `yaml:"segmentReaderPool"` // The policy for the Identifier pool. IdentifierPool PoolPolicy `yaml:"identifierPool"` // The policy for the FetchBlockMetadataResult pool. FetchBlockMetadataResultsPool CapacityPoolPolicy `yaml:"fetchBlockMetadataResultsPool"` // The policy for the FetchBlocksMetadataResults pool. FetchBlocksMetadataResultsPool CapacityPoolPolicy `yaml:"fetchBlocksMetadataResultsPool"` // The policy for the ReplicaMetadataSlicePool pool. ReplicaMetadataSlicePool CapacityPoolPolicy `yaml:"replicaMetadataSlicePool"` // The policy for the BlockMetadat pool. BlockMetadataPool PoolPolicy `yaml:"blockMetadataPool"` // The policy for the BlockMetadataSlice pool. BlockMetadataSlicePool CapacityPoolPolicy `yaml:"blockMetadataSlicePool"` // The policy for the BlocksMetadata pool. BlocksMetadataPool PoolPolicy `yaml:"blocksMetadataPool"` // The policy for the BlocksMetadataSlice pool. BlocksMetadataSlicePool CapacityPoolPolicy `yaml:"blocksMetadataSlicePool"` // The policy for the tags pool. TagsPool MaxCapacityPoolPolicy `yaml:"tagsPool"` // The policy for the tags iterator pool. TagsIteratorPool PoolPolicy `yaml:"tagIteratorPool"` // The policy for the index.ResultsPool. IndexResultsPool PoolPolicy `yaml:"indexResultsPool"` // The policy for the TagEncoderPool. TagEncoderPool PoolPolicy `yaml:"tagEncoderPool"` // The policy for the TagDecoderPool. TagDecoderPool PoolPolicy `yaml:"tagDecoderPool"` // The policy for the WriteBatchPool. WriteBatchPool WriteBatchPoolPolicy `yaml:"writeBatchPool"` // The policy for the BufferBucket pool. BufferBucketPool PoolPolicy `yaml:"bufferBucketPool"` // The policy for the BufferBucketVersions pool. BufferBucketVersionsPool PoolPolicy `yaml:"bufferBucketVersionsPool"` // The policy for the PostingsListPool. PostingsListPool PoolPolicy `yaml:"postingsListPool"` }
PoolingPolicy specifies the pooling policy. To add a new pool, follow these steps:
- Add the pool to the struct below.
- Add the default values to the defaultPoolPolicies or defaultBucketPoolPolicies map.
- Add a call to initDefaultsAndValidate() for the new pool in the PoolingPolicy.InitDefaultsAndValidate() method.
func (*PoolingPolicy) BlockAllocSizeOrDefault ¶ added in v0.6.0
func (p *PoolingPolicy) BlockAllocSizeOrDefault() int
BlockAllocSizeOrDefault returns the configured block alloc size if provided, or a default value otherwise.
func (*PoolingPolicy) InitDefaultsAndValidate ¶ added in v0.6.0
func (p *PoolingPolicy) InitDefaultsAndValidate() error
InitDefaultsAndValidate initializes all default values and validates the configuration
func (*PoolingPolicy) ThriftBytesPoolAllocSizeOrDefault ¶ added in v0.11.0
func (p *PoolingPolicy) ThriftBytesPoolAllocSizeOrDefault() int
ThriftBytesPoolAllocSizeOrDefault returns the configured thrift bytes pool max alloc size if provided, or a default value otherwise.
func (*PoolingPolicy) TypeOrDefault ¶ added in v0.6.0
func (p *PoolingPolicy) TypeOrDefault() PoolingType
TypeOrDefault returns the configured pooling type if provided, or a default value otherwise.
type PoolingType ¶
type PoolingType string
PoolingType is a type of pooling, using runtime or mmap'd bytes pooling.
const ( // SimplePooling uses the basic Go runtime to allocate bytes for bytes pools. SimplePooling PoolingType = "simple" )
type PostingsListCacheConfiguration ¶ added in v0.6.0
type PostingsListCacheConfiguration struct { Size *int `yaml:"size"` CacheRegexp *bool `yaml:"cacheRegexp"` CacheTerms *bool `yaml:"cacheTerms"` }
PostingsListCacheConfiguration is the postings list cache configuration.
func (*PostingsListCacheConfiguration) CacheRegexpOrDefault ¶ added in v0.6.0
func (p *PostingsListCacheConfiguration) CacheRegexpOrDefault() bool
CacheRegexpOrDefault returns the provided cache regexp configuration value or the default value is none is provided.
func (*PostingsListCacheConfiguration) CacheTermsOrDefault ¶ added in v0.6.0
func (p *PostingsListCacheConfiguration) CacheTermsOrDefault() bool
CacheTermsOrDefault returns the provided cache terms configuration value or the default value is none is provided.
func (*PostingsListCacheConfiguration) SizeOrDefault ¶ added in v0.6.0
func (p *PostingsListCacheConfiguration) SizeOrDefault() int
SizeOrDefault returns the provided size or the default value is none is provided.
type ProtoConfiguration ¶ added in v0.8.2
type ProtoConfiguration struct { // Enabled specifies whether proto is enabled. Enabled bool `yaml:"enabled"` SchemaRegistry map[string]NamespaceProtoSchema `yaml:"schema_registry"` }
ProtoConfiguration is the configuration for running with ProtoDataMode enabled.
func (*ProtoConfiguration) Validate ¶ added in v0.8.2
func (c *ProtoConfiguration) Validate() error
Validate validates the ProtoConfiguration.
type RepairPolicy ¶
type RepairPolicy struct { // Enabled or disabled. Enabled bool `yaml:"enabled"` // The repair throttle. Throttle time.Duration `yaml:"throttle"` // The repair check interval. CheckInterval time.Duration `yaml:"checkInterval"` // Whether debug shadow comparisons are enabled. DebugShadowComparisonsEnabled bool `yaml:"debugShadowComparisonsEnabled"` // If enabled, what percentage of metadata should perform a detailed debug // shadow comparison. DebugShadowComparisonsPercentage float64 `yaml:"debugShadowComparisonsPercentage"` }
RepairPolicy is the repair policy.
type ReplicatedCluster ¶ added in v0.11.0
type ReplicatedCluster struct { Name string `yaml:"name"` RepairEnabled bool `yaml:"repairEnabled"` Client *client.Configuration `yaml:"client"` }
ReplicatedCluster defines a cluster to replicate data from.
func (*ReplicatedCluster) Validate ¶ added in v0.11.0
func (r *ReplicatedCluster) Validate() error
Validate validates the configuration for a replicated cluster.
type ReplicationPolicy ¶ added in v0.11.0
type ReplicationPolicy struct {
Clusters []ReplicatedCluster `yaml:"clusters"`
}
ReplicationPolicy is the replication policy.
func (*ReplicationPolicy) Validate ¶ added in v0.11.0
func (r *ReplicationPolicy) Validate() error
Validate validates the replication policy.
type SeriesCacheConfiguration ¶
type SeriesCacheConfiguration struct { Policy series.CachePolicy `yaml:"policy"` LRU *LRUSeriesCachePolicyConfiguration `yaml:"lru"` }
SeriesCacheConfiguration is the series cache configuration.
type TickConfiguration ¶
type TickConfiguration struct { // Tick series batch size is the batch size to process series together // during a tick before yielding and sleeping the per series duration // multiplied by the batch size. // The higher this value is the more variable CPU utilization will be // but the shorter ticks will ultimately be. SeriesBatchSize int `yaml:"seriesBatchSize"` // Tick per series sleep at the completion of a tick batch. PerSeriesSleepDuration time.Duration `yaml:"perSeriesSleepDuration"` // Tick minimum interval controls the minimum tick interval for the node. MinimumInterval time.Duration `yaml:"minimumInterval"` }
TickConfiguration is the tick configuration for background processing of series as blocks are rotated from mutable to immutable and out of order writes are merged.
type TransformConfiguration ¶ added in v0.9.0
type TransformConfiguration struct { // TruncateBy determines what type of truncatation is applied to incoming // writes. TruncateBy series.TruncateType `yaml:"truncateBy"` // ForcedValue determines what to set all incoming write values to. ForcedValue *float64 `yaml:"forceValue"` }
TransformConfiguration contains configuration options that can transform incoming writes.
func (*TransformConfiguration) Validate ¶ added in v0.9.0
func (c *TransformConfiguration) Validate() error
Validate validates the transform configuration.
type WriteBatchPoolPolicy ¶ added in v0.4.8
type WriteBatchPoolPolicy struct { // The size of the pool. Size *int `yaml:"size"` // InitialBatchSize controls the initial batch size for each WriteBatch when // the pool is being constructed / refilled. InitialBatchSize *int `yaml:"initialBatchSize"` // MaxBatchSize controls the maximum size that a pooled WriteBatch can grow to // and still remain in the pool. MaxBatchSize *int `yaml:"maxBatchSize"` }
WriteBatchPoolPolicy specifies the pooling policy for the WriteBatch pool.