-
Notifications
You must be signed in to change notification settings - Fork 451
/
types.go
415 lines (327 loc) · 13 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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
// Copyright (c) 2016 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 repair
import (
"fmt"
"time"
"github.com/m3db/m3/src/dbnode/client"
"github.com/m3db/m3/src/dbnode/storage/block"
"github.com/m3db/m3/src/dbnode/storage/bootstrap/result"
"github.com/m3db/m3/src/dbnode/topology"
"github.com/m3db/m3/src/x/ident"
xtime "github.com/m3db/m3/src/x/time"
)
// Type defines the type of repair to run.
type Type uint
const (
// DefaultRepair will compare node's integrity to other replicas and then repair blocks as required.
DefaultRepair Type = iota
// OnlyCompareRepair will compare node's integrity to other replicas without repairing blocks,
// this is useful for looking at the metrics emitted by the comparison.
OnlyCompareRepair
)
var validTypes = []Type{
DefaultRepair,
OnlyCompareRepair,
}
// MarshalYAML returns the YAML representation of the repair type.
func (t Type) MarshalYAML() (interface{}, error) {
return t.String(), nil
}
// UnmarshalYAML unmarshals an Type into a valid type from string.
func (t *Type) UnmarshalYAML(unmarshal func(interface{}) error) error {
var str string
if err := unmarshal(&str); err != nil {
return err
}
// If unspecified, use default mode.
if str == "" {
*t = DefaultRepair
return nil
}
for _, valid := range validTypes {
if str == valid.String() {
*t = valid
return nil
}
}
return fmt.Errorf("invalid repair Type '%s' valid types are: %s",
str, validTypes)
}
// String returns the bootstrap mode as a string
func (t Type) String() string {
switch t {
case DefaultRepair:
return "default"
case OnlyCompareRepair:
return "only_compare"
default:
return "unknown"
}
}
// Strategy defines the repair strategy.
type Strategy uint
const (
// DefaultStrategy will compare iterating backwards then on repairing a
// block needing repair it will restart from the latest block start and
// work backwards again.
// This strategy is best at keeping most recent data repaired as quickly
// as possible but when turning on repair for the first time in a cluster
// you may want to do run repairs in full sweep for a while first.
DefaultStrategy Strategy = iota
// FullSweepStrategy will compare iterating backwards and repairing
// blocks needing repair until reaching the end of retention and then only
// once reaching the end of retention to repair does the repair restart
// evaluating blocks from the most recent block starts again.
// This mode may be more ideal in clusters that have never had repair
// enabled to ensure that historical data gets repaired at least once on
// a full sweep before switching back to the default strategy.
FullSweepStrategy
)
var validStrategies = []Strategy{
DefaultStrategy,
FullSweepStrategy,
}
// MarshalYAML returns the YAML representation of the repair strategy.
func (t Strategy) MarshalYAML() (interface{}, error) {
return t.String(), nil
}
// UnmarshalYAML unmarshals an Type into a valid type from string.
func (t *Strategy) UnmarshalYAML(unmarshal func(interface{}) error) error {
var str string
if err := unmarshal(&str); err != nil {
return err
}
// If unspecified, use default mode.
if str == "" {
*t = DefaultStrategy
return nil
}
for _, valid := range validStrategies {
if str == valid.String() {
*t = valid
return nil
}
}
return fmt.Errorf("invalid repair Strategy '%s' valid types are: %s",
str, validStrategies)
}
// String returns the bootstrap mode as a string
func (t Strategy) String() string {
switch t {
case DefaultStrategy:
return "default"
case FullSweepStrategy:
return "full_sweep"
default:
return "unknown"
}
}
// ReplicaMetadataSlice captures a slice of block.ReplicaMetadata.
type ReplicaMetadataSlice interface {
// Add adds the metadata to the slice.
Add(metadata block.ReplicaMetadata)
// Metadata returns the metadata slice.
Metadata() []block.ReplicaMetadata
// Reset resets the metadata slice.
Reset()
// Close performs cleanup.
Close()
}
// ReplicaMetadataSlicePool provides a pool for block.ReplicaMetadata slices.
type ReplicaMetadataSlicePool interface {
// Get returns a ReplicaMetadata slice.
Get() ReplicaMetadataSlice
// Put puts a ReplicaMetadata slice back to pool.
Put(m ReplicaMetadataSlice)
}
// ReplicaBlockMetadata captures the block metadata from hosts in a shard replica set.
type ReplicaBlockMetadata interface {
// Start is the start time of a block.
Start() xtime.UnixNano
// Metadata returns the metadata from all hosts.
Metadata() []block.ReplicaMetadata
// Add adds a metadata from a host.
Add(metadata block.ReplicaMetadata)
// Close performs cleanup.
Close()
}
// ReplicaBlocksMetadata captures the blocks metadata from hosts in a shard replica set.
type ReplicaBlocksMetadata interface {
// NumBlocks returns the total number of blocks.
NumBlocks() int64
// Blocks returns the blocks metadata.
Blocks() map[xtime.UnixNano]ReplicaBlockMetadata
// Add adds a block metadata.
Add(block ReplicaBlockMetadata)
// GetOrAdd returns the blocks metadata for a start time, creating one if it doesn't exist.
GetOrAdd(start xtime.UnixNano, p ReplicaMetadataSlicePool) ReplicaBlockMetadata
// Close performs cleanup.
Close()
}
// ReplicaSeriesMetadata captures the metadata for a list of series from hosts
// in a shard replica set.
type ReplicaSeriesMetadata interface {
// NumSeries returns the total number of series.
NumSeries() int64
// NumBlocks returns the total number of blocks.
NumBlocks() int64
// Series returns the series metadata.
Series() *Map
// GetOrAdd returns the series metadata for an id, creating one if it doesn't exist.
GetOrAdd(id ident.ID) ReplicaBlocksMetadata
// Close performs cleanup.
Close()
}
// ReplicaSeriesBlocksMetadata represents series metadata and an associated ID.
type ReplicaSeriesBlocksMetadata struct {
ID ident.ID
Metadata ReplicaBlocksMetadata
}
// ReplicaMetadataComparer compares metadata from hosts in a replica set.
type ReplicaMetadataComparer interface {
// AddLocalMetadata adds metadata from local host.
AddLocalMetadata(localIter block.FilteredBlocksMetadataIter) error
// AddPeerMetadata adds metadata from peers.
AddPeerMetadata(peerIter client.PeerBlockMetadataIter) error
// Compare returns the metadata differences between local host and peers.
Compare() MetadataComparisonResult
// Finalize performs cleanup during close.
Finalize()
}
// MetadataComparisonResult captures metadata comparison results.
type MetadataComparisonResult struct {
// NumSeries returns the total number of series.
NumSeries int64
// NumBlocks returns the total number of blocks.
NumBlocks int64
// SizeResult returns the size differences.
SizeDifferences ReplicaSeriesMetadata
// ChecksumDifferences returns the checksum differences.
ChecksumDifferences ReplicaSeriesMetadata
// PeerMetadataComparisonResults the results comparative to each peer.
PeerMetadataComparisonResults PeerMetadataComparisonResults
}
// PeerMetadataComparisonResult captures metadata comparison results
// relative to the local origin node.
type PeerMetadataComparisonResult struct {
// ID is the peer ID.
ID string
// ComparedBlocks returns the total number of blocks.
ComparedBlocks int64
// ComparedDifferingBlocks returns the number of differing blocks (mismatch + missing + extra).
ComparedDifferingBlocks int64
// ComparedMismatchBlocks returns the number of mismatching blocks (either size or checksum).
ComparedMismatchBlocks int64
// ComparedMissingBlocks returns the number of missing blocks.
ComparedMissingBlocks int64
// ComparedExtraBlocks returns the number of extra blocks.
ComparedExtraBlocks int64
}
// PeerMetadataComparisonResults is a slice of PeerMetadataComparisonResult.
type PeerMetadataComparisonResults []PeerMetadataComparisonResult
// Aggregate returns an aggregate result of the PeerMetadataComparisonResults.
func (r PeerMetadataComparisonResults) Aggregate() AggregatePeerMetadataComparisonResult {
var result AggregatePeerMetadataComparisonResult
for _, elem := range r {
result.ComparedBlocks += elem.ComparedBlocks
result.ComparedDifferingBlocks += elem.ComparedDifferingBlocks
result.ComparedMismatchBlocks += elem.ComparedMismatchBlocks
result.ComparedMissingBlocks += elem.ComparedMissingBlocks
result.ComparedExtraBlocks += elem.ComparedExtraBlocks
}
if result.ComparedBlocks <= 0 {
// Do not divide by zero and end up with a struct that cannot be JSON serialized.
return result
}
result.ComparedDifferingPercent = float64(result.ComparedDifferingBlocks) / float64(result.ComparedBlocks)
return result
}
// AggregatePeerMetadataComparisonResult captures an aggregate metadata comparison
// result of all peers relative to the local origin node.
type AggregatePeerMetadataComparisonResult struct {
// ComparedDifferingPercent is the percent of blocks that mismatched from peers to local origin.
ComparedDifferingPercent float64
// ComparedBlocks returns the total number of blocks compared.
ComparedBlocks int64
// ComparedDifferingBlocks returns the number of differing blocks (mismatch + missing + extra).
ComparedDifferingBlocks int64
// ComparedMismatchBlocks returns the number of mismatching blocks (either size or checksum).
ComparedMismatchBlocks int64
// ComparedMissingBlocks returns the number of missing blocks.
ComparedMissingBlocks int64
// ComparedExtraBlocks returns the number of extra blocks.
ComparedExtraBlocks int64
}
// Options are the repair options.
type Options interface {
// SetType sets the type of repair to run.
SetType(value Type) Options
// Type returns the type of repair to run.
Type() Type
// SetStrategy sets the repair strategy.
SetStrategy(value Strategy) Options
// Strategy returns the repair strategy.
Strategy() Strategy
// SetForce sets whether to force repairs to run for all namespaces.
SetForce(value bool) Options
// Force returns whether to force repairs to run for all namespaces.
Force() bool
// SetAdminClient sets the admin client.
SetAdminClients(value []client.AdminClient) Options
// AdminClient returns the admin client.
AdminClients() []client.AdminClient
// SetRepairConsistencyLevel sets the repair read level consistency
// for which to repair shards with.
SetRepairConsistencyLevel(value topology.ReadConsistencyLevel) Options
// RepairConsistencyLevel returns the repair read level consistency
// for which to repair shards with.
RepairConsistencyLevel() topology.ReadConsistencyLevel
// SetRepairShardConcurrency sets the concurrency in which to repair shards with.
SetRepairShardConcurrency(value int) Options
// RepairShardConcurrency returns the concurrency in which to repair shards with.
RepairShardConcurrency() int
// SetRepairCheckInterval sets the repair check interval.
SetRepairCheckInterval(value time.Duration) Options
// RepairCheckInterval returns the repair check interval.
RepairCheckInterval() time.Duration
// SetRepairThrottle sets the repair throttle.
SetRepairThrottle(value time.Duration) Options
// RepairThrottle returns the repair throttle.
RepairThrottle() time.Duration
// SetReplicaMetadataSlicePool sets the replicaMetadataSlice pool.
SetReplicaMetadataSlicePool(value ReplicaMetadataSlicePool) Options
// ReplicaMetadataSlicePool returns the replicaMetadataSlice pool.
ReplicaMetadataSlicePool() ReplicaMetadataSlicePool
// SetResultOptions sets the result options.
SetResultOptions(value result.Options) Options
// ResultOptions returns the result options.
ResultOptions() result.Options
// SetDebugShadowComparisonsEnabled sets whether debug shadow comparisons are enabled.
SetDebugShadowComparisonsEnabled(value bool) Options
// DebugShadowComparisonsEnabled returns whether debug shadow comparisons are enabled.
DebugShadowComparisonsEnabled() bool
// SetDebugShadowComparisonsPercentage sets the debug shadow comparisons percentage.
SetDebugShadowComparisonsPercentage(value float64) Options
// DebugShadowComparisonsPercentage returns the debug shadow comparisons percentage.
DebugShadowComparisonsPercentage() float64
// Validate checks if the options are valid.
Validate() error
}