github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-21 10:51:29 +00:00
Code Issues Projects Releases Wiki Activity

Improve docs for client-go warning handlers

Browse Source
This commit is contained in:
Jordan Liggitt 2020-08-29 10:40:33 -04:00
parent d9789c4fa3
commit b0573d526d
2 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
staging/src/k8s.io/client-go/rest/config.go
View File

@ -125,6 +125,7 @@ type Config struct {
// WarningHandler handles warnings in server responses. // WarningHandler handles warnings in server responses.
// If not set, the default warning handler is used. // If not set, the default warning handler is used.
// See documentation for SetDefaultWarningHandler() for details.
WarningHandler WarningHandler WarningHandler WarningHandler
// The maximum length of time to wait before giving up on a server request. A value of zero means no timeout. // The maximum length of time to wait before giving up on a server request. A value of zero means no timeout.

7
staging/src/k8s.io/client-go/rest/warnings.go
View File

@ -38,8 +38,11 @@ var (
defaultWarningHandlerLock sync.RWMutex defaultWarningHandlerLock sync.RWMutex
) )
// SetDefaultWarningHandler sets the default handler client uses when warning headers are encountered. // SetDefaultWarningHandler sets the default handler clients use when warning headers are encountered.
// By default, warnings are printed to stderr. // By default, warnings are logged. Several built-in implementations are provided:
// - NoWarnings suppresses warnings.
// - WarningLogger logs warnings.
// - NewWarningWriter() outputs warnings to the provided writer.
func SetDefaultWarningHandler(l WarningHandler) { func SetDefaultWarningHandler(l WarningHandler) {
defaultWarningHandlerLock.Lock() defaultWarningHandlerLock.Lock()
defer defaultWarningHandlerLock.Unlock() defer defaultWarningHandlerLock.Unlock()