Skip to content

Commit b678837

Browse files
committed
pkg/roachpb: implement SafeFormat for additional types
Implemented SafeFormat method for the following types: * Span * RSpan * LockAcquisition Additionally, added assertions for the redact.SafeFormatter interface for these and other types. This enhances logging safety by ensuring the proper redaction of sensitive information. Naturally, this required updating a few test fixtures. This commit includes those changes as well. Fixes: CRDB-51160 Epic: CRDB-37533 Release note: None
1 parent 4803923 commit b678837

File tree

83 files changed

+518
-494
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

83 files changed

+518
-494
lines changed

pkg/kv/kvpb/errors_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ func TestErrorRedaction(t *testing.T) {
284284
},
285285
{
286286
err: &BatchTimestampBeforeGCError{},
287-
expect: "batch timestamp 0,0 must be after replica GC threshold 0,0 (r0: /Min)",
287+
expect: "batch timestamp 0,0 must be after replica GC threshold 0,0 (r0: /Min)",
288288
},
289289
{
290290
err: &TxnAlreadyEncounteredErrorError{},
@@ -324,7 +324,7 @@ func TestErrorRedaction(t *testing.T) {
324324
},
325325
{
326326
err: &MVCCHistoryMutationError{},
327-
expect: "unexpected MVCC history mutation in span /Min",
327+
expect: "unexpected MVCC history mutation in span /Min",
328328
},
329329
{
330330
err: &UnhandledRetryableError{},
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
echo
22
----
33
replica unavailable: (n1,s2):3 unable to serve request to r123:/M{in-ax} [(n1,s2):1, next=2, gen=0]: slow proposal
4-
replica unavailable: (n1,s2):3 unable to serve request to r123:/M{in-ax} [(n1,s2):1, next=2, gen=0]: slow proposal
4+
replica unavailable: (n1,s2):3 unable to serve request to r123:/M{in-ax} [(n1,s2):1, next=2, gen=0]: slow proposal

pkg/kv/kvserver/concurrency/testdata/concurrency_manager/barrier

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ sequence req=barrier2
5353
----
5454
[2] sequence barrier2: sequencing request
5555
[2] sequence barrier2: waiting on latches without acquiring
56-
[2] sequence barrier2: waiting to acquire write latch ‹{a-f}›@0,0 for request Barrier [‹"a"›,‹"f"›), held by read latch ‹c›@15.000000000,1 for request Get [‹"c"›]
56+
[2] sequence barrier2: waiting to acquire write latch {‹a›-‹f›}@0,0 for request Barrier [‹"a"›,‹"f"›), held by read latch ‹c›@15.000000000,1 for request Get [‹"c"›]
5757
[2] sequence barrier2: blocked on select in spanlatch.(*Manager).waitForSignal
5858

5959
finish req=read1
@@ -96,7 +96,7 @@ sequence req=barrier1
9696
----
9797
[2] sequence barrier1: sequencing request
9898
[2] sequence barrier1: waiting on latches without acquiring
99-
[2] sequence barrier1: waiting to acquire write latch ‹{a-f}›@0,0 for request Barrier [‹"a"›,‹"f"›), held by read latch ‹c›@10.000000000,1 for request Get [‹"c"›]
99+
[2] sequence barrier1: waiting to acquire write latch {‹a›-‹f›}@0,0 for request Barrier [‹"a"›,‹"f"›), held by read latch ‹c›@10.000000000,1 for request Get [‹"c"›]
100100
[2] sequence barrier1: blocked on select in spanlatch.(*Manager).waitForSignal
101101

102102
finish req=read1
@@ -143,7 +143,7 @@ sequence req=barrier1
143143
----
144144
[2] sequence barrier1: sequencing request
145145
[2] sequence barrier1: waiting on latches without acquiring
146-
[2] sequence barrier1: waiting to acquire write latch ‹{a-f}›@0,0 for request Barrier [‹"a"›,‹"f"›), held by write latch ‹c›@10.000000000,1 for request Put [‹"c"›], [txn: 00000001]
146+
[2] sequence barrier1: waiting to acquire write latch {‹a›-‹f›}@0,0 for request Barrier [‹"a"›,‹"f"›), held by write latch ‹c›@10.000000000,1 for request Put [‹"c"›], [txn: 00000001]
147147
[2] sequence barrier1: blocked on select in spanlatch.(*Manager).waitForSignal
148148

149149
debug-latch-manager

pkg/kv/kvserver/concurrency/testdata/concurrency_manager/basic

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ sequence req=req4
143143
----
144144
[3] sequence req4: sequencing request
145145
[3] sequence req4: acquiring latches
146-
[3] sequence req4: waiting to acquire write latch ‹k›@10.000000000,1 for request Put [‹"k"›], [txn: 00000001], held by read latch ‹k{-2}›@14.000000000,1 for request Get [‹"k"›], Scan [‹"k"›,‹"k2"›), [txn: 00000003]
146+
[3] sequence req4: waiting to acquire write latch ‹k›@10.000000000,1 for request Put [‹"k"›], [txn: 00000001], held by read latch ‹k›{-‹2›}@14.000000000,1 for request Get [‹"k"›], Scan [‹"k"›,‹"k2"›), [txn: 00000003]
147147
[3] sequence req4: blocked on select in spanlatch.(*Manager).waitForSignal
148148

149149
debug-latch-manager
@@ -251,13 +251,13 @@ sequence req=req7
251251
----
252252
[4] sequence req7: sequencing request
253253
[4] sequence req7: acquiring latches
254-
[4] sequence req7: waiting to acquire write latch ‹k›@12.000000000,1 for request Put [‹"k"›], held by read latch ‹{a-m}›@14.000000000,1 for request Scan [‹"a"›,‹"m"›)
254+
[4] sequence req7: waiting to acquire write latch ‹k›@12.000000000,1 for request Put [‹"k"›], held by read latch {‹a›-‹m›}@14.000000000,1 for request Scan [‹"a"›,‹"m"›)
255255
[4] sequence req7: blocked on select in spanlatch.(*Manager).waitForSignal
256256

257257
finish req=req5
258258
----
259259
[-] finish req5: finishing request
260-
[4] sequence req7: waiting to acquire write latch ‹k›@12.000000000,1 for request Put [‹"k"›], held by read latch ‹{c-z}›@16.000000000,1 for request Scan [‹"c"›,‹"z"›)
260+
[4] sequence req7: waiting to acquire write latch ‹k›@12.000000000,1 for request Put [‹"k"›], held by read latch {‹c›-‹z›}@16.000000000,1 for request Scan [‹"c"›,‹"z"›)
261261
[4] sequence req7: blocked on select in spanlatch.(*Manager).waitForSignal
262262

263263
finish req=req6

pkg/kv/kvserver/concurrency/testdata/concurrency_manager/optimistic

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ sequence req=req6 eval-kind=pess-after-opt
172172
----
173173
[8] sequence req6: re-sequencing request after optimistic sequencing failed
174174
[8] sequence req6: optimistic failed, so waiting for latches
175-
[8] sequence req6: waiting to acquire read latch ‹{a-e}›@12.000000000,1 for request Scan [‹"a"›,‹"e"›), [txn: 00000002], held by write latch ‹d›@10.000000000,1 for request Put [‹"d"›], [txn: 00000003]
175+
[8] sequence req6: waiting to acquire read latch {‹a›-‹e›}@12.000000000,1 for request Scan [‹"a"›,‹"e"›), [txn: 00000002], held by write latch ‹d›@10.000000000,1 for request Put [‹"d"›], [txn: 00000003]
176176
[8] sequence req6: blocked on select in spanlatch.(*Manager).waitForSignal
177177

178178
debug-advance-clock ts=123

pkg/kv/kvserver/concurrency/testdata/concurrency_manager/poison_policy_err

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ sequence req=readbf
2727
----
2828
[2] sequence readbf: sequencing request
2929
[2] sequence readbf: acquiring latches
30-
[2] sequence readbf: waiting to acquire read latch ‹{b-f}›@11.000000000,1 for request Scan [‹"b"›,‹"f"›), held by write latch ‹c›@10.000000000,0 for request Put [‹"c"›]
30+
[2] sequence readbf: waiting to acquire read latch {‹b›-‹f›}@11.000000000,1 for request Scan [‹"b"›,‹"f"›), held by write latch ‹c›@10.000000000,0 for request Put [‹"c"›]
3131
[2] sequence readbf: blocked on select in spanlatch.(*Manager).waitForSignal
3232

3333
new-request txn=none name=pute ts=11,0
@@ -38,7 +38,7 @@ sequence req=pute
3838
----
3939
[3] sequence pute: sequencing request
4040
[3] sequence pute: acquiring latches
41-
[3] sequence pute: waiting to acquire write latch ‹e›@11.000000000,0 for request Put [‹"e"›], held by read latch ‹{b-f}›@11.000000000,1 for request Scan [‹"b"›,‹"f"›)
41+
[3] sequence pute: waiting to acquire write latch ‹e›@11.000000000,0 for request Put [‹"e"›], held by read latch {‹b›-‹f›}@11.000000000,1 for request Scan [‹"b"›,‹"f"›)
4242
[3] sequence pute: blocked on select in spanlatch.(*Manager).waitForSignal
4343

4444
poison req=putc

pkg/kv/kvserver/concurrency/testdata/concurrency_manager/poison_policy_err_indirect

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ sequence req=readbf
2626
----
2727
[2] sequence readbf: sequencing request
2828
[2] sequence readbf: acquiring latches
29-
[2] sequence readbf: waiting to acquire read latch ‹{b-f}›@11.000000000,1 for request Scan [‹"b"›,‹"f"›), held by write latch ‹c›@10.000000000,0 for request Put [‹"c"›]
29+
[2] sequence readbf: waiting to acquire read latch {‹b›-‹f›}@11.000000000,1 for request Scan [‹"b"›,‹"f"›), held by write latch ‹c›@10.000000000,0 for request Put [‹"c"›]
3030
[2] sequence readbf: blocked on select in spanlatch.(*Manager).waitForSignal
3131

3232
new-request txn=none name=pute ts=11,0
@@ -37,15 +37,15 @@ sequence req=pute
3737
----
3838
[3] sequence pute: sequencing request
3939
[3] sequence pute: acquiring latches
40-
[3] sequence pute: waiting to acquire write latch ‹e›@11.000000000,0 for request Put [‹"e"›], held by read latch ‹{b-f}›@11.000000000,1 for request Scan [‹"b"›,‹"f"›)
40+
[3] sequence pute: waiting to acquire write latch ‹e›@11.000000000,0 for request Put [‹"e"›], held by read latch {‹b›-‹f›}@11.000000000,1 for request Scan [‹"b"›,‹"f"›)
4141
[3] sequence pute: blocked on select in spanlatch.(*Manager).waitForSignal
4242

4343
poison req=putc
4444
----
4545
[-] poison putc: poisoning request
4646
[2] sequence readbf: encountered poisoned latch; continuing to wait
4747
[2] sequence readbf: blocked on select in spanlatch.(*Manager).waitForSignal
48-
[3] sequence pute: sequencing complete, returned error: encountered poisoned latch ‹{b-f}›@11.000000000,1
48+
[3] sequence pute: sequencing complete, returned error: encountered poisoned latch {‹b›-‹f›}@11.000000000,1
4949

5050
finish req=putc
5151
----

pkg/kv/kvserver/concurrency/testdata/concurrency_manager/poison_policy_wait_disjoint

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ sequence req=readbf
2626
----
2727
[2] sequence readbf: sequencing request
2828
[2] sequence readbf: acquiring latches
29-
[2] sequence readbf: waiting to acquire read latch ‹{b-f}›@11.000000000,1 for request Scan [‹"b"›,‹"f"›), held by write latch ‹c›@10.000000000,0 for request Put [‹"c"›]
29+
[2] sequence readbf: waiting to acquire read latch {‹b›-‹f›}@11.000000000,1 for request Scan [‹"b"›,‹"f"›), held by write latch ‹c›@10.000000000,0 for request Put [‹"c"›]
3030
[2] sequence readbf: blocked on select in spanlatch.(*Manager).waitForSignal
3131

3232
new-request txn=none name=pute ts=11,0 poison-policy=wait
@@ -37,7 +37,7 @@ sequence req=pute
3737
----
3838
[3] sequence pute: sequencing request
3939
[3] sequence pute: acquiring latches
40-
[3] sequence pute: waiting to acquire write latch ‹e›@11.000000000,0 for request Put [‹"e"›], held by read latch ‹{b-f}›@11.000000000,1 for request Scan [‹"b"›,‹"f"›)
40+
[3] sequence pute: waiting to acquire write latch ‹e›@11.000000000,0 for request Put [‹"e"›], held by read latch {‹b›-‹f›}@11.000000000,1 for request Scan [‹"b"›,‹"f"›)
4141
[3] sequence pute: blocked on select in spanlatch.(*Manager).waitForSignal
4242

4343
poison req=putc

pkg/kv/kvserver/concurrency/testdata/concurrency_manager/poison_policy_wait_overlapping

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ sequence req=readbf
2626
----
2727
[2] sequence readbf: sequencing request
2828
[2] sequence readbf: acquiring latches
29-
[2] sequence readbf: waiting to acquire read latch ‹{b-f}›@11.000000000,1 for request Scan [‹"b"›,‹"f"›), held by write latch ‹c›@10.000000000,0 for request Put [‹"c"›]
29+
[2] sequence readbf: waiting to acquire read latch {‹b›-‹f›}@11.000000000,1 for request Scan [‹"b"›,‹"f"›), held by write latch ‹c›@10.000000000,0 for request Put [‹"c"›]
3030
[2] sequence readbf: blocked on select in spanlatch.(*Manager).waitForSignal
3131

3232
new-request txn=none name=put2 ts=11,0 poison-policy=wait

pkg/kv/kvserver/concurrency/testdata/concurrency_manager/shared_locks_latches

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -696,7 +696,7 @@ sequence req=req36
696696
----
697697
[36] sequence req36: sequencing request
698698
[36] sequence req36: acquiring latches
699-
[36] sequence req36: waiting to acquire write latch /Local/RangeID/1/r/ReplicatedSharedLocksTransactionLatch/"00000002-0000-0000-0000-000000000000"@0,0 for request Scan(Shared,Replicated) [‹"a"›,‹"f"›), [txn: 00000002], held by write latch /Local/RangeID/1/r/ReplicatedSharedLocksTransactionLatch/"00000002-0000-0000-0000-000000000000"@0,0 for request Get(Shared,Replicated) [‹"c"›], [txn: 00000002]
699+
[36] sequence req36: waiting to acquire write latch /Local/RangeID‹/1›/‹r›/‹ReplicatedSharedLocksTransactionLatch/"00000002-0000-0000-0000-000000000000"@0,0 for request Scan(Shared,Replicated) [‹"a"›,‹"f"›), [txn: 00000002], held by write latch /Local/RangeID‹/1›/‹r›/‹ReplicatedSharedLocksTransactionLatch/"00000002-0000-0000-0000-000000000000"@0,0 for request Get(Shared,Replicated) [‹"c"›], [txn: 00000002]
700700
[36] sequence req36: blocked on select in spanlatch.(*Manager).waitForSignal
701701

702702
new-request name=req37 txn=txn1 ts=11,1

0 commit comments

Comments
 (0)