forked from pingcap/tidb-lightning
/
redact.go
89 lines (75 loc) · 2.47 KB
/
redact.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
// Copyright 2020 PingCAP, Inc.
//
// 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,
// See the License for the specific language governing permissions and
// limitations under the License.
package log
import (
"fmt"
"github.com/pingcap/errors"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
)
// InitRedact inits the enableRedactLog
func InitRedact(redactLog bool) {
errors.RedactLogEnabled.Store(redactLog)
}
// NeedRedact returns whether to redact log
func NeedRedact() bool {
return errors.RedactLogEnabled.Load()
}
// ZapRedactBinary receives zap.Binary and return omitted information if redact log enabled
func ZapRedactBinary(key string, val []byte) zapcore.Field {
if NeedRedact() {
return zap.String(key, "?")
}
return zap.Binary(key, val)
}
// ZapRedactArray receives zap.Array and return omitted information if redact log enabled
func ZapRedactArray(key string, val zapcore.ArrayMarshaler) zapcore.Field {
if NeedRedact() {
return zap.String(key, "?")
}
return zap.Array(key, val)
}
// ZapRedactReflect receives zap.Reflect and return omitted information if redact log enabled
func ZapRedactReflect(key string, val interface{}) zapcore.Field {
if NeedRedact() {
return zap.String(key, "?")
}
return zap.Reflect(key, val)
}
// ZapRedactStringer receives stringer argument and return omitted information in zap.Field if redact log enabled
func ZapRedactStringer(key string, arg fmt.Stringer) zap.Field {
return zap.Stringer(key, RedactStringer(arg))
}
// ZapRedactString receives stringer argument and return omitted information in zap.Field if redact log enabled
func ZapRedactString(key string, arg string) zap.Field {
return zap.String(key, RedactString(arg))
}
// RedactString receives string argument and return omitted information if redact log enabled
func RedactString(arg string) string {
if NeedRedact() {
return "?"
}
return arg
}
// RedactStringer receives stringer argument and return omitted information if redact log enabled
func RedactStringer(arg fmt.Stringer) fmt.Stringer {
if NeedRedact() {
return stringer{}
}
return arg
}
type stringer struct{}
// String implement fmt.Stringer
func (s stringer) String() string {
return "?"
}