release-20.2: keys: avoid creating invalid utf-8 sequences in logs #54272
Conversation
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
Prior to this patch, the algorithm to truncate the pretty-print representation of range start/end keys was able to produce invalid utf-8 sequences, which were then included via context tags and log messages pretty frequently in logs. This had two shortcomings, one minor and one major: - the minor shortcomings is that some text editors refuse to open a text file containing invalid utf-8 sequences as "text", which makes it extra hard to quickly navigate through files in e.g. a `cockroach debug zip` output. - it could cause 3rd party consumers of log files with redaction markers to miss the start or end of redaction boundaries and thus mis-redact. (The go reader is immune to this, but we want to advertise the log format.) Release justification: bug fix Release note: None
|
This change is |
|
LGTM, but subject to release backport approval |
40 tasks
|
cc @nvanbenschoten TL in this area |
nvanbenschoten
approved these changes
Sep 11, 2020
|
i thought you had to wait for release to sign off if it isn't a release blocker before merging |
oops I was not aware. I'm going to review the process. Thanks for the heads up. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Backport 1/1 commits from #53973.
/cc @cockroachdb/release