-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
debug.go
1414 lines (1270 loc) · 44.8 KB
/
debug.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
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2016 The Cockroach Authors.
//
// Use of this software is governed by the Business Source License
// included in the file licenses/BSL.txt.
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0, included in the file
// licenses/APL.txt.
package cli
import (
"bufio"
"bytes"
"context"
"encoding/base64"
gohex "encoding/hex"
"fmt"
"math"
"os"
"path/filepath"
"regexp"
"sort"
"strconv"
"strings"
"time"
"github.com/cockroachdb/cockroach/pkg/base"
"github.com/cockroachdb/cockroach/pkg/cli/syncbench"
"github.com/cockroachdb/cockroach/pkg/config"
"github.com/cockroachdb/cockroach/pkg/config/zonepb"
"github.com/cockroachdb/cockroach/pkg/gossip"
"github.com/cockroachdb/cockroach/pkg/keys"
"github.com/cockroachdb/cockroach/pkg/kv/kvserver"
"github.com/cockroachdb/cockroach/pkg/kv/kvserver/gc"
"github.com/cockroachdb/cockroach/pkg/kv/kvserver/liveness/livenesspb"
"github.com/cockroachdb/cockroach/pkg/kv/kvserver/rditer"
"github.com/cockroachdb/cockroach/pkg/kv/kvserver/stateloader"
"github.com/cockroachdb/cockroach/pkg/roachpb"
"github.com/cockroachdb/cockroach/pkg/server"
"github.com/cockroachdb/cockroach/pkg/server/serverpb"
"github.com/cockroachdb/cockroach/pkg/server/status/statuspb"
"github.com/cockroachdb/cockroach/pkg/sql/catalog"
"github.com/cockroachdb/cockroach/pkg/sql/catalog/catalogkv"
"github.com/cockroachdb/cockroach/pkg/sql/catalog/descpb"
"github.com/cockroachdb/cockroach/pkg/sql/execinfrapb"
"github.com/cockroachdb/cockroach/pkg/sql/row"
"github.com/cockroachdb/cockroach/pkg/storage"
"github.com/cockroachdb/cockroach/pkg/util/envutil"
"github.com/cockroachdb/cockroach/pkg/util/flagutil"
"github.com/cockroachdb/cockroach/pkg/util/hlc"
"github.com/cockroachdb/cockroach/pkg/util/humanizeutil"
"github.com/cockroachdb/cockroach/pkg/util/iterutil"
"github.com/cockroachdb/cockroach/pkg/util/log"
"github.com/cockroachdb/cockroach/pkg/util/protoutil"
"github.com/cockroachdb/cockroach/pkg/util/stop"
"github.com/cockroachdb/cockroach/pkg/util/sysutil"
"github.com/cockroachdb/cockroach/pkg/util/timeutil"
"github.com/cockroachdb/cockroach/pkg/util/uuid"
"github.com/cockroachdb/errors"
"github.com/cockroachdb/pebble"
"github.com/cockroachdb/pebble/tool"
"github.com/cockroachdb/pebble/vfs"
"github.com/gogo/protobuf/jsonpb"
"github.com/kr/pretty"
"github.com/spf13/cobra"
)
var debugKeysCmd = &cobra.Command{
Use: "keys <directory>",
Short: "dump all the keys in a store",
Long: `
Pretty-prints all keys in a store.
`,
Args: cobra.ExactArgs(1),
RunE: MaybeDecorateGRPCError(runDebugKeys),
}
var debugBallastCmd = &cobra.Command{
Use: "ballast <file>",
Short: "create a ballast file",
Long: `
Create a ballast file to fill the store directory up to a given amount
`,
Args: cobra.ExactArgs(1),
RunE: runDebugBallast,
}
// PopulateRocksDBConfigHook is a callback set by CCL code.
// It populates any needed fields in the RocksDBConfig.
// It must do nothing in OSS code.
var PopulateRocksDBConfigHook func(*base.StorageConfig) error
func parsePositiveInt(arg string) (int64, error) {
i, err := strconv.ParseInt(arg, 10, 64)
if err != nil {
return 0, err
}
if i < 1 {
return 0, fmt.Errorf("illegal val: %d < 1", i)
}
return i, nil
}
func parseRangeID(arg string) (roachpb.RangeID, error) {
rangeIDInt, err := parsePositiveInt(arg)
if err != nil {
return 0, err
}
return roachpb.RangeID(rangeIDInt), nil
}
func parsePositiveDuration(arg string) (time.Duration, error) {
duration, err := time.ParseDuration(arg)
if err != nil {
return 0, err
}
if duration <= 0 {
return 0, fmt.Errorf("illegal val: %v <= 0", duration)
}
return duration, nil
}
// OpenEngineOptions tunes the behavior of OpenEngine.
type OpenEngineOptions struct {
ReadOnly bool
MustExist bool
}
// OpenExistingStore opens the rocksdb engine rooted at 'dir'.
// If 'readOnly' is true, opens the store in read-only mode.
func OpenExistingStore(dir string, stopper *stop.Stopper, readOnly bool) (storage.Engine, error) {
return OpenEngine(dir, stopper, OpenEngineOptions{ReadOnly: readOnly, MustExist: true})
}
// OpenEngine opens the engine at 'dir'. Depending on the supplied options,
// an empty engine might be initialized.
func OpenEngine(dir string, stopper *stop.Stopper, opts OpenEngineOptions) (storage.Engine, error) {
maxOpenFiles, err := server.SetOpenFileLimitForOneStore()
if err != nil {
return nil, err
}
storageConfig := base.StorageConfig{
Settings: serverCfg.Settings,
Dir: dir,
MustExist: opts.MustExist,
}
if PopulateRocksDBConfigHook != nil {
if err := PopulateRocksDBConfigHook(&storageConfig); err != nil {
return nil, err
}
}
var db storage.Engine
cfg := storage.PebbleConfig{
StorageConfig: storageConfig,
Opts: storage.DefaultPebbleOptions(),
}
cfg.Opts.Cache = pebble.NewCache(server.DefaultCacheSize)
defer cfg.Opts.Cache.Unref()
cfg.Opts.MaxOpenFiles = int(maxOpenFiles)
cfg.Opts.ReadOnly = opts.ReadOnly
db, err = storage.NewPebble(context.Background(), cfg)
if err != nil {
return nil, err
}
stopper.AddCloser(db)
return db, nil
}
func printKey(kv storage.MVCCKeyValue) (bool, error) {
fmt.Printf("%s %s: ", kv.Key.Timestamp, kv.Key.Key)
if debugCtx.sizes {
fmt.Printf(" %d %d", len(kv.Key.Key), len(kv.Value))
}
fmt.Printf("\n")
return false, nil
}
func runDebugKeys(cmd *cobra.Command, args []string) error {
stopper := stop.NewStopper()
defer stopper.Stop(context.Background())
db, err := OpenExistingStore(args[0], stopper, true /* readOnly */)
if err != nil {
return err
}
if debugCtx.decodeAsTableDesc != "" {
bytes, err := base64.StdEncoding.DecodeString(debugCtx.decodeAsTableDesc)
if err != nil {
return err
}
var desc descpb.Descriptor
if err := protoutil.Unmarshal(bytes, &desc); err != nil {
return err
}
b := catalogkv.NewBuilder(&desc)
if b == nil || b.DescriptorType() != catalog.Table {
return errors.Newf("expected a table descriptor")
}
table := b.BuildImmutable().(catalog.TableDescriptor)
fn := func(kv storage.MVCCKeyValue) (string, error) {
var v roachpb.Value
v.RawBytes = kv.Value
_, names, values, err := row.DecodeRowInfo(context.Background(), table, kv.Key.Key, &v, true)
if err != nil {
return "", err
}
pairs := make([]string, len(names))
for i := range pairs {
pairs[i] = fmt.Sprintf("%s=%s", names[i], values[i])
}
return strings.Join(pairs, ", "), nil
}
kvserver.DebugSprintKeyValueDecoders = append(kvserver.DebugSprintKeyValueDecoders, fn)
}
printer := printKey
if debugCtx.values {
printer = func(kv storage.MVCCKeyValue) (bool, error) {
kvserver.PrintKeyValue(kv)
return false, nil
}
}
results := 0
iterFunc := func(kv storage.MVCCKeyValue) error {
done, err := printer(kv)
if err != nil {
return err
}
if done {
return iterutil.StopIteration()
}
results++
if results == debugCtx.maxResults {
return iterutil.StopIteration()
}
return nil
}
endKey := debugCtx.endKey.Key
splitScan := false
// If the startKey is local and the endKey is global, split into two parts
// to do the scan. This is because MVCCKeyAndIntentsIterKind cannot span
// across the two key kinds.
if (len(debugCtx.startKey.Key) == 0 || keys.IsLocal(debugCtx.startKey.Key)) && !(keys.IsLocal(endKey) || bytes.Equal(endKey, keys.LocalMax)) {
splitScan = true
endKey = keys.LocalMax
}
if err := db.MVCCIterate(
debugCtx.startKey.Key, endKey, storage.MVCCKeyAndIntentsIterKind, iterFunc); err != nil {
return err
}
if splitScan {
if err := db.MVCCIterate(keys.LocalMax, debugCtx.endKey.Key, storage.MVCCKeyAndIntentsIterKind,
iterFunc); err != nil {
return err
}
}
return nil
}
func runDebugBallast(cmd *cobra.Command, args []string) error {
ballastFile := args[0] // we use cobra.ExactArgs(1)
dataDirectory := filepath.Dir(ballastFile)
fs, err := sysutil.StatFS(dataDirectory)
if err != nil {
return errors.Wrapf(err, "failed to stat filesystem %s", dataDirectory)
}
total := fs.TotalBlocks * fs.BlockSize
free := fs.AvailBlocks * fs.BlockSize
used := total - free
var targetUsage int64
p := debugCtx.ballastSize.Percent
if math.Abs(p) > 100 {
return errors.Errorf("absolute percentage value %f greater than 100", p)
}
b := debugCtx.ballastSize.InBytes
if p != 0 && b != 0 {
return errors.New("expected exactly one of percentage or bytes non-zero, found both")
}
switch {
case p > 0:
fillRatio := p / float64(100)
targetUsage = used + int64((fillRatio)*float64(total))
case p < 0:
// Negative means leave the absolute %age of disk space.
fillRatio := 1.0 + (p / float64(100))
targetUsage = int64((fillRatio) * float64(total))
case b > 0:
targetUsage = used + b
case b < 0:
// Negative means leave that many bytes of disk space.
targetUsage = total + b
default:
return errors.New("expected exactly one of percentage or bytes non-zero, found none")
}
if used > targetUsage {
return errors.Errorf(
"Used space %s already more than needed to be filled %s\n",
humanizeutil.IBytes(used),
humanizeutil.IBytes(targetUsage),
)
}
if used == targetUsage {
return nil
}
ballastSize := targetUsage - used
// Note: CreateLargeFile fails if the target file already
// exists. This is a feature; we have seen users mistakenly applying
// the `ballast` command directly to block devices, thereby trashing
// their filesystem.
if err := sysutil.CreateLargeFile(ballastFile, ballastSize); err != nil {
return errors.Wrap(err, "error allocating ballast file")
}
return nil
}
var debugRangeDataCmd = &cobra.Command{
Use: "range-data <directory> <range id>",
Short: "dump all the data in a range",
Long: `
Pretty-prints all keys and values in a range. By default, includes unreplicated
state like the raft HardState. With --replicated, only includes data covered by
the consistency checker.
`,
Args: cobra.ExactArgs(2),
RunE: MaybeDecorateGRPCError(runDebugRangeData),
}
func runDebugRangeData(cmd *cobra.Command, args []string) error {
stopper := stop.NewStopper()
defer stopper.Stop(context.Background())
db, err := OpenExistingStore(args[0], stopper, true /* readOnly */)
if err != nil {
return err
}
rangeID, err := parseRangeID(args[1])
if err != nil {
return err
}
desc, err := loadRangeDescriptor(db, rangeID)
if err != nil {
return err
}
iter := rditer.NewReplicaEngineDataIterator(&desc, db, debugCtx.replicated)
defer iter.Close()
results := 0
for ; ; iter.Next() {
if ok, err := iter.Valid(); err != nil {
return err
} else if !ok {
break
}
kvserver.PrintEngineKeyValue(iter.UnsafeKey(), iter.UnsafeValue())
results++
if results == debugCtx.maxResults {
break
}
}
return nil
}
var debugRangeDescriptorsCmd = &cobra.Command{
Use: "range-descriptors <directory>",
Short: "print all range descriptors in a store",
Long: `
Prints all range descriptors in a store with a history of changes.
`,
Args: cobra.ExactArgs(1),
RunE: MaybeDecorateGRPCError(runDebugRangeDescriptors),
}
func loadRangeDescriptor(
db storage.Engine, rangeID roachpb.RangeID,
) (roachpb.RangeDescriptor, error) {
var desc roachpb.RangeDescriptor
handleKV := func(kv storage.MVCCKeyValue) error {
if kv.Key.Timestamp.IsEmpty() {
// We only want values, not MVCCMetadata.
return nil
}
if err := kvserver.IsRangeDescriptorKey(kv.Key); err != nil {
// Range descriptor keys are interleaved with others, so if it
// doesn't parse as a range descriptor just skip it.
return nil //nolint:returnerrcheck
}
if len(kv.Value) == 0 {
// RangeDescriptor was deleted (range merged away).
return nil
}
if err := (roachpb.Value{RawBytes: kv.Value}).GetProto(&desc); err != nil {
log.Warningf(context.Background(), "ignoring range descriptor due to error %s: %+v", err, kv)
return nil
}
if desc.RangeID == rangeID {
return iterutil.StopIteration()
}
return nil
}
// Range descriptors are stored by key, so we have to scan over the
// range-local data to find the one for this RangeID.
start := keys.LocalRangePrefix
end := keys.LocalRangeMax
// NB: Range descriptor keys can have intents.
if err := db.MVCCIterate(start, end, storage.MVCCKeyAndIntentsIterKind, handleKV); err != nil {
return roachpb.RangeDescriptor{}, err
}
if desc.RangeID == rangeID {
return desc, nil
}
return roachpb.RangeDescriptor{}, fmt.Errorf("range descriptor %d not found", rangeID)
}
func runDebugRangeDescriptors(cmd *cobra.Command, args []string) error {
stopper := stop.NewStopper()
defer stopper.Stop(context.Background())
db, err := OpenExistingStore(args[0], stopper, true /* readOnly */)
if err != nil {
return err
}
start := keys.LocalRangePrefix
end := keys.LocalRangeMax
// NB: Range descriptor keys can have intents.
return db.MVCCIterate(start, end, storage.MVCCKeyAndIntentsIterKind, func(kv storage.MVCCKeyValue) error {
if kvserver.IsRangeDescriptorKey(kv.Key) != nil {
return nil
}
kvserver.PrintKeyValue(kv)
return nil
})
}
var debugDecodeKeyCmd = &cobra.Command{
Use: "decode-key",
Short: "decode <key>",
Long: `
Decode a hexadecimal-encoded key and pretty-print it. For example:
$ decode-key BB89F902ADB43000151C2D1ED07DE6C009
/Table/51/1/44938288/1521140384.514565824,0
`,
Args: cobra.ArbitraryArgs,
RunE: func(cmd *cobra.Command, args []string) error {
for _, arg := range args {
b, err := gohex.DecodeString(arg)
if err != nil {
return err
}
k, err := storage.DecodeMVCCKey(b)
if err != nil {
return err
}
fmt.Println(k)
}
return nil
},
}
var debugDecodeValueCmd = &cobra.Command{
Use: "decode-value",
Short: "decode-value <key> <value>",
Long: `
Decode and print a hexadecimal-encoded key-value pair.
$ decode-value <TBD> <TBD>
<TBD>
`,
Args: cobra.ExactArgs(2),
RunE: func(cmd *cobra.Command, args []string) error {
var bs [][]byte
for _, arg := range args {
b, err := gohex.DecodeString(arg)
if err != nil {
return err
}
bs = append(bs, b)
}
isTS := bytes.HasPrefix(bs[0], keys.TimeseriesPrefix)
k, err := storage.DecodeMVCCKey(bs[0])
if err != nil {
// - Could be an EngineKey.
// - Older versions of the consistency checker give you diffs with a raw_key that
// is already a roachpb.Key, so make a half-assed attempt to support both.
if !isTS {
if k, ok := storage.DecodeEngineKey(bs[0]); ok {
kvserver.PrintEngineKeyValue(k, bs[1])
return nil
}
fmt.Printf("unable to decode key: %v, assuming it's a roachpb.Key with fake timestamp;\n"+
"if the result below looks like garbage, then it likely is:\n\n", err)
}
k = storage.MVCCKey{
Key: bs[0],
Timestamp: hlc.Timestamp{WallTime: 987654321},
}
}
kvserver.PrintKeyValue(storage.MVCCKeyValue{
Key: k,
Value: bs[1],
})
return nil
},
}
var debugDecodeProtoName string
var debugDecodeProtoEmitDefaults bool
var debugDecodeProtoCmd = &cobra.Command{
Use: "decode-proto",
Short: "decode-proto <proto> --name=<fully qualified proto name>",
Long: `
Read from stdin and attempt to decode any hex or base64 encoded proto fields and
output them as JSON. All other fields will be outputted unchanged. Output fields
will be separated by tabs.
The default value for --schema is 'cockroach.sql.sqlbase.Descriptor'.
For example:
$ decode-proto < cat debug/system.decsriptor.txt
id descriptor hex_descriptor
1 \022!\012\006system\020\001\032\025\012\011\012\005admin\0200\012\010\012\004root\0200 {"database": {"id": 1, "modificationTime": {}, "name": "system", "privileges": {"users": [{"privileges": 48, "user": "admin"}, {"privileges": 48, "user": "root"}]}}}
...
`,
Args: cobra.ArbitraryArgs,
RunE: runDebugDecodeProto,
}
var debugRaftLogCmd = &cobra.Command{
Use: "raft-log <directory> <range id>",
Short: "print the raft log for a range",
Long: `
Prints all log entries in a store for the given range.
`,
Args: cobra.ExactArgs(2),
RunE: MaybeDecorateGRPCError(runDebugRaftLog),
}
func runDebugRaftLog(cmd *cobra.Command, args []string) error {
stopper := stop.NewStopper()
defer stopper.Stop(context.Background())
db, err := OpenExistingStore(args[0], stopper, true /* readOnly */)
if err != nil {
return err
}
rangeID, err := parseRangeID(args[1])
if err != nil {
return err
}
start := keys.RaftLogPrefix(rangeID)
end := keys.RaftLogPrefix(rangeID).PrefixEnd()
fmt.Printf("Printing keys %s -> %s (RocksDB keys: %#x - %#x )\n",
start, end,
string(storage.EncodeKey(storage.MakeMVCCMetadataKey(start))),
string(storage.EncodeKey(storage.MakeMVCCMetadataKey(end))))
// NB: raft log does not have intents.
return db.MVCCIterate(start, end, storage.MVCCKeyIterKind, func(kv storage.MVCCKeyValue) error {
kvserver.PrintKeyValue(kv)
return nil
})
}
var debugGCCmd = &cobra.Command{
Use: "estimate-gc <directory> [range id] [ttl-in-seconds] [intent-age-as-duration]",
Short: "find out what a GC run would do",
Long: `
Sets up (but does not run) a GC collection cycle, giving insight into how much
work would be done (assuming all intent resolution and pushes succeed).
Without a RangeID specified on the command line, runs the analysis for all
ranges individually.
Uses a configurable GC policy, with a default 24 hour TTL, for old versions and
2 hour intent resolution threshold.
`,
Args: cobra.RangeArgs(1, 4),
RunE: MaybeDecorateGRPCError(runDebugGCCmd),
}
func runDebugGCCmd(cmd *cobra.Command, args []string) error {
stopper := stop.NewStopper()
defer stopper.Stop(context.Background())
var rangeID roachpb.RangeID
gcTTLInSeconds := int64((24 * time.Hour).Seconds())
intentAgeThreshold := gc.IntentAgeThreshold.Default()
if len(args) > 3 {
var err error
if intentAgeThreshold, err = parsePositiveDuration(args[3]); err != nil {
return errors.Wrapf(err, "unable to parse %v as intent age threshold", args[3])
}
}
if len(args) > 2 {
var err error
if gcTTLInSeconds, err = parsePositiveInt(args[2]); err != nil {
return errors.Wrapf(err, "unable to parse %v as TTL", args[2])
}
}
if len(args) > 1 {
var err error
if rangeID, err = parseRangeID(args[1]); err != nil {
return err
}
}
db, err := OpenExistingStore(args[0], stopper, true /* readOnly */)
if err != nil {
return err
}
start := keys.RangeDescriptorKey(roachpb.RKeyMin)
end := keys.RangeDescriptorKey(roachpb.RKeyMax)
var descs []roachpb.RangeDescriptor
if _, err := storage.MVCCIterate(context.Background(), db, start, end, hlc.MaxTimestamp,
storage.MVCCScanOptions{Inconsistent: true}, func(kv roachpb.KeyValue) error {
var desc roachpb.RangeDescriptor
_, suffix, _, err := keys.DecodeRangeKey(kv.Key)
if err != nil {
return err
}
if !bytes.Equal(suffix, keys.LocalRangeDescriptorSuffix) {
return nil
}
if err := kv.Value.GetProto(&desc); err != nil {
return err
}
if desc.RangeID == rangeID || rangeID == 0 {
descs = append(descs, desc)
}
if desc.RangeID == rangeID {
return iterutil.StopIteration()
}
return nil
}); err != nil {
return err
}
if len(descs) == 0 {
return fmt.Errorf("no range matching the criteria found")
}
for _, desc := range descs {
snap := db.NewSnapshot()
defer snap.Close()
policy := zonepb.GCPolicy{TTLSeconds: int32(gcTTLInSeconds)}
now := hlc.Timestamp{WallTime: timeutil.Now().UnixNano()}
thresh := gc.CalculateThreshold(now, policy)
info, err := gc.Run(
context.Background(),
&desc, snap,
now, thresh, intentAgeThreshold, policy,
gc.NoopGCer{},
func(_ context.Context, _ []roachpb.Intent) error { return nil },
func(_ context.Context, _ *roachpb.Transaction) error { return nil },
)
if err != nil {
return err
}
fmt.Printf("RangeID: %d [%s, %s):\n", desc.RangeID, desc.StartKey, desc.EndKey)
_, _ = pretty.Println(info)
}
return nil
}
var debugPebbleCmd = &cobra.Command{
Use: "pebble [command]",
Short: "run a Pebble introspection tool command",
Long: `
Allows the use of pebble tools, such as to introspect manifests, SSTables, etc.
`,
PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
storageConfig := base.StorageConfig{
Settings: serverCfg.Settings,
Dir: serverCfg.Stores.Specs[0].Path,
}
if PopulateRocksDBConfigHook != nil {
if err := PopulateRocksDBConfigHook(&storageConfig); err != nil {
return err
}
}
cfg := storage.PebbleConfig{
StorageConfig: storageConfig,
Opts: storage.DefaultPebbleOptions(),
}
cfg.Opts.Cache = pebble.NewCache(server.DefaultCacheSize)
defer cfg.Opts.Cache.Unref()
_, _, err := storage.ResolveEncryptedEnvOptions(&cfg)
if err != nil {
return err
}
pebbleToolFS.swap(cfg.Opts.FS)
return nil
},
}
var debugEnvCmd = &cobra.Command{
Use: "env",
Short: "output environment settings",
Long: `
Output environment variables that influence configuration.
`,
Args: cobra.NoArgs,
Run: func(cmd *cobra.Command, args []string) {
env := envutil.GetEnvReport()
fmt.Print(env)
},
}
var debugCompactCmd = &cobra.Command{
Use: "compact <directory>",
Short: "compact the sstables in a store",
Long: `
Compact the sstables in a store.
`,
Args: cobra.ExactArgs(1),
RunE: MaybeDecorateGRPCError(runDebugCompact),
}
func runDebugCompact(cmd *cobra.Command, args []string) error {
stopper := stop.NewStopper()
defer stopper.Stop(context.Background())
db, err := OpenExistingStore(args[0], stopper, false /* readOnly */)
if err != nil {
return err
}
{
approxBytesBefore, err := db.ApproximateDiskBytes(roachpb.KeyMin, roachpb.KeyMax)
if err != nil {
return errors.Wrap(err, "while computing approximate size before compaction")
}
fmt.Printf("approximate reported database size before compaction: %s\n", humanizeutil.IBytes(int64(approxBytesBefore)))
}
if err := db.Compact(); err != nil {
return errors.Wrap(err, "while compacting")
}
{
approxBytesAfter, err := db.ApproximateDiskBytes(roachpb.KeyMin, roachpb.KeyMax)
if err != nil {
return errors.Wrap(err, "while computing approximate size after compaction")
}
fmt.Printf("approximate reported database size after compaction: %s\n", humanizeutil.IBytes(int64(approxBytesAfter)))
}
return nil
}
var debugGossipValuesCmd = &cobra.Command{
Use: "gossip-values",
Short: "dump all the values in a node's gossip instance",
Long: `
Pretty-prints the values in a node's gossip instance.
Can connect to a running server to get the values or can be provided with
a JSON file captured from a node's /_status/gossip/ debug endpoint.
`,
Args: cobra.NoArgs,
RunE: MaybeDecorateGRPCError(runDebugGossipValues),
}
func runDebugGossipValues(cmd *cobra.Command, args []string) error {
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
// If a file is provided, use it. Otherwise, try talking to the running node.
var gossipInfo *gossip.InfoStatus
if debugCtx.inputFile != "" {
file, err := os.Open(debugCtx.inputFile)
if err != nil {
return err
}
defer file.Close()
gossipInfo = new(gossip.InfoStatus)
if err := jsonpb.Unmarshal(file, gossipInfo); err != nil {
return errors.Wrap(err, "failed to parse provided file as gossip.InfoStatus")
}
} else {
conn, _, finish, err := getClientGRPCConn(ctx, serverCfg)
if err != nil {
return err
}
defer finish()
status := serverpb.NewStatusClient(conn)
gossipInfo, err = status.Gossip(ctx, &serverpb.GossipRequest{})
if err != nil {
return errors.Wrap(err, "failed to retrieve gossip from server")
}
}
output, err := parseGossipValues(gossipInfo)
if err != nil {
return err
}
fmt.Println(output)
return nil
}
func parseGossipValues(gossipInfo *gossip.InfoStatus) (string, error) {
var output []string
for key, info := range gossipInfo.Infos {
bytes, err := info.Value.GetBytes()
if err != nil {
return "", errors.Wrapf(err, "failed to extract bytes for key %q", key)
}
if key == gossip.KeyClusterID || key == gossip.KeySentinel {
clusterID, err := uuid.FromBytes(bytes)
if err != nil {
return "", errors.Wrapf(err, "failed to parse value for key %q", key)
}
output = append(output, fmt.Sprintf("%q: %v", key, clusterID))
} else if key == gossip.KeySystemConfig {
if debugCtx.printSystemConfig {
var config config.SystemConfigEntries
if err := protoutil.Unmarshal(bytes, &config); err != nil {
return "", errors.Wrapf(err, "failed to parse value for key %q", key)
}
output = append(output, fmt.Sprintf("%q: %+v", key, config))
} else {
output = append(output, fmt.Sprintf("%q: omitted", key))
}
} else if key == gossip.KeyFirstRangeDescriptor {
var desc roachpb.RangeDescriptor
if err := protoutil.Unmarshal(bytes, &desc); err != nil {
return "", errors.Wrapf(err, "failed to parse value for key %q", key)
}
output = append(output, fmt.Sprintf("%q: %v", key, desc))
} else if gossip.IsNodeIDKey(key) {
var desc roachpb.NodeDescriptor
if err := protoutil.Unmarshal(bytes, &desc); err != nil {
return "", errors.Wrapf(err, "failed to parse value for key %q", key)
}
output = append(output, fmt.Sprintf("%q: %+v", key, desc))
} else if strings.HasPrefix(key, gossip.KeyStorePrefix) {
var desc roachpb.StoreDescriptor
if err := protoutil.Unmarshal(bytes, &desc); err != nil {
return "", errors.Wrapf(err, "failed to parse value for key %q", key)
}
output = append(output, fmt.Sprintf("%q: %+v", key, desc))
} else if strings.HasPrefix(key, gossip.KeyNodeLivenessPrefix) {
var liveness livenesspb.Liveness
if err := protoutil.Unmarshal(bytes, &liveness); err != nil {
return "", errors.Wrapf(err, "failed to parse value for key %q", key)
}
output = append(output, fmt.Sprintf("%q: %+v", key, liveness))
} else if strings.HasPrefix(key, gossip.KeyNodeHealthAlertPrefix) {
var healthAlert statuspb.HealthCheckResult
if err := protoutil.Unmarshal(bytes, &healthAlert); err != nil {
return "", errors.Wrapf(err, "failed to parse value for key %q", key)
}
output = append(output, fmt.Sprintf("%q: %+v", key, healthAlert))
} else if strings.HasPrefix(key, gossip.KeyDistSQLNodeVersionKeyPrefix) {
var version execinfrapb.DistSQLVersionGossipInfo
if err := protoutil.Unmarshal(bytes, &version); err != nil {
return "", errors.Wrapf(err, "failed to parse value for key %q", key)
}
output = append(output, fmt.Sprintf("%q: %+v", key, version))
} else if strings.HasPrefix(key, gossip.KeyDistSQLDrainingPrefix) {
var drainingInfo execinfrapb.DistSQLDrainingInfo
if err := protoutil.Unmarshal(bytes, &drainingInfo); err != nil {
return "", errors.Wrapf(err, "failed to parse value for key %q", key)
}
output = append(output, fmt.Sprintf("%q: %+v", key, drainingInfo))
} else if strings.HasPrefix(key, gossip.KeyTableStatAddedPrefix) {
gossipedTime := timeutil.Unix(0, info.OrigStamp)
output = append(output, fmt.Sprintf("%q: %v", key, gossipedTime))
} else if strings.HasPrefix(key, gossip.KeyGossipClientsPrefix) {
output = append(output, fmt.Sprintf("%q: %v", key, string(bytes)))
}
}
sort.Strings(output)
return strings.Join(output, "\n"), nil
}
var debugSyncBenchCmd = &cobra.Command{
Use: "syncbench [directory]",
Short: "Run a performance test for WAL sync speed",
Long: `
`,
Args: cobra.MaximumNArgs(1),
Hidden: true,
RunE: MaybeDecorateGRPCError(runDebugSyncBench),
}
var syncBenchOpts = syncbench.Options{
Concurrency: 1,
Duration: 10 * time.Second,
LogOnly: true,
}
func runDebugSyncBench(cmd *cobra.Command, args []string) error {
syncBenchOpts.Dir = "./testdb"
if len(args) == 1 {
syncBenchOpts.Dir = args[0]
}
return syncbench.Run(syncBenchOpts)
}
var debugUnsafeRemoveDeadReplicasCmd = &cobra.Command{
Use: "unsafe-remove-dead-replicas --dead-store-ids=[store ID,...] [path]",
Short: "Unsafely remove all other replicas from the given range",
Long: `
This command is UNSAFE and should only be used with the supervision of
a Cockroach Labs engineer. It is a last-resort option to recover data
after multiple node failures. The recovered data is not guaranteed to
be consistent. If a suitable backup exists, restore it instead of
using this tool.
The --dead-store-ids flag takes a comma-separated list of dead store
IDs and scans this store for any ranges whose only live replica is on
this store. These range descriptors will be edited to forcibly remove
the dead stores, allowing the range to recover from this single
replica.
This command will prompt for confirmation before committing its changes.
It is safest to run this command while all nodes are stopped. In some
circumstances it may be possible to run it while some nodes are still
running provided all nodes containing replicas of nodes that have lost
quorum are stopped.
It is recommended to take a filesystem-level backup or snapshot of the
nodes to be affected before running this command (remember that it is
not safe to take a filesystem-level backup of a running node, but it is
possible while the node is stopped)
WARNINGS
This tool will cause previously committed data to be lost. It does not
preserve atomicity of transactions, so further inconsistencies and
undefined behavior may result. Before proceeding at the yes/no prompt,
review the ranges that are affected to consider the possible impact
of inconsistencies. Further remediation may be necessary after running
this tool, including dropping and recreating affected indexes, or in the
worst case creating a new backup or export of this cluster's data for
restoration into a brand new cluster. Because of the latter possibilities,
this tool is a slower means of disaster recovery than restoring from
a backup.
Must only be used when the dead stores are lost and unrecoverable. If
the dead stores were to rejoin the cluster after this command was
used, data may be corrupted.
After this command is used, the node should not be restarted until at
least 10 seconds have passed since it was stopped. Restarting it too
early may lead to things getting stuck (if it happens, it can be fixed
by restarting a second time).
`,
Args: cobra.ExactArgs(1),
RunE: MaybeDecorateGRPCError(runDebugUnsafeRemoveDeadReplicas),
}
var removeDeadReplicasOpts struct {
deadStoreIDs []int
}
func runDebugUnsafeRemoveDeadReplicas(cmd *cobra.Command, args []string) error {
stopper := stop.NewStopper()
defer stopper.Stop(context.Background())
db, err := OpenExistingStore(args[0], stopper, false /* readOnly */)
if err != nil {
return err
}