This repository has been archived by the owner on Dec 8, 2021. It is now read-only.
*: redact log and error messages, add log-redact parameter #538
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,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 | ||
|
There was a problem hiding this comment. shall we directly shall the package in br? Since they should be almost the same There was a problem hiding this comment. Some functions are not implemented in br's package. Since these two repositories are going to be merged together, I think we can do the refactor at that time to avoid update the dependencies now. There was a problem hiding this comment. @overvenus FYI about this task. |
||
|
|
||
| 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 "?" | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
stmtshould be redacted too since it contains the rawData