-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
✨ Surface API Server warnings in client #1468
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
/* | ||
Copyright 2018 The Kubernetes Authors. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
*/ | ||
|
||
package log | ||
|
||
import ( | ||
"sync" | ||
|
||
"github.com/go-logr/logr" | ||
) | ||
|
||
// KubeAPIWarningLoggerOptions controls the behavior | ||
// of a rest.WarningHandler constructed using NewKubeAPIWarningLogger() | ||
type KubeAPIWarningLoggerOptions struct { | ||
// Deduplicate indicates a given warning message should only be written once. | ||
// Setting this to true in a long-running process handling many warnings can | ||
// result in increased memory use. | ||
Deduplicate bool | ||
} | ||
|
||
// KubeAPIWarningLogger is a wrapper around | ||
// a provided logr.Logger that implements the | ||
// rest.WarningHandler interface. | ||
type KubeAPIWarningLogger struct { | ||
// logger is used to log responses with the warning header | ||
logger logr.Logger | ||
// opts contain options controlling warning output | ||
opts KubeAPIWarningLoggerOptions | ||
// writtenLock gurads written | ||
writtenLock sync.Mutex | ||
// used to keep track of already logged messages | ||
// and help in de-duplication. | ||
written map[string]struct{} | ||
} | ||
|
||
// HandleWarningHeader handles logging for responses from API server that are | ||
// warnings with code being 299 and uses a logr.Logger for it's logging purposes. | ||
func (l *KubeAPIWarningLogger) HandleWarningHeader(code int, agent string, message string) { | ||
if code != 299 || len(message) == 0 { | ||
return | ||
} | ||
|
||
if l.opts.Deduplicate { | ||
l.writtenLock.Lock() | ||
defer l.writtenLock.Unlock() | ||
|
||
if _, alreadyLogged := l.written[message]; alreadyLogged { | ||
return | ||
} | ||
l.written[message] = struct{}{} | ||
} | ||
l.logger.Info(message) | ||
} | ||
|
||
// NewKubeAPIWarningLogger returns an implementation of rest.WarningHandler that logs warnings | ||
// with code = 299 to the provided logr.Logger. | ||
func NewKubeAPIWarningLogger(l logr.Logger, opts KubeAPIWarningLoggerOptions) *KubeAPIWarningLogger { | ||
h := &KubeAPIWarningLogger{logger: l, opts: opts} | ||
if opts.Deduplicate { | ||
h.written = map[string]struct{}{} | ||
} | ||
return h | ||
} |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One clarification: if I understand correctly, the
logr.Logger
interface doesn't implement aWarn
level and instead recommends specifying verbosity levels forInfo
logs itself as explained here, so maybe setting a verbosity level usingV
or using coloured output for theInfo
messages that come out of the API Warning Logger?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I see, lets keep it at Info then