-
Notifications
You must be signed in to change notification settings - Fork 451
/
types.go
207 lines (172 loc) · 9.9 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
// Copyright (c) 2017 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
package runtime
import (
"time"
"github.com/m3db/m3/src/dbnode/ratelimit"
"github.com/m3db/m3/src/dbnode/topology"
xclose "github.com/m3db/m3/src/x/close"
)
// Options is a set of runtime options.
type Options interface {
// Validate will validate the runtime options are valid.
Validate() error
// SetPersistRateLimitOptions sets the persist rate limit options
SetPersistRateLimitOptions(value ratelimit.Options) Options
// PersistRateLimitOptions returns the persist rate limit options
PersistRateLimitOptions() ratelimit.Options
// SetWriteNewSeriesAsync sets whether to write new series asynchronously or not,
// when true this essentially makes writes for new series eventually consistent
// as after a write is finished you are not guaranteed to read it back immediately
// due to inserts into the shard map being buffered. The write is however written
// to the commit log before completing so it is considered durable.
SetWriteNewSeriesAsync(value bool) Options
// WriteNewSeriesAsync returns whether to write new series asynchronously or not,
// when true this essentially makes writes for new series eventually consistent
// as after a write is finished you are not guaranteed to read it back immediately
// due to inserts into the shard map being buffered. The write is however written
// to the commit log before completing so it is considered durable.
WriteNewSeriesAsync() bool
// SetWriteNewSeriesBackoffDuration sets the insert backoff duration during
// periods of heavy insertions, this backoff helps gather larger batches
// to insert into a shard in a single batch requiring far less write lock
// acquisitions.
SetWriteNewSeriesBackoffDuration(value time.Duration) Options
// WriteNewSeriesBackoffDuration returns the insert backoff duration during
// periods of heavy insertions, this backoff helps gather larger batches
// to insert into a shard in a single batch requiring far less write lock
// acquisitions.
WriteNewSeriesBackoffDuration() time.Duration
// SetWriteNewSeriesLimitPerShardPerSecond sets the insert rate limit per second,
// setting to zero disables any rate limit for new series insertions. This rate
// limit is primarily offered to defend against unintentional bursts of new
// time series being inserted.
SetWriteNewSeriesLimitPerShardPerSecond(value int) Options
// WriteNewSeriesLimitPerShardPerSecond returns the insert rate limit per second,
// setting to zero disables any rate limit for new series insertions. This rate
// limit is primarily offered to defend against unintentional bursts of new
// time series being inserted.
WriteNewSeriesLimitPerShardPerSecond() int
// SetTickSeriesBatchSize sets 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.
SetTickSeriesBatchSize(value int) Options
// TickSeriesBatchSize returns 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.
TickSeriesBatchSize() int
// SetTickPerSeriesSleepDuration sets the tick sleep per series value that
// provides a constant duration to sleep per series at the end of processing
// a batch of series during a background tick, this can directly effect how
// fast a block is persisted after is rotated from the mutable series buffer
// to a series block (since all series need to be merged/processed before a
// persist can occur).
SetTickPerSeriesSleepDuration(value time.Duration) Options
// TickPerSeriesSleepDuration returns the tick sleep per series value that
// provides a constant duration to sleep per series at the end of processing
// a batch of series during a background tick, this can directly effect how
// fast a block is persisted after is rotated from the mutable series buffer
// to a series block (since all series need to be merged/processed before a
// persist can occur).
TickPerSeriesSleepDuration() time.Duration
// SetTickMinimumInterval sets the minimum tick interval to run ticks, this
// helps throttle the tick when the amount of series is low and the sleeps
// on a per series basis is short.
SetTickMinimumInterval(value time.Duration) Options
// TickMinimumInterval returns the minimum tick interval to run ticks, this
// helps throttle the tick when the amount of series is low and the sleeps
// on a per series basis is short.
TickMinimumInterval() time.Duration
// SetMaxWiredBlocks sets the max blocks to keep wired; zero is used
// to specify no limit. Wired blocks that are in the buffer, I.E are
// being written to, cannot be unwired. Similarly, blocks which have
// just been rotated out of the buffer but have not been flushed yet
// can also not be unwired. This means that the limit is best effort.
SetMaxWiredBlocks(value uint) Options
// MaxWiredBlocks returns the max blocks to keep wired, zero is used
// to specify no limit. Wired blocks that are in the buffer, I.E are
// being written to, cannot be unwired. Similarly, blocks which have
// just been rotated out of the buffer but have not been flushed yet
// can also not be unwired. This means that the limit is best effort.
MaxWiredBlocks() uint
// SetClientBootstrapConsistencyLevel sets the client bootstrap
// consistency level used when bootstrapping from peers. Setting this
// will take effect immediately, and as such can be used to finish a
// bootstrap in an unhealthy cluster to recover read capability by setting
// this value to ReadConsistencyLevelNone.
SetClientBootstrapConsistencyLevel(value topology.ReadConsistencyLevel) Options
// ClientBootstrapConsistencyLevel returns the client bootstrap
// consistency level used when bootstrapping from peers. Setting this
// will take effect immediately, and as such can be used to finish a
// bootstrap in an unhealthy cluster to recover read capability by setting
// this value to ReadConsistencyLevelNone.
ClientBootstrapConsistencyLevel() topology.ReadConsistencyLevel
// SetClientReadConsistencyLevel sets the client read consistency level
// used when fetching data from peers for coordinated reads
SetClientReadConsistencyLevel(value topology.ReadConsistencyLevel) Options
// ClientReadConsistencyLevel returns the client read consistency level
// used when fetching data from peers for coordinated reads
ClientReadConsistencyLevel() topology.ReadConsistencyLevel
// SetClientWriteConsistencyLevel sets the client write consistency level
// used when fetching data from peers for coordinated writes
SetClientWriteConsistencyLevel(value topology.ConsistencyLevel) Options
// ClientWriteConsistencyLevel returns the client write consistency level
// used when fetching data from peers for coordinated writes
ClientWriteConsistencyLevel() topology.ConsistencyLevel
// SetIndexDefaultQueryTimeout is the hard timeout value to use if none is
// specified for a specific query, zero specifies to use no timeout at all.
SetIndexDefaultQueryTimeout(value time.Duration) Options
// IndexDefaultQueryTimeout is the hard timeout value to use if none is
// specified for a specific query, zero specifies to use no timeout at all.
IndexDefaultQueryTimeout() time.Duration
// SetFlushIndexBlockNumSegments sets the number of index block segments to
// divide into and flush separately to disk, the bigger the number the
// greater amount of segments that need to be searched independently but
// a higher number reduces the memory pressure when flushing an index block.
SetFlushIndexBlockNumSegments(value uint) Options
// FlushIndexBlockNumSegments sets the number of index block segments to
// divide into and flush separately to disk, the bigger the number the
// greater amount of segments that need to be searched independently but
// a higher number reduces the memory pressure when flushing an index block.
FlushIndexBlockNumSegments() uint
}
// OptionsManager updates and supplies runtime options.
type OptionsManager interface {
// Update updates the current runtime options.
Update(value Options) error
// Get returns the current values.
Get() Options
// RegisterListener registers a listener for updates to runtime options,
// it will synchronously call back the listener when this method is called
// to deliver the current set of runtime options.
RegisterListener(l OptionsListener) xclose.SimpleCloser
// Close closes the watcher and all descendent watches.
Close()
}
// OptionsListener listens for updates to runtime options.
type OptionsListener interface {
// SetRuntimeOptions is called when the listener is registered
// and when any updates occurred passing the new runtime options.
SetRuntimeOptions(value Options)
}