forked from cockroachdb/errors
-
Notifications
You must be signed in to change notification settings - Fork 0
/
contexttags.go
102 lines (94 loc) · 2.8 KB
/
contexttags.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
// 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 contexttags
import (
"context"
"github.com/cockroachdb/errors/errbase"
"github.com/cockroachdb/errors/safedetails"
"github.com/cockroachdb/logtags"
)
// WithContextTags captures the k/v pairs stored in the context via the
// `logtags` package and annotates them on the error.
//
// Only the stromg representation of values remains available. This is
// because the library cannot guarantee that the underlying value is
// preserved across the network. To avoid creating a stateful interface
// (where the user code needs to know whether an error has traveled
// through the network or not), the library restricts access to the
// value part as strings. See GetContextTags() below.
//
// Detail is shown:
// - via `errors.GetSafeDetails()`.
// - via `GetContextTags()` below.
// - when formatting with `%+v`.
// - in Sentry reports.
func WithContextTags(err error, ctx context.Context) error {
if err == nil {
return nil
}
tags := logtags.FromContext(ctx)
if tags == nil {
return err
}
return &withContext{cause: err, tags: tags}
}
// GetContextTags retrieves the k/v pairs stored in the error.
// The sets are returned from outermost to innermost level of cause.
// The returned logtags.Buffer only know about the string
// representation of the values originally captured by the error.
func GetContextTags(err error) (res []*logtags.Buffer) {
for e := err; e != nil; e = errbase.UnwrapOnce(e) {
if w, ok := e.(*withContext); ok {
b := w.tags
// Ensure that the buffer does not contain any non-string.
if hasNonStringValue(b) {
b = convertToStringsOnly(b)
}
res = append(res, b)
}
}
return res
}
func hasNonStringValue(b *logtags.Buffer) bool {
for _, t := range b.Get() {
v := t.Value()
if v == nil {
return true
}
if _, ok := v.(string); !ok {
return true
}
}
return false
}
func convertToStringsOnly(b *logtags.Buffer) (res *logtags.Buffer) {
for _, t := range b.Get() {
res = res.Add(t.Key(), t.ValueStr())
}
return res
}
func redactTags(b *logtags.Buffer) []string {
res := make([]string, len(b.Get()))
for i, t := range b.Get() {
res[i] = t.Key()
v := t.Value()
if v != nil {
if len(res[i]) > 1 {
res[i] += "="
}
res[i] += safedetails.Redact(v)
}
}
return res
}