Use structured logging for cluster taint policy controller

[zhangsquared]

What type of PR is this?

/kind cleanup

What this PR does / why we need it:

JSON logging support. More details are highlighted in #6230.

Which issue(s) this PR fixes:

Fixes #

Part of #6230

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

None

[karmada-bot]

Welcome @zhangsquared! It looks like this is your first PR to karmada-io/karmada 🎉

[karmada-bot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign seanlaii for approval. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

• pkg/controllers/OWNERS

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

[gemini-code-assist]

Summary of Changes

Hello @zhangsquared, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request transitions the cluster taint policy controller to use structured logging. By adopting klog.InfoS and klog.ErrorS, the logs generated by this controller will now include key-value pairs, significantly improving their machine readability and enabling more robust log aggregation and analysis. This change aligns with best practices for observability in cloud-native environments.

Highlights

• Structured Logging Adoption: The ClusterTaintPolicyController has been updated to utilize klog.InfoS and klog.ErrorS for all its logging statements. This change replaces the older klog.Info, klog.Infof, and klog.Errorf calls, thereby introducing structured logging which enhances log parsing and analysis efficiency.
• Error Handling Refinement: The errors package has been imported and is now used to explicitly create an error object for structured logging in cases such as encountering an unsupported MatchCondition operator, providing more context in log entries.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[Copilot]

Pull Request Overview

This PR migrates the ClusterTaintPolicyController to use structured JSON logging via klog.InfoS and klog.ErrorS.

• Replaces unstructured klog.Infof, klog.Errorf, and klog.Info with InfoS, ErrorS, and V().InfoS.
• Adds structured key/value pairs to error and debug logs.
• Introduces an errors import for creating structured error messages.

Comments suppressed due to low confidence (2)

pkg/controllers/taint/clustertaintpolicy_controller.go:73

• [nitpick] The structured log key "clusterTaintPolicyList" is misleading because it logs the ListOptions rather than the policy list. Consider renaming the key to "listOptions" to accurately describe the logged data.

		klog.ErrorS(err, "Failed to list ClusterTaintPolicy", "clusterTaintPolicyList", listOption)

pkg/controllers/taint/clustertaintpolicy_controller.go:239

• [nitpick] The log key "clusterList" refers to the ListOptions being passed, not the retrieved list. Rename the key to "listOptions" for clarity.

				klog.ErrorS(err, "Failed to list Cluster", "clusterList", listOption)

[Copilot]

The ErrorS call sets "operator" as the log message instead of a descriptive message. It should be: ErrorS(err, "Unsupported MatchCondition operator", "operator", matchCondition.Operator) so the message and key/value are correctly ordered.

Suggested change

	klog.ErrorS(errors.New("Unsupported MatchCondition operator"), "operator", matchCondition.Operator)
	klog.ErrorS(errors.New("Unsupported MatchCondition operator"), "Unsupported MatchCondition operator", "operator", matchCondition.Operator)

[gemini-code-assist]

Code Review

The pull request transitions the clusterTaintPolicyController to use structured logging. Key areas for improvement include clarifying key names in structured logs, correctly using klog.InfoS with structured logging, and fixing a bug in one klog.ErrorS call that suppresses the intended error log.

[gemini-code-assist]

The key "clusterTaintPolicyList" is the variable name, but the value being logged is listOption. Consider using a more descriptive key like "listOptions" to avoid confusion.

Suggested change

	klog.ErrorS(err, "Failed to list ClusterTaintPolicy", "clusterTaintPolicyList", listOption)
	klog.ErrorS(err, "Failed to list ClusterTaintPolicy", "listOptions", listOption)

[gemini-code-assist]

The key "clusterList" is the variable name, but the value being logged is listOption. Consider using a more descriptive key like "listOptions" to avoid confusion.

Suggested change

	klog.ErrorS(err, "Failed to list Cluster", "clusterList", listOption)
	klog.ErrorS(err, "Failed to list Cluster", "listOptions", listOption)

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

Attention: Patch coverage is 0% with 8 lines in your changes missing coverage. Please review.

Project coverage is 45.45%. Comparing base (c60a2e0) to head (86ec56a).

Files with missing lines	Patch %	Lines
...controllers/taint/clustertaintpolicy_controller.go	0.00%	8 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #6539      +/-   ##
==========================================
+ Coverage   45.43%   45.45%   +0.02%     
==========================================
  Files         687      687              
  Lines       56334    56334              
==========================================
+ Hits        25594    25608      +14     
+ Misses      29140    29129      -11     
+ Partials     1600     1597       -3     

Flag	Coverage Δ
unittests	45.45% <0.00%> (+0.02%)	⬆️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[karmada-bot]

Keywords which can automatically close issues and at(@) or hashtag(#) mentions are not allowed in commit messages.

The list of commits with invalid commit messages:

• d77dedc Update pkg/controllers/taint/clustertaintpolicy_controller.go

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-sigs/prow repository. I understand the commands that are listed here.

[karmada-bot]

Adding label do-not-merge/contains-merge-commits because PR contains merge commits, which are not allowed in this repository.
Use git rebase to reapply your commits on top of the target branch. Detailed instructions for doing so can be found here.

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-sigs/prow repository.