-
Notifications
You must be signed in to change notification settings - Fork 781
/
scanner.go
632 lines (525 loc) · 19.5 KB
/
scanner.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
620
621
622
623
624
625
626
627
628
629
630
631
632
package scanner
import (
"context"
"encoding/json"
"flag"
"io"
"io/ioutil"
"os"
"path"
"path/filepath"
"regexp"
"sort"
"strconv"
"strings"
"time"
"github.com/go-kit/kit/log"
"github.com/go-kit/kit/log/level"
"github.com/pkg/errors"
"github.com/prometheus/client_golang/prometheus"
"github.com/prometheus/client_golang/prometheus/promauto"
"github.com/thanos-io/thanos/pkg/objstore"
"golang.org/x/sync/errgroup"
"github.com/cortexproject/cortex/pkg/chunk"
"github.com/cortexproject/cortex/pkg/chunk/aws"
"github.com/cortexproject/cortex/pkg/chunk/storage"
"github.com/cortexproject/cortex/pkg/util/flagext"
"github.com/cortexproject/cortex/pkg/util/services"
"github.com/cortexproject/cortex/tools/blocksconvert"
)
type Config struct {
TableNames string
TablesLimit int
PeriodStart flagext.DayValue
PeriodEnd flagext.DayValue
OutputDirectory string
Concurrency int
VerifyPlans bool
UploadFiles bool
KeepFiles bool
AllowedUsers string
IgnoredUserPattern string
}
func (cfg *Config) RegisterFlags(f *flag.FlagSet) {
f.StringVar(&cfg.TableNames, "scanner.tables", "", "Comma-separated tables to generate plan files from. If not used, all tables found via schema and scanning of Index store will be used.")
f.StringVar(&cfg.OutputDirectory, "scanner.output-dir", "", "Local directory used for storing temporary plan files (will be created if missing).")
f.IntVar(&cfg.Concurrency, "scanner.concurrency", 16, "Number of concurrent index processors, and plan uploads.")
f.BoolVar(&cfg.UploadFiles, "scanner.upload", true, "Upload plan files.")
f.BoolVar(&cfg.KeepFiles, "scanner.keep-files", false, "Keep plan files locally after uploading.")
f.IntVar(&cfg.TablesLimit, "scanner.tables-limit", 0, "Number of tables to convert. 0 = all.")
f.StringVar(&cfg.AllowedUsers, "scanner.allowed-users", "", "Allowed users that can be converted, comma-separated. If set, only these users have plan files generated.")
f.StringVar(&cfg.IgnoredUserPattern, "scanner.ignore-users-regex", "", "If set and user ID matches this regex pattern, it will be ignored. Checked after applying -scanner.allowed-users, if set.")
f.BoolVar(&cfg.VerifyPlans, "scanner.verify-plans", true, "Verify plans before uploading to bucket. Enabled by default for extra check. Requires extra memory for large plans.")
f.Var(&cfg.PeriodStart, "scanner.scan-period-start", "If specified, this is lower end of time period to scan. Specified date is included in the range. (format: \"2006-01-02\")")
f.Var(&cfg.PeriodEnd, "scanner.scan-period-end", "If specified, this is upper end of time period to scan. Specified date is not included in the range. (format: \"2006-01-02\")")
}
type Scanner struct {
services.Service
cfg Config
storageCfg storage.Config
bucketPrefix string
bucket objstore.Bucket
logger log.Logger
reg prometheus.Registerer
series prometheus.Counter
openFiles prometheus.Gauge
indexEntries *prometheus.CounterVec
indexReaderRowsRead prometheus.Counter
indexReaderParsedIndexEntries prometheus.Counter
ignoredEntries prometheus.Counter
foundTables prometheus.Counter
processedTables prometheus.Counter
currentTableRanges prometheus.Gauge
currentTableScannedRanges prometheus.Gauge
schema chunk.SchemaConfig
ignoredUsers *regexp.Regexp
allowedUsers blocksconvert.AllowedUsers
}
func NewScanner(cfg Config, scfg blocksconvert.SharedConfig, l log.Logger, reg prometheus.Registerer) (*Scanner, error) {
err := scfg.SchemaConfig.Load()
if err != nil {
return nil, errors.Wrap(err, "no table name provided, and schema failed to load")
}
if cfg.OutputDirectory == "" {
return nil, errors.Errorf("no output directory")
}
var bucketClient objstore.Bucket
if cfg.UploadFiles {
var err error
bucketClient, err = scfg.GetBucket(l, reg)
if err != nil {
return nil, err
}
}
var users = blocksconvert.AllowAllUsers
if cfg.AllowedUsers != "" {
users = blocksconvert.ParseAllowedUsers(cfg.AllowedUsers)
}
var ignoredUserRegex *regexp.Regexp = nil
if cfg.IgnoredUserPattern != "" {
re, err := regexp.Compile(cfg.IgnoredUserPattern)
if err != nil {
return nil, errors.Wrap(err, "failed to compile ignored user regex")
}
ignoredUserRegex = re
}
if err := os.MkdirAll(cfg.OutputDirectory, os.FileMode(0700)); err != nil {
return nil, errors.Wrapf(err, "failed to create new output directory %s", cfg.OutputDirectory)
}
s := &Scanner{
cfg: cfg,
schema: scfg.SchemaConfig,
storageCfg: scfg.StorageConfig,
logger: l,
bucket: bucketClient,
bucketPrefix: scfg.BucketPrefix,
reg: reg,
allowedUsers: users,
ignoredUsers: ignoredUserRegex,
indexReaderRowsRead: promauto.With(reg).NewCounter(prometheus.CounterOpts{
Name: "cortex_blocksconvert_bigtable_read_rows_total",
Help: "Number of rows read from BigTable",
}),
indexReaderParsedIndexEntries: promauto.With(reg).NewCounter(prometheus.CounterOpts{
Name: "cortex_blocksconvert_bigtable_parsed_index_entries_total",
Help: "Number of parsed index entries",
}),
currentTableRanges: promauto.With(reg).NewGauge(prometheus.GaugeOpts{
Name: "cortex_blocksconvert_scanner_bigtable_ranges_in_current_table",
Help: "Number of ranges to scan from current table.",
}),
currentTableScannedRanges: promauto.With(reg).NewGauge(prometheus.GaugeOpts{
Name: "cortex_blocksconvert_scanner_bigtable_scanned_ranges_from_current_table",
Help: "Number of scanned ranges from current table. Resets to 0 every time a table is getting scanned or its scan has completed.",
}),
series: promauto.With(reg).NewCounter(prometheus.CounterOpts{
Name: "cortex_blocksconvert_scanner_series_written_total",
Help: "Number of series written to the plan files",
}),
openFiles: promauto.With(reg).NewGauge(prometheus.GaugeOpts{
Name: "cortex_blocksconvert_scanner_open_files",
Help: "Number of series written to the plan files",
}),
indexEntries: promauto.With(reg).NewCounterVec(prometheus.CounterOpts{
Name: "cortex_blocksconvert_scanner_scanned_index_entries_total",
Help: "Number of various index entries scanned",
}, []string{"type"}),
ignoredEntries: promauto.With(reg).NewCounter(prometheus.CounterOpts{
Name: "cortex_blocksconvert_scanner_ignored_index_entries_total",
Help: "Number of ignored index entries because of ignoring users.",
}),
foundTables: promauto.With(reg).NewCounter(prometheus.CounterOpts{
Name: "cortex_blocksconvert_scanner_found_tables_total",
Help: "Number of tables found for processing.",
}),
processedTables: promauto.With(reg).NewCounter(prometheus.CounterOpts{
Name: "cortex_blocksconvert_scanner_processed_tables_total",
Help: "Number of processed tables so far.",
}),
}
s.Service = services.NewBasicService(nil, s.running, nil)
return s, nil
}
func (s *Scanner) running(ctx context.Context) error {
allTables := []tableToProcess{}
for ix, c := range s.schema.Configs {
if c.Schema != "v9" && c.Schema != "v10" && c.Schema != "v11" {
level.Warn(s.logger).Log("msg", "skipping unsupported schema version", "version", c.Schema, "schemaFrom", c.From.String())
continue
}
if c.IndexTables.Period%(24*time.Hour) != 0 {
level.Warn(s.logger).Log("msg", "skipping invalid index table period", "period", c.IndexTables.Period, "schemaFrom", c.From.String())
continue
}
var reader chunk.IndexReader
switch c.IndexType {
case "gcp", "gcp-columnkey", "bigtable", "bigtable-hashed":
bigTable := s.storageCfg.GCPStorageConfig
if bigTable.Project == "" || bigTable.Instance == "" {
level.Error(s.logger).Log("msg", "cannot scan BigTable, missing configuration", "schemaFrom", c.From.String())
continue
}
reader = newBigtableIndexReader(bigTable.Project, bigTable.Instance, s.logger, s.indexReaderRowsRead, s.indexReaderParsedIndexEntries, s.currentTableRanges, s.currentTableScannedRanges)
case "aws-dynamo":
cfg := s.storageCfg.AWSStorageConfig
if cfg.DynamoDB.URL == nil {
level.Error(s.logger).Log("msg", "cannot scan DynamoDB, missing configuration", "schemaFrom", c.From.String())
continue
}
var err error
reader, err = aws.NewDynamoDBIndexReader(cfg.DynamoDBConfig, s.schema, s.reg, s.logger, s.indexReaderRowsRead)
if err != nil {
level.Error(s.logger).Log("msg", "cannot scan DynamoDB", "err", err)
}
case "cassandra":
cass := s.storageCfg.CassandraStorageConfig
reader = newCassandraIndexReader(cass, s.schema, s.logger, s.indexReaderRowsRead, s.indexReaderParsedIndexEntries, s.currentTableRanges, s.currentTableScannedRanges)
default:
level.Warn(s.logger).Log("msg", "unsupported index type", "type", c.IndexType, "schemaFrom", c.From.String())
continue
}
toTimestamp := time.Now().Add(24 * time.Hour).Truncate(24 * time.Hour).Unix()
if ix < len(s.schema.Configs)-1 {
toTimestamp = s.schema.Configs[ix+1].From.Unix()
}
level.Info(s.logger).Log("msg", "scanning for schema tables", "schemaFrom", c.From.String(), "prefix", c.IndexTables.Prefix, "period", c.IndexTables.Period)
tables, err := s.findTablesToProcess(ctx, reader, c.From.Unix(), toTimestamp, c.IndexTables)
if err != nil {
return errors.Wrapf(err, "finding tables for schema %s", c.From.String())
}
level.Info(s.logger).Log("msg", "found tables", "count", len(tables))
allTables = append(allTables, tables...)
}
level.Info(s.logger).Log("msg", "total found tables", "count", len(allTables))
if s.cfg.TableNames != "" {
// Find tables from parameter.
tableNames := map[string]bool{}
for _, t := range strings.Split(s.cfg.TableNames, ",") {
tableNames[strings.TrimSpace(t)] = true
}
for ix := 0; ix < len(allTables); {
t := allTables[ix]
if !tableNames[t.table] {
// remove table.
allTables = append(allTables[:ix], allTables[ix+1:]...)
continue
}
ix++
}
level.Error(s.logger).Log("msg", "applied tables filter", "selected", len(allTables))
}
// Recent tables go first.
sort.Slice(allTables, func(i, j int) bool {
return allTables[i].start.After(allTables[j].start)
})
for ix := 0; ix < len(allTables); {
t := allTables[ix]
if s.cfg.PeriodStart.IsSet() && !t.end.IsZero() && t.end.Unix() <= s.cfg.PeriodStart.Unix() {
level.Info(s.logger).Log("msg", "table ends before period-start, ignoring", "table", t.table, "table_start", t.start.String(), "table_end", t.end.String(), "period_start", s.cfg.PeriodStart.String())
allTables = append(allTables[:ix], allTables[ix+1:]...)
continue
}
if s.cfg.PeriodEnd.IsSet() && t.start.Unix() >= s.cfg.PeriodEnd.Unix() {
level.Info(s.logger).Log("msg", "table starts after period-end, ignoring", "table", t.table, "table_start", t.start.String(), "table_end", t.end.String(), "period_end", s.cfg.PeriodEnd.String())
allTables = append(allTables[:ix], allTables[ix+1:]...)
continue
}
ix++
}
if s.cfg.TablesLimit > 0 && len(allTables) > s.cfg.TablesLimit {
level.Info(s.logger).Log("msg", "applied tables limit", "limit", s.cfg.TablesLimit)
allTables = allTables[:s.cfg.TablesLimit]
}
s.foundTables.Add(float64(len(allTables)))
for _, t := range allTables {
if err := s.processTable(ctx, t.table, t.reader); err != nil {
return errors.Wrapf(err, "failed to process table %s", t.table)
}
s.processedTables.Inc()
}
// All good, just wait until context is done, to avoid restarts.
level.Info(s.logger).Log("msg", "finished")
<-ctx.Done()
return nil
}
type tableToProcess struct {
table string
reader chunk.IndexReader
start time.Time
end time.Time // Will not be set for non-periodic tables. Exclusive.
}
func (s *Scanner) findTablesToProcess(ctx context.Context, indexReader chunk.IndexReader, fromUnixTimestamp, toUnixTimestamp int64, tablesConfig chunk.PeriodicTableConfig) ([]tableToProcess, error) {
tables, err := indexReader.IndexTableNames(ctx)
if err != nil {
return nil, err
}
var result []tableToProcess
for _, t := range tables {
if !strings.HasPrefix(t, tablesConfig.Prefix) {
continue
}
var tp tableToProcess
if tablesConfig.Period == 0 {
tp = tableToProcess{
table: t,
reader: indexReader,
start: time.Unix(fromUnixTimestamp, 0),
}
} else {
p, err := strconv.ParseInt(t[len(tablesConfig.Prefix):], 10, 64)
if err != nil {
level.Warn(s.logger).Log("msg", "failed to parse period index of table", "table", t)
continue
}
start := time.Unix(p*int64(tablesConfig.Period/time.Second), 0)
tp = tableToProcess{
table: t,
reader: indexReader,
start: start,
end: start.Add(tablesConfig.Period),
}
}
if fromUnixTimestamp <= tp.start.Unix() && tp.start.Unix() < toUnixTimestamp {
result = append(result, tp)
}
}
return result, nil
}
func (s *Scanner) processTable(ctx context.Context, table string, indexReader chunk.IndexReader) error {
tableLog := log.With(s.logger, "table", table)
tableProcessedFile := filepath.Join(s.cfg.OutputDirectory, table+".processed")
if shouldSkipOperationBecauseFileExists(tableProcessedFile) {
level.Info(tableLog).Log("msg", "skipping table because it was already scanned")
return nil
}
dir := filepath.Join(s.cfg.OutputDirectory, table)
level.Info(tableLog).Log("msg", "scanning table", "output", dir)
ignoredUsers, err := scanSingleTable(ctx, indexReader, table, dir, s.cfg.Concurrency, s.allowedUsers, s.ignoredUsers, s.openFiles, s.series, s.indexEntries, s.ignoredEntries)
if err != nil {
return errors.Wrapf(err, "failed to scan table %s and generate plan files", table)
}
tableLog.Log("msg", "ignored users", "count", len(ignoredUsers), "users", strings.Join(ignoredUsers, ","))
if s.cfg.VerifyPlans {
err = verifyPlanFiles(ctx, dir, tableLog)
if err != nil {
return errors.Wrap(err, "failed to verify plans")
}
}
if s.bucket != nil {
level.Info(tableLog).Log("msg", "uploading generated plan files for table", "source", dir)
err := uploadPlansConcurrently(ctx, tableLog, dir, s.bucket, s.bucketPrefix, s.cfg.Concurrency)
if err != nil {
return errors.Wrapf(err, "failed to upload plan files for table %s to bucket", table)
}
level.Info(tableLog).Log("msg", "uploaded generated files for table")
if !s.cfg.KeepFiles {
if err := os.RemoveAll(dir); err != nil {
return errors.Wrapf(err, "failed to delete uploaded plan files for table %s", table)
}
}
}
err = ioutil.WriteFile(tableProcessedFile, []byte("Finished on "+time.Now().String()+"\n"), 0600)
if err != nil {
return errors.Wrapf(err, "failed to create file %s", tableProcessedFile)
}
level.Info(tableLog).Log("msg", "done processing table")
return nil
}
func uploadPlansConcurrently(ctx context.Context, log log.Logger, dir string, bucket objstore.Bucket, bucketPrefix string, concurrency int) error {
df, err := os.Stat(dir)
if err != nil {
return errors.Wrap(err, "stat dir")
}
if !df.IsDir() {
return errors.Errorf("%s is not a directory", dir)
}
// Path relative to dir, and only use Slash as separator. BucketPrefix is prepended to it when uploading.
paths := make(chan string)
g, ctx := errgroup.WithContext(ctx)
for i := 0; i < concurrency; i++ {
g.Go(func() error {
for p := range paths {
src := filepath.Join(dir, filepath.FromSlash(p))
dst := path.Join(bucketPrefix, p)
err := objstore.UploadFile(ctx, log, bucket, src, dst)
if err != nil {
return err
}
}
return nil
})
}
g.Go(func() error {
defer close(paths)
return filepath.Walk(dir, func(path string, fi os.FileInfo, err error) error {
if err != nil {
return err
}
if ctx.Err() != nil {
return ctx.Err()
}
if fi.IsDir() {
return nil
}
relPath, err := filepath.Rel(dir, path)
if err != nil {
return err
}
relPath = filepath.ToSlash(relPath)
select {
case paths <- relPath:
return nil
case <-ctx.Done():
return ctx.Err()
}
})
})
return g.Wait()
}
func shouldSkipOperationBecauseFileExists(file string) bool {
// If file exists, we should skip the operation.
_, err := os.Stat(file)
// Any error (including ErrNotExists) indicates operation should continue.
return err == nil
}
func scanSingleTable(
ctx context.Context,
indexReader chunk.IndexReader,
tableName string,
outDir string,
concurrency int,
allowed blocksconvert.AllowedUsers,
ignored *regexp.Regexp,
openFiles prometheus.Gauge,
series prometheus.Counter,
indexEntries *prometheus.CounterVec,
ignoredEntries prometheus.Counter,
) ([]string, error) {
err := os.RemoveAll(outDir)
if err != nil {
return nil, errors.Wrapf(err, "failed to delete directory %s", outDir)
}
err = os.MkdirAll(outDir, os.FileMode(0700))
if err != nil {
return nil, errors.Wrapf(err, "failed to prepare directory %s", outDir)
}
files := newOpenFiles(openFiles)
result := func(dir string, file string, entry blocksconvert.PlanEntry, header func() blocksconvert.PlanEntry) error {
return files.appendJSONEntryToFile(dir, file, entry, func() interface{} {
return header()
})
}
var ps []chunk.IndexEntryProcessor
for i := 0; i < concurrency; i++ {
ps = append(ps, newProcessor(outDir, result, allowed, ignored, series, indexEntries, ignoredEntries))
}
err = indexReader.ReadIndexEntries(ctx, tableName, ps)
if err != nil {
return nil, err
}
ignoredUsersMap := map[string]struct{}{}
for _, p := range ps {
for u := range p.(*processor).ignoredUsers {
ignoredUsersMap[u] = struct{}{}
}
}
var ignoredUsers []string
for u := range ignoredUsersMap {
ignoredUsers = append(ignoredUsers, u)
}
err = files.closeAllFiles(func() interface{} {
return blocksconvert.PlanEntry{Complete: true}
})
return ignoredUsers, errors.Wrap(err, "closing files")
}
func verifyPlanFiles(ctx context.Context, dir string, logger log.Logger) error {
return filepath.Walk(dir, func(path string, info os.FileInfo, err error) error {
if err != nil {
return err
}
if err := ctx.Err(); err != nil {
return err
}
if info.IsDir() {
return nil
}
ok, _ := blocksconvert.IsPlanFilename(info.Name())
if !ok {
return nil
}
r, err := os.Open(path)
if err != nil {
return errors.Wrapf(err, "failed to open %s", path)
}
defer func() {
_ = r.Close()
}()
pr, err := blocksconvert.PreparePlanFileReader(info.Name(), r)
if err != nil {
return errors.Wrapf(err, "failed to prepare plan file for reading: %s", path)
}
level.Info(logger).Log("msg", "verifying plan", "path", path)
return errors.Wrapf(verifyPlanFile(pr), "plan file: %s", path)
})
}
func verifyPlanFile(r io.Reader) error {
dec := json.NewDecoder(r)
entry := blocksconvert.PlanEntry{}
if err := dec.Decode(&entry); err != nil {
return errors.Wrap(err, "failed to parse plan file header")
}
if entry.User == "" || entry.DayIndex == 0 {
return errors.New("failed to read plan file header: no user or day index found")
}
series := map[string]struct{}{}
var err error
footerFound := false
for err = dec.Decode(&entry); err == nil; err = dec.Decode(&entry) {
if entry.Complete {
footerFound = true
entry.Reset()
continue
}
if footerFound {
return errors.New("plan entries found after plan footer")
}
if entry.SeriesID == "" {
return errors.Errorf("plan contains entry without seriesID")
}
if len(entry.Chunks) == 0 {
return errors.Errorf("entry for seriesID %s has no chunks", entry.SeriesID)
}
if _, found := series[entry.SeriesID]; found {
return errors.Errorf("multiple entries for series %s found in plan", entry.SeriesID)
}
series[entry.SeriesID] = struct{}{}
entry.Reset()
}
if err == io.EOF {
if !footerFound {
return errors.New("no footer found in the plan")
}
err = nil
}
return err
}