github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2026-07-23 19:16:25 +00:00
Code Issues Projects Releases Wiki Activity

client-go auth: contextual logging

Browse Source 
No API changes are needed. In one case, a context is passed in via the
http.Request. In others there is simply no need to change the calls.
This commit is contained in:
Patrick Ohly
2024-12-09 12:56:03 +01:00
parent 0690af4710
commit 4f241c04af
5 changed files with 13 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
staging/src/k8s.io/client-go/plugin/pkg/client/auth/azure/azure_stub.go
View File

@@ -25,6 +25,7 @@ import (
func init() {
if err := rest.RegisterAuthProviderPlugin("azure", newAzureAuthProvider); err != nil {
//nolint:logcheck // Should not happen.
klog.Fatalf("Failed to register azure auth plugin: %v", err)
}
}

3
staging/src/k8s.io/client-go/plugin/pkg/client/auth/exec/exec.go
View File

@@ -363,6 +363,7 @@ func (r *roundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
return r.base.RoundTrip(req)
}
ctx := req.Context()
creds, err := r.a.getCreds()
if err != nil {
return nil, fmt.Errorf("getting credentials: %v", err)
@@ -377,7 +378,7 @@ func (r *roundTripper) RoundTrip(req *http.Request) (*http.Response, error) {
}
if res.StatusCode == http.StatusUnauthorized {
if err := r.a.maybeRefreshCreds(creds); err != nil {
klog.Errorf("refreshing credentials: %v", err)
klog.FromContext(ctx).Error(err, "Refreshing credentials failed")
}
}
return res, nil

6
staging/src/k8s.io/client-go/plugin/pkg/client/auth/exec/metrics.go
View File

@@ -112,7 +112,11 @@ func incrementCallsMetric(err error) {
metrics.ExecPluginCalls.Increment(failureExitCode, pluginNotFoundError)
default: // We don't know about this error type.
klog.V(2).InfoS("unexpected exec plugin return error type", "type", reflect.TypeOf(err).String(), "err", err)
// TODO (?): this code gets called through
// https://github.com/kubernetes/kubernetes/blob/8a5cf7b66f4bf8c76c4a78e249ee7c21f7d7403e/staging/src/k8s.io/client-go/transport/config.go#L152-L154
// which would have to be changed to accept a context.
// Probably not worth it?
klog.TODO().V(2).Info("unexpected exec plugin return error type", "type", reflect.TypeOf(err).String(), "err", err)
metrics.ExecPluginCalls.Increment(failureExitCode, clientInternalError)
}
}

1
staging/src/k8s.io/client-go/plugin/pkg/client/auth/gcp/gcp_stub.go
View File

@@ -25,6 +25,7 @@ import (
func init() {
if err := rest.RegisterAuthProviderPlugin("gcp", newGCPAuthProvider); err != nil {
//nolint:logcheck // Should not happen.
klog.Fatalf("Failed to register gcp auth plugin: %v", err)
}
}

6
staging/src/k8s.io/client-go/plugin/pkg/client/auth/oidc/oidc.go
View File

@@ -49,6 +49,7 @@ const (
func init() {
if err := restclient.RegisterAuthProviderPlugin("oidc", newOIDCAuthProvider); err != nil {
//nolint:logcheck // Should not happen.
klog.Fatalf("Failed to register oidc auth plugin: %v", err)
}
}
@@ -125,8 +126,9 @@ func newOIDCAuthProvider(clusterAddress string, cfg map[string]string, persister
}
if len(cfg[cfgExtraScopes]) > 0 {
klog.V(2).Infof("%s auth provider field depricated, refresh request don't send scopes",
cfgExtraScopes)
// TODO (?): the auth provider factory API would have to be changed
// to support contextual logging here. Not worth it?
klog.TODO().V(2).Info("Ignoring deprecated extra scopes, refresh request don't send scopes", "ignoredConfigField", cfgExtraScopes)
}
var certAuthData []byte