*: add mark function for log desensitization #8306

JmPotato · 2024-06-18T10:11:45Z

What problem does this PR solve?

Issue Number: ref #8305.

What is changed and how does it work?

Provide sensitive log redact marker `‹..›` to customize log desensitization.

Check List

Tests

Unit test
Integration test
Manual test

Release note

Provide sensitive log redact marker `‹..›` to customize log desensitization.

codecov · 2024-06-18T10:21:53Z

Codecov Report

Attention: Patch coverage is 84.70588% with 13 lines in your changes missing coverage. Please review.

Project coverage is 77.37%. Comparing base (e7c9d15) to head (0a4f215).

❗ Current head 0a4f215 differs from pull request most recent head bc2c7d3

Please upload reports for the commit bc2c7d3 to get more accurate results.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #8306      +/-   ##
==========================================
+ Coverage   77.23%   77.37%   +0.13%     
==========================================
  Files         470      470              
  Lines       61572    61404     -168     
==========================================
- Hits        47558    47513      -45     
+ Misses      10426    10324     -102     
+ Partials     3588     3567      -21

Flag	Coverage Δ
unittests	`77.37% <84.70%> (+0.13%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

pkg/utils/configutil/configutil.go

ti-chi-bot · 2024-06-19T08:27:59Z

@okJiang: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

pkg/utils/logutil/log.go

conf/config.toml

pkg/utils/logutil/log.go

okJiang · 2024-07-01T03:19:56Z

pkg/utils/logutil/log_test.go

+		{`false`, RedactInfoLogOFF},
+		{`true`, RedactInfoLogON},
+		{`"MARK"`, RedactInfoLogMark},
+		{`"OTHER"`, RedactInfoLogON},


Why OTHER should be ON?

I consider that if the user uses a string other than true/false and it is not MARK, at least the enabled state should be retained. Of course, this can also be discussed, and I remain open to this.

Just reach an agreement with PM~

I modified the behavior to be consistent with TiDB, only allowing it to be true/false/"MARKER". PTAL.

pkg/utils/logutil/log.go

pkg/utils/logutil/log_test.go

okJiang · 2024-07-01T03:38:46Z

pkg/utils/logutil/log.go

+	rightMark = '›'
+)
+
+func redactInfo(input string) string {


redactInfo just wraps the input with < >, it doesn't allow configuring specific strings to replace values in the logs. This is different from the logic in your code two weeks ago, is this what you expected?

Yes, after discussion with PM, this is the only behavior when MARK is enabled.

After checking the tidb_redact_log, it really is like that. I think it a bit strange, does it have a desensitizing effect?

The purpose of this feature is to allow the cloud or customers to customize how to handle sensitive information. As for the output here in PD, sensitive information will not actually be desensitized; it is up to the user to decide how to handle this sensitive information.

ti-chi-bot · 2024-07-01T03:38:55Z

@okJiang: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Signed-off-by: JmPotato <ghzpotato@gmail.com>

ti-chi-bot · 2024-07-01T05:32:27Z

@okJiang: adding LGTM is restricted to approvers and reviewers in OWNERS files.

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

HuSharp

nit: Can you add to the pr description the log display for different log settings?

ti-chi-bot · 2024-07-01T07:36:33Z

[LGTM Timeline notifier]

Timeline:

2024-07-01 05:37:11.132267098 +0000 UTC m=+1216357.617755925: ☑️ agreed by rleungx.
2024-07-01 07:36:32.296966322 +0000 UTC m=+1223518.782455157: ☑️ agreed by HuSharp.

JmPotato · 2024-07-01T07:43:15Z

nit: Can you add to the pr description the log display for different log settings?

Pasted. PTAL.

/approve

ti-chi-bot · 2024-07-01T09:43:56Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: HuSharp, JmPotato, niubell, okJiang, rleungx

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [HuSharp,JmPotato,rleungx]
~~conf/OWNERS~~ [niubell]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

ti-chi-bot bot added dco-signoff: yes Indicates the PR's author has signed the dco. release-note-none Denotes a PR that doesn't merit a release note. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Jun 18, 2024

ti-chi-bot bot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed release-note-none Denotes a PR that doesn't merit a release note. labels Jun 18, 2024

JmPotato force-pushed the add_log_desen_mark branch 2 times, most recently from 9fb0641 to 08dd6ee Compare June 19, 2024 06:22

JmPotato requested review from nolouch, lhy1024, rleungx and HuSharp June 19, 2024 08:25

okJiang approved these changes Jun 19, 2024

View reviewed changes

pkg/utils/configutil/configutil.go Outdated Show resolved Hide resolved

JmPotato force-pushed the add_log_desen_mark branch from 08dd6ee to 0a4f215 Compare June 19, 2024 09:21

rleungx reviewed Jun 24, 2024

View reviewed changes

pkg/utils/logutil/log.go Outdated Show resolved Hide resolved

JmPotato force-pushed the add_log_desen_mark branch 4 times, most recently from e358430 to 40b826f Compare June 27, 2024 15:00

JmPotato requested review from okJiang and rleungx June 27, 2024 15:06

JmPotato mentioned this pull request Jun 27, 2024

Enhance log desensitization #8305

Closed

5 tasks

okJiang reviewed Jul 1, 2024

View reviewed changes

rleungx reviewed Jul 1, 2024

View reviewed changes

pkg/utils/logutil/log_test.go Outdated Show resolved Hide resolved

okJiang suggested changes Jul 1, 2024

View reviewed changes

JmPotato added 3 commits July 1, 2024 11:53

Add mark function for log desensitization

3c9fecf

Signed-off-by: JmPotato <ghzpotato@gmail.com>

Refine the comments

21aab51

Signed-off-by: JmPotato <ghzpotato@gmail.com>

Unify the redact-info-log

656c565

Signed-off-by: JmPotato <ghzpotato@gmail.com>

JmPotato added 4 commits July 1, 2024 11:53

Fix the JSON marshal/unmarshal

0b9032d

Signed-off-by: JmPotato <ghzpotato@gmail.com>

Improve the robustness of the Unmarshal method

c289b7d

Signed-off-by: JmPotato <ghzpotato@gmail.com>

Refine the code

a38bf1e

Signed-off-by: JmPotato <ghzpotato@gmail.com>

Refine the code according to review comments

2d8bcb0

Signed-off-by: JmPotato <ghzpotato@gmail.com>

JmPotato force-pushed the add_log_desen_mark branch from 0a46d23 to 2d8bcb0 Compare July 1, 2024 03:54

JmPotato requested review from okJiang and rleungx July 1, 2024 04:28

Only allow the config value to be true/false/"MARKER"

bc2c7d3

Signed-off-by: JmPotato <ghzpotato@gmail.com>

okJiang approved these changes Jul 1, 2024

View reviewed changes

rleungx approved these changes Jul 1, 2024

View reviewed changes

ti-chi-bot bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jul 1, 2024

HuSharp approved these changes Jul 1, 2024

View reviewed changes

ti-chi-bot bot added lgtm and removed needs-1-more-lgtm Indicates a PR needs 1 more LGTM. labels Jul 1, 2024

niubell approved these changes Jul 1, 2024

View reviewed changes

ti-chi-bot bot added the approved label Jul 1, 2024

ti-chi-bot bot merged commit b3bccce into tikv:master Jul 1, 2024
17 checks passed

JmPotato deleted the add_log_desen_mark branch July 1, 2024 14:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

*: add mark function for log desensitization #8306

*: add mark function for log desensitization #8306

JmPotato commented Jun 18, 2024 •

edited

Loading

codecov bot commented Jun 18, 2024 •

edited

Loading

ti-chi-bot bot commented Jun 19, 2024

okJiang Jul 1, 2024

JmPotato Jul 1, 2024

okJiang Jul 1, 2024

JmPotato Jul 1, 2024

okJiang Jul 1, 2024

JmPotato Jul 1, 2024

okJiang Jul 1, 2024 •

edited

Loading

JmPotato Jul 1, 2024

okJiang Jul 1, 2024

ti-chi-bot bot commented Jul 1, 2024

ti-chi-bot bot commented Jul 1, 2024

HuSharp left a comment

ti-chi-bot bot commented Jul 1, 2024

JmPotato commented Jul 1, 2024

ti-chi-bot bot commented Jul 1, 2024

*: add mark function for log desensitization #8306

*: add mark function for log desensitization #8306

Conversation

JmPotato commented Jun 18, 2024 • edited Loading

What problem does this PR solve?

What is changed and how does it work?

Check List

Release note

codecov bot commented Jun 18, 2024 • edited Loading

Codecov Report

ti-chi-bot bot commented Jun 19, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

okJiang Jul 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ti-chi-bot bot commented Jul 1, 2024

ti-chi-bot bot commented Jul 1, 2024

HuSharp left a comment

Choose a reason for hiding this comment

ti-chi-bot bot commented Jul 1, 2024

[LGTM Timeline notifier]

JmPotato commented Jul 1, 2024

ti-chi-bot bot commented Jul 1, 2024

JmPotato commented Jun 18, 2024 •

edited

Loading

codecov bot commented Jun 18, 2024 •

edited

Loading

okJiang Jul 1, 2024 •

edited

Loading