-
Notifications
You must be signed in to change notification settings - Fork 397
/
service.go
619 lines (518 loc) · 17.5 KB
/
service.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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
// Copyright (C) 2022 Storj Labs, Inc.
// See LICENSE for copying information.
package main
import (
"context"
"errors"
"fmt"
"io"
"os"
"strings"
"sync/atomic"
"time"
"github.com/spacemonkeygo/monkit/v3"
"github.com/zeebo/errs"
"go.uber.org/zap"
"storj.io/common/storj"
"storj.io/common/uuid"
"storj.io/storj/satellite/audit"
"storj.io/storj/satellite/metabase"
"storj.io/storj/satellite/overlay"
)
var mon = monkit.Package()
// Error is global error class.
var Error = errs.Class("segment-verify")
// Metabase defines implementation dependencies we need from metabase.
type Metabase interface {
LatestNodesAliasMap(ctx context.Context) (*metabase.NodeAliasMap, error)
GetSegmentByPosition(ctx context.Context, opts metabase.GetSegmentByPosition) (segment metabase.Segment, err error)
ListVerifySegments(ctx context.Context, opts metabase.ListVerifySegments) (result metabase.ListVerifySegmentsResult, err error)
ListBucketsStreamIDs(ctx context.Context, opts metabase.ListBucketsStreamIDs) (result metabase.ListBucketsStreamIDsResult, err error)
}
// Verifier verifies a batch of segments.
type Verifier interface {
Verify(ctx context.Context, nodeAlias metabase.NodeAlias, target storj.NodeURL, targetVersion string, segments []*Segment, ignoreThrottle bool) (verifiedCount int, err error)
}
// Overlay is used to fetch information about nodes.
type Overlay interface {
// Get looks up the node by nodeID
Get(ctx context.Context, nodeID storj.NodeID) (*overlay.NodeDossier, error)
SelectAllStorageNodesDownload(ctx context.Context, onlineWindow time.Duration, asOf overlay.AsOfSystemTimeConfig) ([]*overlay.SelectedNode, error)
}
// SegmentWriter allows writing segments to some output.
type SegmentWriter interface {
Write(ctx context.Context, segments []*Segment) error
Close() error
}
// ServiceConfig contains configurable options for Service.
type ServiceConfig struct {
NotFoundPath string `help:"segments not found on storage nodes" default:"segments-not-found.csv"`
RetryPath string `help:"segments unable to check against satellite" default:"segments-retry.csv"`
ProblemPiecesPath string `help:"pieces that could not be fetched successfully" default:"problem-pieces.csv"`
PriorityNodesPath string `help:"list of priority node ID-s" default:""`
IgnoreNodesPath string `help:"list of nodes to ignore" default:""`
Check int `help:"how many storagenodes to query per segment (if 0, query all)" default:"3"`
BatchSize int `help:"number of segments to process per batch" default:"10000"`
Concurrency int `help:"number of concurrent verifiers" default:"1000"`
MaxOffline int `help:"maximum number of offline in a sequence (if 0, no limit)" default:"2"`
OfflineStatusCacheTime time.Duration `help:"how long to cache a \"node offline\" status" default:"30m"`
AsOfSystemInterval time.Duration `help:"as of system interval" releaseDefault:"-5m" devDefault:"-1us" testDefault:"-1us"`
}
type pieceReporterFunc func(
ctx context.Context,
segment *metabase.VerifySegment,
nodeID storj.NodeID,
pieceNum int,
outcome audit.Outcome) error
// Service implements segment verification logic.
type Service struct {
log *zap.Logger
config ServiceConfig
notFound SegmentWriter
retry SegmentWriter
problemPieces *pieceCSVWriter
metabase Metabase
verifier Verifier
overlay Overlay
aliasMap *metabase.NodeAliasMap
aliasToNodeURL map[metabase.NodeAlias]storj.NodeURL
priorityNodes NodeAliasSet
ignoreNodes NodeAliasSet
offlineNodes *nodeAliasExpiringSet
offlineCount map[metabase.NodeAlias]int
bucketList BucketList
nodesVersionMap map[metabase.NodeAlias]string
}
// NewService returns a new service for verifying segments.
func NewService(log *zap.Logger, metabaseDB Metabase, verifier Verifier, overlay Overlay, config ServiceConfig) (*Service, error) {
notFound, err := NewCSVWriter(config.NotFoundPath)
if err != nil {
return nil, Error.Wrap(err)
}
retry, err := NewCSVWriter(config.RetryPath)
if err != nil {
return nil, errs.Combine(Error.Wrap(err), notFound.Close())
}
problemPieces, err := newPieceCSVWriter(config.ProblemPiecesPath)
if err != nil {
return nil, errs.Combine(Error.Wrap(err), retry.Close(), notFound.Close())
}
return &Service{
log: log,
config: config,
notFound: notFound,
retry: retry,
problemPieces: problemPieces,
metabase: metabaseDB,
verifier: verifier,
overlay: overlay,
aliasToNodeURL: map[metabase.NodeAlias]storj.NodeURL{},
priorityNodes: NodeAliasSet{},
ignoreNodes: NodeAliasSet{},
offlineNodes: newNodeAliasExpiringSet(config.OfflineStatusCacheTime),
offlineCount: map[metabase.NodeAlias]int{},
nodesVersionMap: map[metabase.NodeAlias]string{},
}, nil
}
// Close closes the outputs from the service.
func (service *Service) Close() error {
return Error.Wrap(errs.Combine(
service.notFound.Close(),
service.retry.Close(),
service.problemPieces.Close(),
))
}
// loadOnlineNodes loads the list of online nodes.
func (service *Service) loadOnlineNodes(ctx context.Context) (err error) {
interval := overlay.AsOfSystemTimeConfig{
Enabled: service.config.AsOfSystemInterval != 0,
DefaultInterval: service.config.AsOfSystemInterval,
}
// should this use some other methods?
nodes, err := service.overlay.SelectAllStorageNodesDownload(ctx, time.Hour, interval)
if err != nil {
return Error.Wrap(err)
}
for _, node := range nodes {
alias, ok := service.aliasMap.Alias(node.ID)
if !ok {
// This means the node does not hold any data in metabase.
continue
}
addr := node.Address.Address
if node.LastIPPort != "" {
addr = node.LastIPPort
}
service.aliasToNodeURL[alias] = storj.NodeURL{
ID: node.ID,
Address: addr,
}
}
return nil
}
// loadPriorityNodes loads the list of priority nodes.
func (service *Service) loadPriorityNodes(ctx context.Context) (err error) {
if service.config.PriorityNodesPath == "" {
return nil
}
service.priorityNodes, err = service.parseNodeFile(service.config.PriorityNodesPath)
return Error.Wrap(err)
}
// applyIgnoreNodes loads the list of nodes to ignore completely and modifies priority nodes.
func (service *Service) applyIgnoreNodes(ctx context.Context) (err error) {
if service.config.IgnoreNodesPath == "" {
return nil
}
service.ignoreNodes, err = service.parseNodeFile(service.config.IgnoreNodesPath)
if err != nil {
return Error.Wrap(err)
}
service.priorityNodes.RemoveAll(service.ignoreNodes)
return nil
}
// parseNodeFile parses a file containing node ID-s.
func (service *Service) parseNodeFile(path string) (NodeAliasSet, error) {
set := NodeAliasSet{}
data, err := os.ReadFile(path)
if err != nil {
return set, Error.New("unable to read nodes file: %w", err)
}
for _, line := range strings.Split(string(data), "\n") {
line = strings.TrimSpace(line)
if line == "" || strings.HasPrefix(line, "#") {
continue
}
nodeID, err := storj.NodeIDFromString(line)
if err != nil {
return set, Error.Wrap(err)
}
alias, ok := service.aliasMap.Alias(nodeID)
if !ok {
service.log.Info("node ID not used", zap.Stringer("node id", nodeID), zap.Error(err))
continue
}
set.Add(alias)
}
return set, nil
}
// BucketList contains a list of buckets to check segments from.
type BucketList struct {
Buckets []metabase.BucketLocation
}
// Add adds a bucket to the bucket list.
func (list *BucketList) Add(projectID uuid.UUID, bucketName string) {
list.Buckets = append(list.Buckets, metabase.BucketLocation{
ProjectID: projectID,
BucketName: bucketName,
})
}
// ProcessRange processes segments between low and high uuid.UUID with the specified batchSize.
func (service *Service) ProcessRange(ctx context.Context, low, high uuid.UUID) (err error) {
defer mon.Task()(&ctx)(&err)
aliasMap, err := service.metabase.LatestNodesAliasMap(ctx)
if err != nil {
return Error.Wrap(err)
}
service.aliasMap = aliasMap
err = service.loadOnlineNodes(ctx)
if err != nil {
return Error.Wrap(err)
}
err = service.loadPriorityNodes(ctx)
if err != nil {
return Error.Wrap(err)
}
err = service.applyIgnoreNodes(ctx)
if err != nil {
return Error.Wrap(err)
}
cursorStreamID := low
var cursorPosition metabase.SegmentPosition
if !low.IsZero() {
cursorStreamID = uuidBefore(low)
cursorPosition = metabase.SegmentPosition{Part: 0xFFFFFFFF, Index: 0xFFFFFFFF}
}
var progress int64
for {
result, err := service.metabase.ListVerifySegments(ctx, metabase.ListVerifySegments{
CursorStreamID: cursorStreamID,
CursorPosition: cursorPosition,
Limit: service.config.BatchSize,
AsOfSystemInterval: service.config.AsOfSystemInterval,
})
if err != nil {
return Error.Wrap(err)
}
verifySegments := result.Segments
result.Segments = nil
// drop any segment that's equal or beyond "high".
for len(verifySegments) > 0 && !verifySegments[len(verifySegments)-1].StreamID.Less(high) {
verifySegments = verifySegments[:len(verifySegments)-1]
}
// All done?
if len(verifySegments) == 0 {
return nil
}
last := &verifySegments[len(verifySegments)-1]
cursorStreamID, cursorPosition = last.StreamID, last.Position
// Convert to struct that contains the status.
segmentsData := make([]Segment, len(verifySegments))
segments := make([]*Segment, len(verifySegments))
for i := range segments {
segmentsData[i].VerifySegment = verifySegments[i]
segments[i] = &segmentsData[i]
}
service.log.Info("processing segments",
zap.Int64("progress", progress),
zap.Int("count", len(segments)),
zap.Stringer("first", segments[0].StreamID),
zap.Stringer("last", segments[len(segments)-1].StreamID),
)
progress += int64(len(segments))
// Process the data.
err = service.ProcessSegments(ctx, segments)
if err != nil {
return Error.Wrap(err)
}
}
}
// ProcessBuckets processes segments in buckets with the specified batchSize.
func (service *Service) ProcessBuckets(ctx context.Context, buckets []metabase.BucketLocation) (err error) {
defer mon.Task()(&ctx)(&err)
aliasMap, err := service.metabase.LatestNodesAliasMap(ctx)
if err != nil {
return Error.Wrap(err)
}
service.aliasMap = aliasMap
err = service.loadOnlineNodes(ctx)
if err != nil {
return Error.Wrap(err)
}
err = service.loadPriorityNodes(ctx)
if err != nil {
return Error.Wrap(err)
}
err = service.applyIgnoreNodes(ctx)
if err != nil {
return Error.Wrap(err)
}
var progress int64
cursorBucket := metabase.BucketLocation{}
cursorStreamID := uuid.UUID{}
cursorPosition := metabase.SegmentPosition{} // Convert to struct that contains the status.
segmentsData := make([]Segment, service.config.BatchSize)
segments := make([]*Segment, service.config.BatchSize)
for {
listStreamIDsResult, err := service.metabase.ListBucketsStreamIDs(ctx, metabase.ListBucketsStreamIDs{
BucketList: metabase.ListVerifyBucketList{
Buckets: service.bucketList.Buckets,
},
CursorBucket: cursorBucket,
CursorStreamID: cursorStreamID,
Limit: service.config.BatchSize,
AsOfSystemInterval: service.config.AsOfSystemInterval,
})
if err != nil {
return Error.Wrap(err)
}
for {
// TODO loop for this
result, err := service.metabase.ListVerifySegments(ctx, metabase.ListVerifySegments{
StreamIDs: listStreamIDsResult.StreamIDs,
CursorStreamID: cursorStreamID,
CursorPosition: cursorPosition,
Limit: service.config.BatchSize,
AsOfSystemInterval: service.config.AsOfSystemInterval,
})
if err != nil {
return Error.Wrap(err)
}
// All done?
if len(result.Segments) == 0 {
break
}
segmentsData = segmentsData[:len(result.Segments)]
segments = segments[:len(result.Segments)]
last := &result.Segments[len(result.Segments)-1]
cursorStreamID, cursorPosition = last.StreamID, last.Position
for i := range segments {
segmentsData[i].VerifySegment = result.Segments[i]
segments[i] = &segmentsData[i]
}
service.log.Info("processing segments",
zap.Int64("progress", progress),
zap.Int("count", len(segments)),
zap.Stringer("first", segments[0].StreamID),
zap.Stringer("last", segments[len(segments)-1].StreamID),
)
progress += int64(len(segments))
// Process the data.
err = service.ProcessSegments(ctx, segments)
if err != nil {
return Error.Wrap(err)
}
}
if len(listStreamIDsResult.StreamIDs) == 0 {
return nil
}
cursorBucket = listStreamIDsResult.LastBucket
// TODO remove processed project_ids and bucket_names?
}
}
// ProcessSegmentsFromCSV processes all segments from the specified CSV source, in
// batches of config.BatchSize.
func (service *Service) ProcessSegmentsFromCSV(ctx context.Context, segmentSource *SegmentCSVSource) (err error) {
defer mon.Task()(&ctx)(&err)
aliasMap, err := service.metabase.LatestNodesAliasMap(ctx)
if err != nil {
return Error.Wrap(err)
}
service.aliasMap = aliasMap
service.log.Debug("got aliasMap", zap.Int("length", service.aliasMap.Size()))
streamIDs := make([]uuid.UUID, 0, service.config.BatchSize)
exhausted := false
segmentsData := make([]Segment, service.config.BatchSize)
segments := make([]*Segment, service.config.BatchSize)
for {
streamIDs = streamIDs[:0]
for n := 0; n < service.config.BatchSize; n++ {
streamIDAndPosition, err := segmentSource.Next()
if err != nil {
if errors.Is(err, io.EOF) {
exhausted = true
break
}
return Error.New("could not read csv: %w", err)
}
streamIDs = append(streamIDs, streamIDAndPosition.StreamID)
}
var cursorStreamID uuid.UUID
var cursorPosition metabase.SegmentPosition
for {
verifySegments, err := service.metabase.ListVerifySegments(ctx, metabase.ListVerifySegments{
CursorStreamID: cursorStreamID,
CursorPosition: cursorPosition,
StreamIDs: streamIDs,
Limit: service.config.BatchSize,
AsOfSystemInterval: service.config.AsOfSystemInterval,
})
segmentsData = segmentsData[:len(verifySegments.Segments)]
segments = segments[:len(verifySegments.Segments)]
if err != nil {
return Error.New("could not query metabase: %w", err)
}
for n, verifySegment := range verifySegments.Segments {
segmentsData[n].VerifySegment = verifySegment
segments[n] = &segmentsData[n]
}
if err := service.ProcessSegments(ctx, segments); err != nil {
return Error.Wrap(err)
}
if len(verifySegments.Segments) < service.config.BatchSize {
break
}
last := &verifySegments.Segments[len(verifySegments.Segments)-1]
cursorStreamID, cursorPosition = last.StreamID, last.Position
}
if exhausted {
return nil
}
}
}
// ProcessSegments processes a collection of segments.
func (service *Service) ProcessSegments(ctx context.Context, segments []*Segment) (err error) {
defer mon.Task()(&ctx)(&err)
// Verify all the segments against storage nodes.
err = service.Verify(ctx, segments)
if err != nil {
return Error.Wrap(err)
}
notFound := []*Segment{}
retry := []*Segment{}
// Find out which of the segments we did not find
// or there was some other failure.
for _, segment := range segments {
if segment.Status.NotFound > 0 {
notFound = append(notFound, segment)
} else if (service.config.Check > 0 && segment.Status.Retry > 0) || segment.Status.Retry > 5 {
retry = append(retry, segment)
}
}
// Some segments might have been deleted during the
// processing, so cross-reference and remove any deleted
// segments from the list.
notFound, err = service.RemoveDeleted(ctx, notFound)
if err != nil {
return Error.Wrap(err)
}
retry, err = service.RemoveDeleted(ctx, retry)
if err != nil {
return Error.Wrap(err)
}
// Output the problematic segments:
errNotFound := service.notFound.Write(ctx, notFound)
errRetry := service.retry.Write(ctx, retry)
return errs.Combine(errNotFound, errRetry)
}
// RemoveDeleted modifies the slice and returns only the segments that
// still exist in the database.
func (service *Service) RemoveDeleted(ctx context.Context, segments []*Segment) (_ []*Segment, err error) {
defer mon.Task()(&ctx)(&err)
valid := segments[:0]
for _, seg := range segments {
_, err := service.metabase.GetSegmentByPosition(ctx, metabase.GetSegmentByPosition{
StreamID: seg.StreamID,
Position: seg.Position,
})
if metabase.ErrSegmentNotFound.Has(err) {
continue
}
if err != nil {
service.log.Error("get segment by id failed", zap.Stringer("stream-id", seg.StreamID), zap.String("position", fmt.Sprint(seg.Position)))
if ctx.Err() != nil {
return valid, ctx.Err()
}
}
valid = append(valid, seg)
}
return valid, nil
}
// Segment contains minimal information necessary for verifying a single Segment.
type Segment struct {
metabase.VerifySegment
Status Status
}
// Status contains the statistics about the segment.
type Status struct {
Retry int32
Found int32
NotFound int32
}
// MarkFound moves a retry token from retry to found.
func (status *Status) MarkFound() {
atomic.AddInt32(&status.Retry, -1)
atomic.AddInt32(&status.Found, 1)
}
// MarkNotFound moves a retry token from retry to not found.
func (status *Status) MarkNotFound() {
atomic.AddInt32(&status.Retry, -1)
atomic.AddInt32(&status.NotFound, 1)
}
// Batch is a list of segments to be verified on a single node.
type Batch struct {
Alias metabase.NodeAlias
Items []*Segment
}
// Len returns the length of the batch.
func (b *Batch) Len() int { return len(b.Items) }
// uuidBefore returns an uuid.UUID that's immediately before v.
// It might not be a valid uuid after this operation.
func uuidBefore(v uuid.UUID) uuid.UUID {
for i := len(v) - 1; i >= 0; i-- {
v[i]--
if v[i] != 0xFF { // we didn't wrap around
break
}
}
return v
}