Make telemetry keys non-redactable

knz · knz · commit 690e8f75a817 · 2020-09-01T18:15:39.000+02:00
diff --git a/fmttests/testdata/format/wrap-fmt b/fmttests/testdata/format/wrap-fmt
@@ -3380,8 +3380,8 @@ Error types: (1) *telemetrykeys.withTelemetry (2) *fmttests.errFmt
 == printed via redact Printf() %X, refused - good
 == printed via redact Printf() %+v, ok - congruent with %+v
 ‹innerone›
-(1) ‹keys: [somekey outerthree›
-‹  | outerfour]›
+(1) keys: [somekey outerthree
+  | outerfour]
 Wraps: (2) ‹innerone›‹›
 ‹  | innertwo›
 ‹  | -- this is innerone›
diff --git a/fmttests/testdata/format/wrap-fmt-via-network b/fmttests/testdata/format/wrap-fmt-via-network
@@ -5012,8 +5012,8 @@ Error types: (1) *telemetrykeys.withTelemetry (2) *errbase.opaqueLeaf
 == printed via redact Printf() %X, refused - good
 == printed via redact Printf() %+v, ok - congruent with %+v
 ‹innerone›
-(1) ‹keys: [somekey outerthree›
-‹  | outerfour]›
+(1) keys: [somekey outerthree
+  | outerfour]
 Wraps: (2) ‹innerone›
   | ‹innertwo›
   |
diff --git a/fmttests/testdata/format/wrap-goerr b/fmttests/testdata/format/wrap-goerr
@@ -3159,8 +3159,8 @@ Error types: (1) *telemetrykeys.withTelemetry (2) *errors.errorString
 == printed via redact Printf() %X, refused - good
 == printed via redact Printf() %+v, ok - congruent with %+v
 ‹innerone›
-(1) ‹keys: [somekey outerthree›
-‹  | outerfour]›
+(1) keys: [somekey outerthree
+  | outerfour]
 Wraps: (2) ‹innerone›‹›
 ‹  | innertwo›
 Error types: (1) *telemetrykeys.withTelemetry (2) *errors.errorString
diff --git a/fmttests/testdata/format/wrap-goerr-via-network b/fmttests/testdata/format/wrap-goerr-via-network
@@ -3786,8 +3786,8 @@ Error types: (1) *telemetrykeys.withTelemetry (2) *errors.errorString
 == printed via redact Printf() %X, refused - good
 == printed via redact Printf() %+v, ok - congruent with %+v
 ‹innerone›
-(1) ‹keys: [somekey outerthree›
-‹  | outerfour]›
+(1) keys: [somekey outerthree
+  | outerfour]
 Wraps: (2) ‹innerone›‹›
 ‹  | innertwo›
 Error types: (1) *telemetrykeys.withTelemetry (2) *errors.errorString
diff --git a/fmttests/testdata/format/wrap-newf b/fmttests/testdata/format/wrap-newf
@@ -6087,8 +6087,8 @@ new-style ‹innerone›
 == printed via redact Printf() %X, refused - good
 == printed via redact Printf() %+v, ok - congruent with %+v
 new-style ‹innerone›
-(1) ‹keys: [somekey outerthree›
-‹  | outerfour]›
+(1) keys: [somekey outerthree
+  | outerfour]
 Wraps: (2) attached stack trace
   -- stack trace:
   | github.com/cockroachdb/errors/fmttests.glob..func15
diff --git a/fmttests/testdata/format/wrap-newf-via-network b/fmttests/testdata/format/wrap-newf-via-network
@@ -7832,8 +7832,8 @@ new-style ‹innerone›
 == printed via redact Printf() %X, refused - good
 == printed via redact Printf() %+v, ok - congruent with %+v
 new-style ‹innerone›
-(1) ‹keys: [somekey outerthree›
-‹  | outerfour]›
+(1) keys: [somekey outerthree
+  | outerfour]
 Wraps: (2)
   | (opaque error wrapper)
   | type name: github.com/cockroachdb/errors/withstack/*withstack.withStack
diff --git a/fmttests/testdata/format/wrap-nofmt b/fmttests/testdata/format/wrap-nofmt
@@ -3159,8 +3159,8 @@ Error types: (1) *telemetrykeys.withTelemetry (2) *fmttests.errNoFmt
 == printed via redact Printf() %X, refused - good
 == printed via redact Printf() %+v, ok - congruent with %+v
 ‹innerone›
-(1) ‹keys: [somekey outerthree›
-‹  | outerfour]›
+(1) keys: [somekey outerthree
+  | outerfour]
 Wraps: (2) ‹innerone›‹›
 ‹  | innertwo›
 Error types: (1) *telemetrykeys.withTelemetry (2) *fmttests.errNoFmt
diff --git a/fmttests/testdata/format/wrap-nofmt-via-network b/fmttests/testdata/format/wrap-nofmt-via-network
@@ -5012,8 +5012,8 @@ Error types: (1) *telemetrykeys.withTelemetry (2) *errbase.opaqueLeaf
 == printed via redact Printf() %X, refused - good
 == printed via redact Printf() %+v, ok - congruent with %+v
 ‹innerone›
-(1) ‹keys: [somekey outerthree›
-‹  | outerfour]›
+(1) keys: [somekey outerthree
+  | outerfour]
 Wraps: (2) ‹innerone›
   | ‹innertwo›
   |
diff --git a/fmttests/testdata/format/wrap-pkgerr b/fmttests/testdata/format/wrap-pkgerr
@@ -5765,8 +5765,8 @@ Error types: (1) *telemetrykeys.withTelemetry (2) *errors.fundamental
 == printed via redact Printf() %X, refused - good
 == printed via redact Printf() %+v, ok - congruent with %+v
 ‹innerone›
-(1) ‹keys: [somekey outerthree›
-‹  | outerfour]›
+(1) keys: [somekey outerthree
+  | outerfour]
 Wraps: (2) ‹innerone›‹›
 ‹  | innertwo›
 ‹  | github.com/cockroachdb/errors/fmttests.glob..func9›
diff --git a/fmttests/testdata/format/wrap-pkgerr-via-network b/fmttests/testdata/format/wrap-pkgerr-via-network
@@ -7590,8 +7590,8 @@ Error types: (1) *telemetrykeys.withTelemetry (2) *errbase.opaqueLeaf
 == printed via redact Printf() %X, refused - good
 == printed via redact Printf() %+v, ok - congruent with %+v
 ‹innerone›
-(1) ‹keys: [somekey outerthree›
-‹  | outerfour]›
+(1) keys: [somekey outerthree
+  | outerfour]
 Wraps: (2) ‹innerone›
   | ‹innertwo›
   |
diff --git a/telemetrykeys/with_telemetry.go b/telemetrykeys/with_telemetry.go
@@ -32,7 +32,7 @@ type withTelemetry struct {
 var _ error = (*withTelemetry)(nil)
 var _ errbase.SafeDetailer = (*withTelemetry)(nil)
 var _ fmt.Formatter = (*withTelemetry)(nil)
-var _ errbase.Formatter = (*withTelemetry)(nil)
+var _ errbase.SafeFormatter = (*withTelemetry)(nil)
 
 func (w *withTelemetry) Error() string { return w.cause.Error() }
 func (w *withTelemetry) Cause() error  { return w.cause }
@@ -42,7 +42,7 @@ func (w *withTelemetry) SafeDetails() []string { return w.keys }
 
 func (w *withTelemetry) Format(s fmt.State, verb rune) { errbase.FormatError(w, s, verb) }
 
-func (w *withTelemetry) FormatError(p errbase.Printer) (next error) {
+func (w *withTelemetry) SafeFormatError(p errbase.Printer) (next error) {
 	if p.Detail() {
 		p.Printf("keys: [%s]", redact.Safe(strings.Join(w.keys, " ")))
 	}
