Skip to content

Commit 0f47d28

Browse files
committed
Cleanup webhook logging
1 parent 92646a5 commit 0f47d28

File tree

6 files changed

+11
-8
lines changed

6 files changed

+11
-8
lines changed

pkg/builder/webhook.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,7 @@ func (blder *WebhookBuilder) setLogConstructor() {
115115
blder.gvk.Kind, klog.KRef(req.Namespace, req.Name),
116116
"namespace", req.Namespace, "name", req.Name,
117117
"resource", req.Resource, "user", req.UserInfo.Username,
118+
"requestID", req.UID,
118119
)
119120
}
120121
return log

pkg/webhook/admission/http.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ func (wh *Webhook) ServeHTTP(w http.ResponseWriter, r *http.Request) {
6969
// verify the content type is accurate
7070
if contentType := r.Header.Get("Content-Type"); contentType != "application/json" {
7171
err = fmt.Errorf("contentType=%s, expected application/json", contentType)
72-
wh.getLogger(nil).Error(err, "unable to process a request with an unknown content type", "content type", contentType)
72+
wh.getLogger(nil).Error(err, "unable to process a request with unknown content type")
7373
reviewResponse = Errored(http.StatusBadRequest, err)
7474
wh.writeResponse(w, reviewResponse)
7575
return
@@ -93,7 +93,7 @@ func (wh *Webhook) ServeHTTP(w http.ResponseWriter, r *http.Request) {
9393
wh.writeResponse(w, reviewResponse)
9494
return
9595
}
96-
wh.getLogger(nil).V(1).Info("received request", "UID", req.UID, "kind", req.Kind, "resource", req.Resource)
96+
wh.getLogger(&req).V(1).Info("received request")
9797

9898
reviewResponse = wh.Handle(ctx, req)
9999
wh.writeResponseTyped(w, reviewResponse, actualAdmRevGVK)
@@ -140,7 +140,7 @@ func (wh *Webhook) writeAdmissionResponse(w io.Writer, ar v1.AdmissionReview) {
140140
if res.Result != nil {
141141
log = log.WithValues("code", res.Result.Code, "reason", res.Result.Reason, "message", res.Result.Message)
142142
}
143-
log.V(1).Info("wrote response", "UID", res.UID, "allowed", res.Allowed)
143+
log.V(1).Info("wrote response", "requestID", res.UID, "allowed", res.Allowed)
144144
}
145145
}
146146
}

pkg/webhook/admission/webhook.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ import (
3030
"k8s.io/apimachinery/pkg/util/json"
3131
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
3232
"k8s.io/klog/v2"
33+
3334
logf "sigs.k8s.io/controller-runtime/pkg/log"
3435
"sigs.k8s.io/controller-runtime/pkg/webhook/internal/metrics"
3536
)
@@ -163,7 +164,6 @@ func (wh *Webhook) Handle(ctx context.Context, req Request) (response Response)
163164
}
164165

165166
reqLog := wh.getLogger(&req)
166-
reqLog = reqLog.WithValues("requestID", req.UID)
167167
ctx = logf.IntoContext(ctx, reqLog)
168168

169169
resp := wh.Handler.Handle(ctx, req)
@@ -196,6 +196,7 @@ func DefaultLogConstructor(base logr.Logger, req *Request) logr.Logger {
196196
return base.WithValues("object", klog.KRef(req.Namespace, req.Name),
197197
"namespace", req.Namespace, "name", req.Name,
198198
"resource", req.Resource, "user", req.UserInfo.Username,
199+
"requestID", req.UID,
199200
)
200201
}
201202
return base

pkg/webhook/admission/webhook_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ var _ = Describe("Admission Webhooks", func() {
182182
}
183183
}),
184184
LogConstructor: func(base logr.Logger, req *Request) logr.Logger {
185-
return base.WithValues("operation", req.Operation)
185+
return base.WithValues("operation", req.Operation, "requestID", req.UID)
186186
},
187187
log: testLogger,
188188
}

pkg/webhook/authentication/http.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ func (wh *Webhook) ServeHTTP(w http.ResponseWriter, r *http.Request) {
6969
// verify the content type is accurate
7070
if contentType := r.Header.Get("Content-Type"); contentType != "application/json" {
7171
err = fmt.Errorf("contentType=%s, expected application/json", contentType)
72-
wh.getLogger(nil).Error(err, "unable to process a request with an unknown content type", "content type", contentType)
72+
wh.getLogger(nil).Error(err, "unable to process a request with unknown content type")
7373
reviewResponse = Errored(err)
7474
wh.writeResponse(w, reviewResponse)
7575
return
@@ -94,7 +94,7 @@ func (wh *Webhook) ServeHTTP(w http.ResponseWriter, r *http.Request) {
9494
wh.writeResponse(w, reviewResponse)
9595
return
9696
}
97-
wh.getLogger(&req).V(1).Info("received request", "UID", req.UID, "kind", req.Kind)
97+
wh.getLogger(&req).V(1).Info("received request")
9898

9999
if req.Spec.Token == "" {
100100
err = errors.New("token is empty")
@@ -136,7 +136,7 @@ func (wh *Webhook) writeTokenResponse(w io.Writer, ar authenticationv1.TokenRevi
136136
}
137137
res := ar
138138
if wh.getLogger(nil).V(1).Enabled() {
139-
wh.getLogger(nil).V(1).Info("wrote response", "UID", res.UID, "authenticated", res.Status.Authenticated)
139+
wh.getLogger(nil).V(1).Info("wrote response", "requestID", res.UID, "authenticated", res.Status.Authenticated)
140140
}
141141
}
142142

pkg/webhook/authentication/webhook.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ func logConstructor(base logr.Logger, req *Request) logr.Logger {
119119
return base.WithValues("object", klog.KRef(req.Namespace, req.Name),
120120
"namespace", req.Namespace, "name", req.Name,
121121
"user", req.Status.User.Username,
122+
"requestID", req.UID,
122123
)
123124
}
124125
return base

0 commit comments

Comments
 (0)