Create k8s-log-reviewer.md for logging review process#9037
Open
CatherineF-dev wants to merge 1 commit into
Open
Create k8s-log-reviewer.md for logging review process#9037CatherineF-dev wants to merge 1 commit into
CatherineF-dev wants to merge 1 commit into
Conversation
Add guidelines for SIG-Instrumentation logging review process, including structured and contextual logging standards, review checklist, and testing practices.
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: CatherineF-dev The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
k8s-ci-robot
added
size/L
pohly
reviewed
Jun 22, 2026
pohly
left a comment
pohly
left a comment
Contributor
There was a problem hiding this comment.
This seems more targeted towards AI than humans? Just wondering.
Is it possible to do some sanity checking that this is actually producing useful reviews?
| `logcheck.conf` (see #133699, #124722, #115669). | ||
|
|
||
| ### 2. Contextual logging: thread a logger, don't proliferate `WithLogger` variants or break API. | ||
| - Prefer adding a `logger`/`ctx` parameter to a *new/unreleased* function rather than a parallel |
Contributor
There was a problem hiding this comment.
That's typically not possible when converting existing code. Sometimes a new method might be coming anyway, but usually not.
Comment on lines
+33
to
+34
| left-over logger field). A function that logs gets the convention comment | ||
| `// Contextual logging: use NewXWithLogger`. |
Contributor
There was a problem hiding this comment.
Suggested change
| left-over logger field). A function that logs gets the convention comment | |
| `// Contextual logging: use NewXWithLogger`. | |
| left-over logger field). A function that logs initially gets the convention comment | |
| `// Contextual logging: use NewXWithLogger`, then it's callers get updated in a follow-up, PR, | |
| and then finally that comment is turned into `//logcheck:context // use NewXWithLogger ... instead` (https://github.com/kubernetes/kubernetes/issues/126379) |
| ### 8. Testing log output: use `ktesting`, isolated per-test, not the global klog logger. | ||
| - **@pohly** (#138258): ktesting-based tests are *"perfectly isolated from any other test because only | ||
| local variables are used. This is different from testing output emitted through the global klog | ||
| logger."* Prefer `k8s.io/klog/v2/ktesting` / `test/utils/ktesting`. |
Contributor
There was a problem hiding this comment.
Suggested change
| logger."* Prefer `k8s.io/klog/v2/ktesting` / `test/utils/ktesting`. | |
| logger."* Prefer `k8s.io/kubernetes/test/utils/ktesting` over `k8s.io/klog/v2/ktesting` whever import restrictions allow it. |
| local variables are used. This is different from testing output emitted through the global klog | ||
| logger."* Prefer `k8s.io/klog/v2/ktesting` / `test/utils/ktesting`. | ||
|
|
||
| ### 9. Prefer returning an error over logging a swallowed warning. |
Contributor
There was a problem hiding this comment.
Suggested change
| ### 9. Prefer returning an error over logging a swallowed warning. | |
| ### 9. Prefer returning an error over logging and swallowed warning. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Add guidelines for SIG-Instrumentation logging review process, including structured and contextual logging standards, review checklist, and testing practices.
Which issue(s) this PR fixes:
Fixes #9036