Initial commit

vendor/github.com/cockroachdb/errors/telemetrykeys/telemetrykeys.go

@@ -0,0 +1,52 @@
+// Copyright 2019 The Cockroach Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+// implied. See the License for the specific language governing
+// permissions and limitations under the License.
+
+package telemetrykeys
+
+import "github.com/cockroachdb/errors/errbase"
+
+// WithTelemetry annotates err with the given telemetry key(s).
+// The telemetry keys must be PII-free.
+//
+// Detail is shown:
+// - via `errors.GetSafeDetails()`.
+// - via `GetTelemetryKeys()` below.
+// - when formatting with `%+v`.
+// - in Sentry reports.
+func WithTelemetry(err error, keys ...string) error {
+	if err == nil {
+		return nil
+	}
+
+	return &withTelemetry{cause: err, keys: keys}
+}
+
+// GetTelemetryKeys retrieves the (de-duplicated) set of
+// all telemetry keys present in the direct causal chain
+// of the error. The keys may not be sorted.
+func GetTelemetryKeys(err error) []string {
+	keys := map[string]struct{}{}
+	for ; err != nil; err = errbase.UnwrapOnce(err) {
+		if w, ok := err.(*withTelemetry); ok {
+			for _, k := range w.keys {
+				keys[k] = struct{}{}
+			}
+		}
+	}
+	res := make([]string, 0, len(keys))
+	for k := range keys {
+		res = append(res, k)
+	}
+	return res
+}

vendor/github.com/cockroachdb/errors/telemetrykeys/with_telemetry.go

@@ -0,0 +1,60 @@
+// Copyright 2019 The Cockroach Authors.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+// implied. See the License for the specific language governing
+// permissions and limitations under the License.
+
+package telemetrykeys
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	"github.com/cockroachdb/errors/errbase"
+	"github.com/cockroachdb/redact"
+	"github.com/gogo/protobuf/proto"
+)
+
+type withTelemetry struct {
+	cause error
+	keys  []string
+}
+
+var _ error = (*withTelemetry)(nil)
+var _ errbase.SafeDetailer = (*withTelemetry)(nil)
+var _ fmt.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 }
+func (w *withTelemetry) Unwrap() error { return w.cause }
+
+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) SafeFormatError(p errbase.Printer) (next error) {
+	if p.Detail() {
+		p.Printf("keys: [%s]", redact.Safe(strings.Join(w.keys, " ")))
+	}
+	return w.cause
+}
+
+func decodeWithTelemetry(
+	_ context.Context, cause error, _ string, keys []string, _ proto.Message,
+) error {
+	return &withTelemetry{cause: cause, keys: keys}
+}
+
+func init() {
+	errbase.RegisterWrapperDecoder(errbase.GetTypeKey((*withTelemetry)(nil)), decodeWithTelemetry)
+}