Update logging format for federated resource quota #6592
Conversation
karmada-bot
added
the
size/M
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @zzklachlan, I'm Gemini Code Assist1! 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 focuses on updating the logging format within the federated resource quota controllers to support structured JSON logging. The change involves refactoring existing klog calls to use InfoS and ErrorS methods, which accept key-value pairs for better log context and machine readability. This enhancement aims to improve the overall observability and debugging experience for the federated resource quota components.
Highlights
- Structured Logging Adoption: The primary change across the affected files is the migration from traditional
klog.Infofandklog.Errorfcalls to their structured counterparts,klog.InfoSandklog.ErrorS. This enables logs to be output in a machine-readable, key-value pair format, improving parseability and analysis. - Enhanced Error Context: Error logging has been significantly improved by passing the error object directly to
klog.ErrorSand including relevant contextual information as explicit key-value pairs (e.g.,namespacedName,federatedResourceQuota,workNamespace,object). This makes it easier to understand the context of an error without needing to parse complex string messages. - Code Consistency: This update standardizes the logging practices within the
federatedresourcequotacontrollers, aligning them with modern structured logging conventions and promoting better maintainability and observability across the codebase.
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 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 or fill out our survey 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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request refactors logging statements across the federated resource quota controllers to use structured logging (klog.InfoS/ErrorS) instead of formatted string logging (Infof/Errorf). This is a great improvement for log parsing and analysis.
pkg/controllers/federatedresourcequota/federated_resource_quota_enforcement_controller.go
Outdated
Show resolved
Hide resolved
pkg/controllers/federatedresourcequota/federated_resource_quota_enforcement_controller.go
Outdated
Show resolved
Hide resolved
pkg/controllers/federatedresourcequota/federated_resource_quota_status_controller.go
Outdated
Show resolved
Hide resolved
|
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #6592 +/- ##
=======================================
Coverage 45.34% 45.34%
=======================================
Files 687 687
Lines 56393 56383 -10
=======================================
- Hits 25571 25568 -3
+ Misses 29226 29218 -8
- Partials 1596 1597 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Generally looks good to me.
Would you mind squash the commits?
pkg/controllers/federatedresourcequota/federated_resource_quota_status_controller.go
Show resolved
Hide resolved
|
/assign |
Signed-off-by: Kai Zhang <[email protected]> Address gemini code review Signed-off-by: Kai Zhang <[email protected]>
zzklachlan
force-pushed
the
json-logging-federated-resource-quota
branch
from
46899c7 to
4f8892d
Compare
|
@RainbowMango Just squashed all commits. Appreciate it for the review! |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: RainbowMango 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:
Approvers can indicate their approval by writing |
karmada-bot
added
the
approved
What type of PR is this?
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?: