-
Notifications
You must be signed in to change notification settings - Fork 3.8k
/
kv.go
1113 lines (1019 loc) · 40.8 KB
/
kv.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 2018 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 tests
import (
"context"
gosql "database/sql"
"fmt"
"math/rand"
"os"
"strconv"
"strings"
"sync"
"sync/atomic"
"time"
"github.com/cockroachdb/cockroach/pkg/cmd/roachtest/cluster"
"github.com/cockroachdb/cockroach/pkg/cmd/roachtest/option"
"github.com/cockroachdb/cockroach/pkg/cmd/roachtest/registry"
"github.com/cockroachdb/cockroach/pkg/cmd/roachtest/spec"
"github.com/cockroachdb/cockroach/pkg/cmd/roachtest/test"
"github.com/cockroachdb/cockroach/pkg/kv"
"github.com/cockroachdb/cockroach/pkg/roachprod/install"
"github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgerror"
"github.com/cockroachdb/cockroach/pkg/testutils"
"github.com/cockroachdb/cockroach/pkg/util/timeutil"
"github.com/cockroachdb/errors"
"github.com/stretchr/testify/require"
)
const envKVFlags = "ROACHTEST_KV_FLAGS"
func registerKV(r registry.Registry) {
type kvOptions struct {
nodes int
cpus int
readPercent int
// If true, the reads are limited reads over the full span of the table.
// Currently this also enables SFU writes on the workload since this is
// geared towards testing optimistic locking and latching.
spanReads bool
batchSize int
blockSize int
splits int
// If true, load-based splitting will be disabled.
disableLoadSplits bool
encryption bool
sequential bool
globalMVCCRangeTombstone bool
expirationLeases bool
concMultiplier int
ssds int
raid0 bool
duration time.Duration
tracing bool // `trace.debug.enable`
weekly bool
owner registry.Owner // defaults to KV
sharedProcessMT bool
// Set to true to make jemalloc release memory more aggressively to the
// OS, to reduce resident size.
jemallocReleaseFaster bool
}
computeConcurrency := func(opts kvOptions) int {
// Scale the workload concurrency with the number of nodes in the cluster to
// account for system capacity, then scale inversely with the batch size to
// account for the cost of each operation.
// TODO(nvanbenschoten): should we also scale the workload concurrency with
// the number of CPUs on each node? Probably, but doing so will disrupt
// regression tracking.
concPerNode := 64
if opts.concMultiplier != 0 {
concPerNode = opts.concMultiplier
}
conc := concPerNode * opts.nodes
const batchOpsPerConc = 2
if opts.batchSize >= batchOpsPerConc {
conc /= opts.batchSize / batchOpsPerConc
}
return conc
}
runKV := func(ctx context.Context, t test.Test, c cluster.Cluster, opts kvOptions) {
nodes := c.Spec().NodeCount - 1
// Don't start a scheduled backup on this perf sensitive roachtest that reports to roachperf.
startOpts := option.NewStartOpts(option.NoBackupSchedule)
if opts.ssds > 1 && !opts.raid0 {
startOpts.RoachprodOpts.StoreCount = opts.ssds
}
// Use a secure cluster so we can test with a non-root user.
settings := install.MakeClusterSettings()
if opts.globalMVCCRangeTombstone {
settings.Env = append(settings.Env, "COCKROACH_GLOBAL_MVCC_RANGE_TOMBSTONE=true")
}
if opts.jemallocReleaseFaster {
settings.Env = append(settings.Env,
"MALLOC_CONF=background_thread:true,dirty_decay_ms:2000,muzzy_decay_ms:0")
}
c.Start(ctx, t.L(), startOpts, settings, c.CRDBNodes())
db := c.Conn(ctx, t.L(), 1)
defer db.Close()
if opts.disableLoadSplits {
if _, err := db.ExecContext(ctx, "SET CLUSTER SETTING kv.range_split.by_load_enabled = 'false'"); err != nil {
t.Fatalf("failed to disable load based splitting: %v", err)
}
}
if opts.expirationLeases {
if _, err := db.ExecContext(ctx, "SET CLUSTER SETTING kv.expiration_leases_only.enabled = true"); err != nil {
t.Fatalf("failed to enable expiration leases: %v", err)
}
}
if opts.tracing {
if _, err := db.ExecContext(ctx, "SET CLUSTER SETTING trace.debug.enable = true"); err != nil {
t.Fatalf("failed to enable tracing: %v", err)
}
}
if opts.sharedProcessMT {
startOpts = option.StartSharedVirtualClusterOpts(appTenantName)
c.StartServiceForVirtualCluster(
ctx, t.L(), startOpts, install.MakeClusterSettings(),
)
}
t.Status("running workload")
m := c.NewMonitor(ctx, c.CRDBNodes())
m.Go(func(ctx context.Context) error {
concurrency := ifLocal(c, "", " --concurrency="+fmt.Sprint(computeConcurrency(opts)))
splits := ""
if opts.splits > 0 {
splits = " --splits=" + strconv.Itoa(opts.splits)
}
if opts.duration == 0 {
opts.duration = 30 * time.Minute
}
duration := " --duration=" + ifLocal(c, "10s", opts.duration.String())
var readPercent string
if opts.spanReads {
// SFU makes sense only if we repeat writes to the same key. Here
// we've arbitrarily picked a cycle-length of 1000, so 1 in 1000
// writes will contend with the limited scan wrt locking.
readPercent =
fmt.Sprintf(" --span-percent=%d --span-limit=1 --sfu-writes=true --cycle-length=1000",
opts.readPercent)
} else {
readPercent = fmt.Sprintf(" --read-percent=%d", opts.readPercent)
}
histograms := " --histograms=" + t.PerfArtifactsDir() + "/stats.json"
var batchSize string
if opts.batchSize > 0 {
batchSize = fmt.Sprintf(" --batch=%d", opts.batchSize)
}
var blockSize string
if opts.blockSize > 0 {
blockSize = fmt.Sprintf(" --min-block-bytes=%d --max-block-bytes=%d",
opts.blockSize, opts.blockSize)
}
var sequential string
if opts.sequential {
splits = "" // no splits
sequential = " --sequential"
}
var envFlags string
if e := os.Getenv(envKVFlags); e != "" {
envFlags = " " + e
}
url := fmt.Sprintf(" {pgurl:1-%d}", nodes)
if opts.sharedProcessMT {
url = fmt.Sprintf(" {pgurl:1-%d:%s}", nodes, appTenantName)
}
cmd := fmt.Sprintf(
"./cockroach workload run kv --tolerate-errors --init --user=%s --password=%s", install.DefaultUser, install.DefaultPassword,
) +
histograms + concurrency + splits + duration + readPercent +
batchSize + blockSize + sequential + envFlags + url
c.Run(ctx, option.WithNodes(c.WorkloadNode()), cmd)
return nil
})
m.Wait()
}
for _, opts := range []kvOptions{
// Standard configs.
{nodes: 1, cpus: 8, readPercent: 0},
{nodes: 1, cpus: 8, readPercent: 0, sharedProcessMT: true},
// CPU overload test, to stress admission control.
{nodes: 1, cpus: 8, readPercent: 50, concMultiplier: 8192},
// IO write overload test, to stress admission control.
//
// jemallocReleaseFaster is set to true due to OOMs observed in
// https://github.com/cockroachdb/cockroach/issues/125769. There is
// unavoidable 20% internal fragmentation in the Pebble block cache, since
// a 64KB value size causes a 64+KB sstable block, which allocates
// from the 80KB size class in jemalloc. So the allocated bytes from jemalloc
// by the block cache are 20% higher than configured. By setting this flag to true,
// we reduce the (resident-allocated) size in jemalloc.
{nodes: 1, cpus: 8, readPercent: 0, concMultiplier: 4096, blockSize: 1 << 16 /* 64 KB */, jemallocReleaseFaster: true},
{nodes: 1, cpus: 8, readPercent: 95},
{nodes: 1, cpus: 8, readPercent: 95, sharedProcessMT: true},
{nodes: 1, cpus: 32, readPercent: 0},
{nodes: 1, cpus: 32, readPercent: 0, sharedProcessMT: true},
{nodes: 1, cpus: 32, readPercent: 95},
{nodes: 1, cpus: 32, readPercent: 95, sharedProcessMT: true},
{nodes: 3, cpus: 8, readPercent: 0},
{nodes: 3, cpus: 8, readPercent: 0, sharedProcessMT: true},
{nodes: 3, cpus: 8, readPercent: 95},
{nodes: 3, cpus: 8, readPercent: 95, sharedProcessMT: true},
{nodes: 3, cpus: 8, readPercent: 95, tracing: true, owner: registry.OwnerObservability},
{nodes: 3, cpus: 32, readPercent: 0},
{nodes: 3, cpus: 32, readPercent: 0, sharedProcessMT: true},
{nodes: 3, cpus: 32, readPercent: 95},
{nodes: 3, cpus: 32, readPercent: 95, sharedProcessMT: true},
{nodes: 3, cpus: 32, readPercent: 0, globalMVCCRangeTombstone: true},
{nodes: 3, cpus: 32, readPercent: 95, globalMVCCRangeTombstone: true},
// Configs with expiration-based leases.
{nodes: 3, cpus: 8, readPercent: 0, expirationLeases: true},
{nodes: 3, cpus: 8, readPercent: 95, expirationLeases: true},
// Configs with large block sizes.
{nodes: 3, cpus: 8, readPercent: 0, blockSize: 1 << 12 /* 4 KB */},
{nodes: 3, cpus: 8, readPercent: 95, blockSize: 1 << 12 /* 4 KB */},
{nodes: 3, cpus: 32, readPercent: 0, blockSize: 1 << 12 /* 4 KB */},
{nodes: 3, cpus: 32, readPercent: 95, blockSize: 1 << 12 /* 4 KB */},
{nodes: 3, cpus: 8, readPercent: 0, blockSize: 1 << 16 /* 64 KB */},
{nodes: 3, cpus: 8, readPercent: 95, blockSize: 1 << 16 /* 64 KB */},
{nodes: 3, cpus: 32, readPercent: 0, blockSize: 1 << 16 /* 64 KB */},
{nodes: 3, cpus: 32, readPercent: 95, blockSize: 1 << 16 /* 64 KB */},
// Configs with large batch sizes.
{nodes: 3, cpus: 8, readPercent: 0, batchSize: 16},
{nodes: 3, cpus: 8, readPercent: 95, batchSize: 16},
// Configs with large nodes.
{nodes: 3, cpus: 96, readPercent: 0},
{nodes: 3, cpus: 96, readPercent: 95},
{nodes: 4, cpus: 96, readPercent: 50, batchSize: 64},
// Configs for comparing single store and multi store clusters.
{nodes: 4, cpus: 8, readPercent: 95},
{nodes: 4, cpus: 8, readPercent: 95, ssds: 8},
{nodes: 4, cpus: 8, readPercent: 95, ssds: 8, raid0: true},
// Configs with encryption.
{nodes: 1, cpus: 8, readPercent: 0, encryption: true},
{nodes: 1, cpus: 8, readPercent: 95, encryption: true},
{nodes: 3, cpus: 8, readPercent: 0, encryption: true},
{nodes: 3, cpus: 8, readPercent: 95, encryption: true},
// Configs with a sequential access pattern.
{nodes: 3, cpus: 32, readPercent: 0, sequential: true},
{nodes: 3, cpus: 32, readPercent: 95, sequential: true},
// Configs with reads, that are of limited spans, along with SFU writes.
{nodes: 1, cpus: 8, readPercent: 95, spanReads: true, disableLoadSplits: true, sequential: true},
{nodes: 1, cpus: 32, readPercent: 95, spanReads: true, disableLoadSplits: true, sequential: true},
// Weekly larger scale configurations.
{nodes: 32, cpus: 8, readPercent: 0, weekly: true, duration: time.Hour},
{nodes: 32, cpus: 8, readPercent: 95, weekly: true, duration: time.Hour},
} {
opts := opts
var nameParts []string
var limitedSpanStr string
if opts.spanReads {
limitedSpanStr = "limited-spans"
}
nameParts = append(nameParts, fmt.Sprintf("kv%d%s", opts.readPercent, limitedSpanStr))
if opts.weekly {
nameParts = append(nameParts, "weekly")
}
nameParts = append(nameParts, fmt.Sprintf("enc=%t", opts.encryption))
nameParts = append(nameParts, fmt.Sprintf("nodes=%d", opts.nodes))
if opts.cpus != 8 { // support legacy test name which didn't include cpu
nameParts = append(nameParts, fmt.Sprintf("cpu=%d", opts.cpus))
}
if opts.batchSize != 0 { // support legacy test name which didn't include batch size
nameParts = append(nameParts, fmt.Sprintf("batch=%d", opts.batchSize))
}
if opts.blockSize != 0 { // support legacy test name which didn't include block size
nameParts = append(nameParts, fmt.Sprintf("size=%dkb", opts.blockSize>>10))
}
if opts.splits != 0 { // support legacy test name which didn't include splits
nameParts = append(nameParts, fmt.Sprintf("splt=%d", opts.splits))
}
if opts.sequential {
nameParts = append(nameParts, "seq")
}
if opts.globalMVCCRangeTombstone {
nameParts = append(nameParts, "mvcc-range-keys=global")
}
if opts.expirationLeases {
nameParts = append(nameParts, "lease=expiration")
}
if opts.concMultiplier != 0 { // support legacy test name which didn't include this multiplier
nameParts = append(nameParts, fmt.Sprintf("conc=%d", opts.concMultiplier))
}
if opts.ssds > 1 {
nameParts = append(nameParts, fmt.Sprintf("ssds=%d", opts.ssds))
}
if opts.raid0 {
nameParts = append(nameParts, "raid0")
}
if opts.disableLoadSplits {
nameParts = append(nameParts, "no-load-splitting")
}
if opts.tracing {
nameParts = append(nameParts, "tracing")
}
if opts.sharedProcessMT {
nameParts = append(nameParts, "mt-shared-process")
}
owner := registry.OwnerTestEng
if opts.owner != "" {
owner = opts.owner
}
encryption := registry.EncryptionAlwaysDisabled
if opts.encryption {
encryption = registry.EncryptionAlwaysEnabled
}
// Save some money and CPU quota by using a smaller workload CPU. Only
// do this for cluster of size 3 or smaller to avoid regressions.
workloadNodeCPUs := 4
if opts.nodes > 3 {
workloadNodeCPUs = opts.cpus
}
cSpec := r.MakeClusterSpec(opts.nodes+1, spec.CPU(opts.cpus), spec.WorkloadNode(), spec.WorkloadNodeCPU(workloadNodeCPUs), spec.SSD(opts.ssds), spec.RAID0(opts.raid0))
var clouds registry.CloudSet
tags := make(map[string]struct{})
if opts.ssds != 0 {
// Multi-store tests are only supported on GCE.
clouds = registry.OnlyGCE
} else if !opts.weekly && (opts.readPercent == 95 || opts.readPercent == 0) {
// All the kv0|95 tests should run on AWS.
clouds = registry.AllClouds
} else {
clouds = registry.AllExceptAWS
}
suites := registry.Suites(registry.Nightly)
if opts.weekly {
suites = registry.Suites(registry.Weekly)
tags["weekly"] = struct{}{}
}
r.Add(registry.TestSpec{
Name: strings.Join(nameParts, "/"),
Owner: owner,
Benchmark: true,
Cluster: cSpec,
Run: func(ctx context.Context, t test.Test, c cluster.Cluster) {
runKV(ctx, t, c, opts)
},
CompatibleClouds: clouds,
Suites: suites,
EncryptionSupport: encryption,
})
}
}
func registerKVContention(r registry.Registry) {
const nodes = 4
r.Add(registry.TestSpec{
Name: fmt.Sprintf("kv/contention/nodes=%d", nodes),
Owner: registry.OwnerKV,
Benchmark: true,
Cluster: r.MakeClusterSpec(nodes + 1),
CompatibleClouds: registry.AllExceptAWS,
Suites: registry.Suites(registry.Nightly),
Leases: registry.MetamorphicLeases,
Run: func(ctx context.Context, t test.Test, c cluster.Cluster) {
c.Put(ctx, t.DeprecatedWorkload(), "./workload", c.Node(nodes+1))
// Start the cluster with an extremely high txn liveness threshold.
// If requests ever get stuck on a transaction that was abandoned
// then it will take 10m for them to get unstuck, at which point the
// QPS threshold check in the test is guaranteed to fail.
settings := install.MakeClusterSettings()
settings.Env = append(settings.Env, "COCKROACH_TXN_LIVENESS_HEARTBEAT_MULTIPLIER=600")
c.Start(ctx, t.L(), option.DefaultStartOpts(), settings, c.Range(1, nodes))
conn := c.Conn(ctx, t.L(), 1)
// Enable request tracing, which is a good tool for understanding
// how different transactions are interacting.
if _, err := conn.Exec(`
SET CLUSTER SETTING trace.debug.enable = true;
`); err != nil {
t.Fatal(err)
}
// Drop the deadlock detection delay because the test creates a
// large number transaction deadlocks.
if _, err := conn.Exec(`
SET CLUSTER SETTING kv.lock_table.deadlock_detection_push_delay = '5ms'
`); err != nil && !strings.Contains(err.Error(), "unknown cluster setting") {
t.Fatal(err)
}
t.Status("running workload")
m := c.NewMonitor(ctx, c.Range(1, nodes))
m.Go(func(ctx context.Context) error {
// Write to a small number of keys to generate a large amount of
// contention. Use a relatively high amount of concurrency and
// aim to average one concurrent write for each key in the keyspace.
const cycleLength = 512
const concurrency = 128
const avgConcPerKey = 1
const batchSize = avgConcPerKey * (cycleLength / concurrency)
// Split the table so that each node can have a single leaseholder.
splits := nodes
// Run the workload for an hour. Add a secondary index to avoid
// UPSERTs performing blind writes.
const duration = 1 * time.Hour
cmd := fmt.Sprintf("./workload run kv --init --secondary-index --duration=%s "+
"--cycle-length=%d --concurrency=%d --batch=%d --splits=%d {pgurl:1-%d}",
duration, cycleLength, concurrency, batchSize, splits, nodes)
start := timeutil.Now()
c.Run(ctx, option.WithNodes(c.Node(nodes+1)), cmd)
end := timeutil.Now()
// Assert that the average throughput stayed above a certain
// threshold. In this case, assert that max throughput only
// dipped below 50 qps for 10% of the time.
const minQPS = 50
verifyTxnPerSecond(ctx, c, t, c.Node(1), start, end, minQPS, 0.1)
return nil
})
m.Wait()
},
})
}
func registerKVQuiescenceDead(r registry.Registry) {
r.Add(registry.TestSpec{
Name: "kv/quiescence/nodes=3",
Owner: registry.OwnerReplication,
Cluster: r.MakeClusterSpec(4),
CompatibleClouds: registry.AllExceptAWS,
Suites: registry.Suites(registry.Nightly),
Leases: registry.EpochLeases,
SkipPostValidations: registry.PostValidationNoDeadNodes,
Run: func(ctx context.Context, t test.Test, c cluster.Cluster) {
nodes := c.Spec().NodeCount - 1
c.Put(ctx, t.DeprecatedWorkload(), "./workload", c.Node(nodes+1))
settings := install.MakeClusterSettings(install.ClusterSettingsOption{
"sql.stats.automatic_collection.enabled": "false",
})
c.Start(ctx, t.L(), option.NewStartOpts(option.NoBackupSchedule), settings, c.Range(1, nodes))
m := c.NewMonitor(ctx, c.Range(1, nodes))
db := c.Conn(ctx, t.L(), 1)
defer db.Close()
err := WaitFor3XReplication(ctx, t, t.L(), db)
require.NoError(t, err)
qps := func(f func()) float64 {
numInserts := func() float64 {
var v float64
if err = db.QueryRowContext(
ctx, `SELECT value FROM crdb_internal.node_metrics WHERE name = 'sql.insert.count'`,
).Scan(&v); err != nil {
t.Fatal(err)
}
return v
}
tBegin := timeutil.Now()
before := numInserts()
f()
after := numInserts()
return (after - before) / timeutil.Since(tBegin).Seconds()
}
const kv = "./workload run kv --duration=10m --read-percent=0"
// Initialize the database with ~10k ranges so that the absence of
// quiescence hits hard once a node goes down.
c.Run(ctx, option.WithNodes(c.Node(nodes+1)), "./workload run kv --init --max-ops=1 --splits 10000 --concurrency 100 {pgurl:1}")
c.Run(ctx, option.WithNodes(c.Node(nodes+1)), kv+" --seed 0 {pgurl:1}")
// Measure qps with all nodes up (i.e. with quiescence).
qpsAllUp := qps(func() {
c.Run(ctx, option.WithNodes(c.Node(nodes+1)), kv+" --seed 1 {pgurl:1}")
})
// Graceful shut down third node.
m.ExpectDeath()
gracefulOpts := option.DefaultStopOpts()
gracefulOpts.RoachprodOpts.Sig = 15 // SIGTERM
gracefulOpts.RoachprodOpts.Wait = true
gracefulOpts.RoachprodOpts.MaxWait = 30
c.Stop(ctx, t.L(), gracefulOpts, c.Node(nodes))
// If graceful shutdown fails within 30 seconds, proceed with hard shutdown.
c.Stop(ctx, t.L(), option.DefaultStopOpts(), c.Node(nodes))
// Measure qps with node down (i.e. without quiescence).
qpsOneDown := qps(func() {
// Use a different seed to make sure it's not just stepping into the
// other earlier kv invocation's footsteps.
c.Run(ctx, option.WithNodes(c.Node(nodes+1)), kv+" --seed 2 {pgurl:1}")
})
if minFrac, actFrac := 0.8, qpsOneDown/qpsAllUp; actFrac < minFrac {
t.Fatalf(
"QPS dropped from %.2f to %.2f (factor of %.2f, min allowed %.2f)",
qpsAllUp, qpsOneDown, actFrac, minFrac,
)
}
t.L().Printf("QPS went from %.2f to %2.f with one node down\n", qpsAllUp, qpsOneDown)
},
})
}
func registerKVGracefulDraining(r registry.Registry) {
r.Add(registry.TestSpec{
Name: "kv/gracefuldraining",
Owner: registry.OwnerKV,
Cluster: r.MakeClusterSpec(7),
CompatibleClouds: registry.OnlyGCE,
Suites: registry.Suites(registry.Nightly),
Leases: registry.MetamorphicLeases,
Run: func(ctx context.Context, t test.Test, c cluster.Cluster) {
nodes := c.Spec().NodeCount - 1
c.Put(ctx, t.DeprecatedWorkload(), "./workload", c.WorkloadNode())
t.Status("starting cluster")
// If the test ever fails, the person who investigates the
// failure will likely be thankful for this additional logging.
startOpts := option.DefaultStartOpts()
startOpts.RoachprodOpts.ExtraArgs = append(startOpts.RoachprodOpts.ExtraArgs, "--vmodule=store=2,store_rebalancer=2")
c.Start(ctx, t.L(), startOpts, install.MakeClusterSettings(), c.Range(1, nodes))
// Don't connect to the node we are going to shut down.
dbs := make([]*gosql.DB, nodes-1)
for i := range dbs {
dbs[i] = c.Conn(ctx, t.L(), i+1)
}
err := WaitFor3XReplication(ctx, t, t.L(), dbs[0])
require.NoError(t, err)
t.Status("initializing workload")
// Initialize the database with a lot of ranges so that there are
// definitely a large number of leases on the node that we shut down
// before it starts draining.
c.Run(ctx, option.WithNodes(c.Node(1)), "./cockroach workload init kv --splits 100 {pgurl:1}")
m := c.NewMonitor(ctx, c.Nodes(1, nodes))
m.ExpectDeath()
// specifiedQPS is going to be the --max-rate for the kv workload.
specifiedQPS := 2000
if c.IsLocal() {
specifiedQPS = 100
}
// Because we're specifying a --max-rate well less than what cockroach
// should be capable of, draining one of the three nodes should have no
// effect on performance at all, meaning that a fairly aggressive
// threshold here should be ok.
expectedQPS := float64(specifiedQPS) * .9
t.Status("starting workload")
workloadStartTime := timeutil.Now()
// Three iterations, each iteration has a 3-minute duration.
desiredRunDuration := 10 * time.Minute
m.Go(func(ctx context.Context) error {
cmd := fmt.Sprintf(
"./cockroach workload run kv --duration=%s --read-percent=50 --follower-read-percent=50 --concurrency=200 --max-rate=%d {pgurl:1-%d}",
desiredRunDuration, specifiedQPS, nodes-1)
t.WorkerStatus(cmd)
defer func() {
t.WorkerStatus("workload command completed")
t.WorkerStatus()
}()
return c.RunE(ctx, option.WithNodes(c.Node(nodes+1)), cmd)
})
verifyQPS := func(ctx context.Context) error {
if qps := measureQPS(ctx, t, time.Second, dbs...); qps < expectedQPS {
return errors.Newf(
"QPS of %.2f at time %v is below minimum allowable QPS of %.2f",
qps, timeutil.Now(), expectedQPS)
}
return nil
}
t.Status("waiting for perf to stabilize")
testutils.SucceedsSoon(t, func() error { return verifyQPS(ctx) })
// Begin the monitoring goroutine to track QPS every second.
m.Go(func(ctx context.Context) error {
t.Status("starting watcher to verify QPS during the test")
defer t.WorkerStatus()
for {
// Measure QPS every second throughout the test. verifyQPS takes time
// to run so we don't sleep between invocations.
require.NoError(t, verifyQPS(ctx))
// Stop measuring 10 seconds before we stop the workload.
if timeutil.Since(workloadStartTime) > desiredRunDuration-10*time.Second {
return nil
}
}
})
restartNode := c.Node(nodes)
t.Status("gracefully draining and restarting nodes")
// Gracefully shut down the third node, let the cluster run for a
// while, then restart it. Repeat for a total of 3 times for good
// measure.
for i := 0; i < 3; i++ {
if i > 0 {
// No need to wait extra during the first iteration: we
// have already waited for the perf to become stable
// above.
t.Status("letting workload run with all nodes")
select {
case <-ctx.Done():
return
case <-time.After(2 * time.Minute):
}
}
// Graceful drain and allow it to complete. The liveness record is
// updated at the beginning of the drain process, so by time the drain
// completes in ~5s all other nodes should "know" it is draining.
cmd := fmt.Sprintf("./cockroach node drain --certs-dir=%s --port={pgport%s} --self", install.CockroachNodeCertsDir, restartNode)
c.Run(ctx, option.WithNodes(restartNode), cmd)
// Simulate a hard network drop to this node prior to shutting it down.
// This is what we see in some customer environments. As an example, a
// docker container shutdown will also disappear from the network and
// drop all packets in both directions.
// TODO(baptist): Convert this to use a network partitioning
// utility function.
if !c.IsLocal() {
c.Run(ctx, option.WithNodes(restartNode), `sudo iptables -A INPUT -p tcp --dport 26257 -j DROP`)
c.Run(ctx, option.WithNodes(restartNode), `sudo iptables -A OUTPUT -p tcp --dport 26257 -j DROP`)
}
c.Stop(ctx, t.L(), option.DefaultStopOpts(), restartNode)
t.Status("letting workload run with one node down")
select {
case <-ctx.Done():
return
case <-time.After(1 * time.Minute):
}
// Clean up the iptables rule before restarting.
if !c.IsLocal() {
c.Run(ctx, option.WithNodes(restartNode), `sudo iptables -F`)
}
c.Start(ctx, t.L(), option.DefaultStartOpts(), install.MakeClusterSettings(), restartNode)
m.ResetDeaths()
}
// Let the test run for nearly the entire duration of the kv command.
// The key is that we want the workload command to still be running when
// we look at the performance below. Given that the workload was set
// to run for 5 minutes, we should be fine here, however we want to guarantee
// there's at least 10s left to go. Check this.
t.Status("checking workload is still running")
runDuration := timeutil.Since(workloadStartTime)
if runDuration > desiredRunDuration-10*time.Second {
t.Fatalf("not enough workload time left to reliably determine performance (%s left)",
desiredRunDuration-runDuration)
}
t.Status("waiting for workload to complete")
m.Wait()
},
})
}
func registerKVSplits(r registry.Registry) {
for _, item := range []struct {
quiesce bool
splits int
leases registry.LeaseType
timeout time.Duration
}{
// NB: with 500000 splits, this test sometimes fails since it's pushing
// far past the number of replicas per node we support, at least if the
// ranges start to unquiesce (which can set off a cascade due to resource
// exhaustion).
{true, 300000, registry.EpochLeases, 2 * time.Hour},
// This version of the test prevents range quiescence to trigger the
// badness described above more reliably for when we wish to improve
// the performance. For now, just verify that 30k unquiesced ranges
// is tenable.
{false, 30000, registry.EpochLeases, 2 * time.Hour},
// Expiration-based leases prevent quiescence, and are also more expensive
// to keep alive. Again, just verify that 30k ranges is ok.
{false, 30000, registry.ExpirationLeases, 2 * time.Hour},
} {
item := item // for use in closure below
r.Add(registry.TestSpec{
Name: fmt.Sprintf("kv/splits/nodes=3/quiesce=%t/lease=%s", item.quiesce, item.leases),
Owner: registry.OwnerKV,
Timeout: item.timeout,
Cluster: r.MakeClusterSpec(4),
CompatibleClouds: registry.AllExceptAWS,
Suites: registry.Suites(registry.Nightly),
Leases: item.leases,
Run: func(ctx context.Context, t test.Test, c cluster.Cluster) {
nodes := c.Spec().NodeCount - 1
c.Put(ctx, t.DeprecatedWorkload(), "./workload", c.Node(nodes+1))
settings := install.MakeClusterSettings()
settings.Env = append(settings.Env, "COCKROACH_MEMPROF_INTERVAL=1m", "COCKROACH_DISABLE_QUIESCENCE="+strconv.FormatBool(!item.quiesce))
startOpts := option.NewStartOpts(option.NoBackupSchedule)
startOpts.RoachprodOpts.ExtraArgs = append(startOpts.RoachprodOpts.ExtraArgs, "--cache=256MiB")
c.Start(ctx, t.L(), startOpts, settings, c.Range(1, nodes))
t.Status("running workload")
workloadCtx, workloadCancel := context.WithCancel(ctx)
m := c.NewMonitor(workloadCtx, c.Range(1, nodes))
m.Go(func(ctx context.Context) error {
defer workloadCancel()
concurrency := ifLocal(c, "", " --concurrency="+fmt.Sprint(nodes*64))
splits := " --splits=" + ifLocal(c, "2000", fmt.Sprint(item.splits))
cmd := fmt.Sprintf(
"./workload run kv --init --max-ops=1"+
concurrency+splits+
" {pgurl:1-%d}",
nodes)
c.Run(ctx, option.WithNodes(c.Node(nodes+1)), cmd)
return nil
})
m.Wait()
},
})
}
}
func registerKVScalability(r registry.Registry) {
runScalability := func(ctx context.Context, t test.Test, c cluster.Cluster, percent int) {
nodes := c.Spec().NodeCount - 1
c.Put(ctx, t.DeprecatedWorkload(), "./workload", c.Node(nodes+1))
const maxPerNodeConcurrency = 64
for i := nodes; i <= nodes*maxPerNodeConcurrency; i += nodes {
c.Wipe(ctx, c.Range(1, nodes))
c.Start(ctx, t.L(), option.DefaultStartOpts(), install.MakeClusterSettings(), c.Range(1, nodes))
t.Status("running workload")
m := c.NewMonitor(ctx, c.Range(1, nodes))
m.Go(func(ctx context.Context) error {
cmd := fmt.Sprintf("./workload run kv --init --read-percent=%d "+
"--splits=1000 --duration=1m "+fmt.Sprintf("--concurrency=%d", i)+
" {pgurl:1-%d}",
percent, nodes)
return c.RunE(ctx, option.WithNodes(c.Node(nodes+1)), cmd)
})
m.Wait()
}
}
// TODO(peter): work in progress adaption of `roachprod test kv{0,95}`.
if false {
for _, p := range []int{0, 95} {
p := p
r.Add(registry.TestSpec{
Name: fmt.Sprintf("kv%d/scale/nodes=6", p),
Owner: registry.OwnerKV,
Cluster: r.MakeClusterSpec(7, spec.CPU(8)),
CompatibleClouds: registry.AllExceptAWS,
Suites: registry.Suites(registry.Nightly),
Leases: registry.MetamorphicLeases,
Run: func(ctx context.Context, t test.Test, c cluster.Cluster) {
runScalability(ctx, t, c, p)
},
})
}
}
}
func registerKVRangeLookups(r registry.Registry) {
type rangeLookupWorkloadType int
const (
splitWorkload rangeLookupWorkloadType = iota
relocateWorkload
)
const (
nodes = 8
cpus = 8
)
runRangeLookups := func(ctx context.Context, t test.Test, c cluster.Cluster, workers int, workloadType rangeLookupWorkloadType, maximumRangeLookupsPerSec float64) {
nodes := c.Spec().NodeCount - 1
doneInit := make(chan struct{})
doneWorkload := make(chan struct{})
c.Put(ctx, t.DeprecatedWorkload(), "./workload", c.Node(nodes+1))
c.Start(ctx, t.L(), option.DefaultStartOpts(), install.MakeClusterSettings(), c.Range(1, nodes))
t.Status("running workload")
conns := make([]*gosql.DB, nodes)
for i := 0; i < nodes; i++ {
conns[i] = c.Conn(ctx, t.L(), i+1)
}
defer func() {
for i := 0; i < nodes; i++ {
conns[i].Close()
}
}()
err := WaitFor3XReplication(ctx, t, t.L(), conns[0])
require.NoError(t, err)
m := c.NewMonitor(ctx, c.Range(1, nodes))
m.Go(func(ctx context.Context) error {
defer close(doneWorkload)
defer close(doneInit)
cmd := "./workload init kv --splits=1000 {pgurl:1}"
if err = c.RunE(ctx, option.WithNodes(c.Node(nodes+1)), cmd); err != nil {
return err
}
concurrency := ifLocal(c, "", " --concurrency="+fmt.Sprint(nodes*64))
duration := " --duration=10m"
readPercent := " --read-percent=50"
// We run kv with --tolerate-errors, since the relocate workload is
// expected to create `result is ambiguous (replica removed)` errors.
cmd = fmt.Sprintf("./workload run kv --tolerate-errors"+
concurrency+duration+readPercent+
" {pgurl:1-%d}", nodes)
start := timeutil.Now()
if err = c.RunE(ctx, option.WithNodes(c.Node(nodes+1)), cmd); err != nil {
return err
}
end := timeutil.Now()
verifyLookupsPerSec(ctx, c, t, c.Node(1), start, end, maximumRangeLookupsPerSec)
return nil
})
<-doneInit
for i := 0; i < workers; i++ {
m.Go(func(ctx context.Context) error {
for {
select {
case <-ctx.Done():
return ctx.Err()
case <-doneWorkload:
return nil
default:
}
conn := conns[c.Range(1, nodes).RandNode()[0]-1]
switch workloadType {
case splitWorkload:
_, err := conn.ExecContext(ctx, `
ALTER TABLE
kv.kv
SPLIT AT
VALUES (CAST(floor(random() * 9223372036854775808) AS INT))
`)
if err != nil && !pgerror.IsSQLRetryableError(err) {
return err
}
case relocateWorkload:
newReplicas := rand.Perm(nodes)[:3]
_, err := conn.ExecContext(ctx, `
ALTER TABLE
kv.kv
EXPERIMENTAL_RELOCATE
SELECT ARRAY[$1, $2, $3], CAST(floor(random() * 9223372036854775808) AS INT)
`, newReplicas[0]+1, newReplicas[1]+1, newReplicas[2]+1)
if err != nil && !pgerror.IsSQLRetryableError(err) && !kv.IsExpectedRelocateError(err) {
return err
}
default:
panic("unexpected")
}
}
})
}
m.Wait()
}
for _, item := range []struct {
workers int
workloadType rangeLookupWorkloadType
maximumRangeLookupsPerSec float64
}{
{2, splitWorkload, 15.0},
// Relocates are expected to fail periodically when relocating random
// ranges, so use more workers.
{4, relocateWorkload, 50.0},
} {
// For use in closure.
item := item
var workloadName string
switch item.workloadType {
case splitWorkload:
workloadName = "split"
case relocateWorkload:
workloadName = "relocate"
default:
panic("unexpected")
}
r.Add(registry.TestSpec{
Name: fmt.Sprintf("kv50/rangelookups/%s/nodes=%d", workloadName, nodes),
Owner: registry.OwnerKV,
Cluster: r.MakeClusterSpec(nodes+1, spec.CPU(cpus)),
CompatibleClouds: registry.AllExceptAWS,
Suites: registry.Suites(registry.Nightly),
Leases: registry.MetamorphicLeases,
Run: func(ctx context.Context, t test.Test, c cluster.Cluster) {
runRangeLookups(ctx, t, c, item.workers, item.workloadType, item.maximumRangeLookupsPerSec)
},
})
}
}
// measureQPS will measure the approx QPS at the time this command is run. The
// duration is the interval to measure over. Setting too short of an interval
// can mean inaccuracy in results. Setting too long of an interval may mean the
// impact is blurred out.
func measureQPS(
ctx context.Context, t test.Test, duration time.Duration, dbs ...*gosql.DB,
) float64 {
currentQPS := func() uint64 {
var value uint64
var wg sync.WaitGroup
wg.Add(len(dbs))
// Count the inserts before sleeping.
for _, db := range dbs {
db := db
go func() {
defer wg.Done()
var v float64
if err := db.QueryRowContext(
ctx, `SELECT sum(value) FROM crdb_internal.node_metrics WHERE name in ('sql.select.count', 'sql.insert.count')`,
).Scan(&v); err != nil {
t.Fatal(err)
}
atomic.AddUint64(&value, uint64(v))
}()
}
wg.Wait()
return value
}
// Measure the current time and the QPS now.
startTime := timeutil.Now()
beforeQPS := currentQPS()
// Wait for the duration minus the first query time.
select {
case <-ctx.Done():
return 0
case <-time.After(duration - timeutil.Since(startTime)):
return float64(currentQPS()-beforeQPS) / duration.Seconds()
}
}
// registerKVRestartImpact measures the impact of stopping and then restarting
// a node during a write-heavy workload. Specifically the Raft log on the node
// falls behind when the node is down and when it comes back up it goes into IO
// Overload as it attempts to recover.
func registerKVRestartImpact(r registry.Registry) {
r.Add(registry.TestSpec{
Name: "kv/restart/nodes=12",
// This test is expensive (104vcpu), we run it weekly. Don't use local SSD
// they are faster and less likely to hit a hard bandwidth limit causing
// LSM inversion (IO overload).
CompatibleClouds: registry.AllExceptAWS,
Suites: registry.Suites(registry.Weekly),
Owner: registry.OwnerAdmissionControl,
Timeout: 4 * time.Hour,
Cluster: r.MakeClusterSpec(13, spec.CPU(8), spec.DisableLocalSSD()),
Leases: registry.MetamorphicLeases,
Run: func(ctx context.Context, t test.Test, c cluster.Cluster) {
nodes := c.Spec().NodeCount - 1
workloadNode := c.Spec().NodeCount
startOpts := option.NewStartOpts(option.NoBackupSchedule)
startOpts.RoachprodOpts.ExtraArgs = append(startOpts.RoachprodOpts.ExtraArgs,
"--vmodule=store_rebalancer=2,allocator=2,allocator_scorer=1,replicate_queue=2,lease=2")
settings := install.MakeClusterSettings()
c.Start(ctx, t.L(), startOpts, settings, c.Range(1, nodes))
// Run long enough to create a large amount of pebble data.
testDuration := 3 * time.Hour
targetQPS := 5000
// Having higher concurrency allows a more consistent QPS.
concurrency := 256
// We need a lot of ranges so that the individual ranges don't get truncated by Raft.
splits := 20000