kubernetes
/
apiserver
mirror of https://github.com/kubernetes/apiserver.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #106674 from wojtek-t/fix_watch_metrics 

Fix logging resource-scoped watch requests as GET requests.

Kubernetes-commit: efa9f59f218cc0ecdafaaf03774e223bb7a083c2
This commit is contained in:
Kubernetes Publisher 2022-01-05 14:55:55 -08:00
parent 66e1e94d0a 9c968f178e
commit 80a4e7eff8
4 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
go.mod
View File

@ -44,7 +44,7 @@ require (
gopkg.in/natefinch/lumberjack.v2 v2.0.0
gopkg.in/square/go-jose.v2 v2.2.2
k8s.io/api v0.0.0-20220104023900-7289fed567b9
k8s.io/apimachinery v0.0.0-20220104211627-ea11419e6b79
k8s.io/apimachinery v0.0.0-20220105211620-b76ef24635f1
k8s.io/client-go v0.0.0-20220105172055-255c79651356
k8s.io/component-base v0.0.0-20220104212607-e7b8df8cf100
k8s.io/klog/v2 v2.40.1
@ -58,7 +58,7 @@ require (
replace (
k8s.io/api => k8s.io/api v0.0.0-20220104023900-7289fed567b9
k8s.io/apimachinery => k8s.io/apimachinery v0.0.0-20220104211627-ea11419e6b79
k8s.io/apimachinery => k8s.io/apimachinery v0.0.0-20220105211620-b76ef24635f1
k8s.io/client-go => k8s.io/client-go v0.0.0-20220105172055-255c79651356
k8s.io/component-base => k8s.io/component-base v0.0.0-20220104212607-e7b8df8cf100
)

4
go.sum
View File

@ -953,8 +953,8 @@ honnef.co/go/tools v0.0.1-2020.1.3/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9
honnef.co/go/tools v0.0.1-2020.1.4/go.mod h1:X/FiERA/W4tHapMX5mGpAtMSVEeEUOyHaw9vFzvIQ3k=
k8s.io/api v0.0.0-20220104023900-7289fed567b9 h1:HghyPmUKTDSohvaoMdU8NmSTLV3GMrwWfUjJX33U7aE=
k8s.io/api v0.0.0-20220104023900-7289fed567b9/go.mod h1:nKerto6bPj5aBqqPdGEHYEtwdsvWd6LAIUE0QPgQzoE=
k8s.io/apimachinery v0.0.0-20220104211627-ea11419e6b79 h1:vLDmYX/AUxrvjZE7baCJ4xdUMMM2R4hFAOiOTBtNjrk=
k8s.io/apimachinery v0.0.0-20220104211627-ea11419e6b79/go.mod h1:vcZg0n5bcYADuuKUza0y2en2OCM/UIxFaAI7N0cN6Ik=
k8s.io/apimachinery v0.0.0-20220105211620-b76ef24635f1 h1:JN5l8vsJbanXY+UEBvVC2AUaIHfPL64YTlrLGviEBE8=
k8s.io/apimachinery v0.0.0-20220105211620-b76ef24635f1/go.mod h1:vcZg0n5bcYADuuKUza0y2en2OCM/UIxFaAI7N0cN6Ik=
k8s.io/client-go v0.0.0-20220105172055-255c79651356 h1:uNiuxb+Z7sPRSIWJiR20WrwpvSmMT5RMkBaxCdaLS2k=
k8s.io/client-go v0.0.0-20220105172055-255c79651356/go.mod h1:8wJ34MBqSNCHmQ1mGLLHqI68ERylfM0lr3UK2WQOShk=
k8s.io/component-base v0.0.0-20220104212607-e7b8df8cf100 h1:MtcO/Ysm2eaDif2wEngbGDI72FIHId/80y+x0koGLrg=

22
pkg/endpoints/metrics/metrics.go
View File

@ -562,7 +562,7 @@ func CanonicalVerb(verb string, scope string) string {
// LIST and APPLY from PATCH.
func CleanVerb(verb string, request *http.Request) string {
reportedVerb := verb
if verb == "LIST" && checkIfWatch(request) {
if suggestedVerb := getVerbIfWatch(request); suggestedVerb == "WATCH" {
reportedVerb = "WATCH"
}
// normalize the legacy WATCHLIST to WATCH to ensure users aren't surprised by metrics
@ -593,27 +593,19 @@ func cleanVerb(verb, suggestedVerb string, request *http.Request) string {
return OtherRequestMethod
}
//getVerbIfWatch additionally ensures that GET or List would be transformed to WATCH
// getVerbIfWatch additionally ensures that GET or List would be transformed to WATCH
func getVerbIfWatch(req *http.Request) string {
if strings.ToUpper(req.Method) == "GET" || strings.ToUpper(req.Method) == "LIST" {
if checkIfWatch(req) {
return "WATCH"
// see apimachinery/pkg/runtime/conversion.go Convert_Slice_string_To_bool
if values := req.URL.Query()["watch"]; len(values) > 0 {
if value := strings.ToLower(values[0]); value != "0" && value != "false" {
return "WATCH"
}
}
}
return ""
}
//checkIfWatch check request is watch
func checkIfWatch(req *http.Request) bool {
// see apimachinery/pkg/runtime/conversion.go Convert_Slice_string_To_bool
if values := req.URL.Query()["watch"]; len(values) > 0 {
if value := strings.ToLower(values[0]); value != "0" && value != "false" {
return true
}
}
return false
}
func cleanDryRun(u *url.URL) string {
// avoid allocating when we don't see dryRun in the query
if !strings.Contains(u.RawQuery, "dryRun") {

12
pkg/endpoints/metrics/metrics_test.go
View File

@ -49,6 +49,7 @@ func TestCleanVerb(t *testing.T) {
desc: "LIST should be transformed to WATCH if we have the right query param on the request",
initialVerb: "LIST",
request: &http.Request{
Method: "GET",
URL: &url.URL{
RawQuery: "watch=true",
},
@ -59,6 +60,7 @@ func TestCleanVerb(t *testing.T) {
desc: "LIST isn't transformed to WATCH if we have query params that do not include watch",
initialVerb: "LIST",
request: &http.Request{
Method: "GET",
URL: &url.URL{
RawQuery: "blah=asdf&something=else",
},
@ -66,20 +68,25 @@ func TestCleanVerb(t *testing.T) {
expectedVerb: "LIST",
},
{
desc: "GET isn't be transformed to WATCH if we have the right query param on the request",
// The above may seem counter-intuitive, but it actually is needed for cases like
// watching a single item, e.g.:
// /api/v1/namespaces/foo/pods/bar?fieldSelector=metadata.name=baz&watch=true
desc: "GET is transformed to WATCH if we have the right query param on the request",
initialVerb: "GET",
request: &http.Request{
Method: "GET",
URL: &url.URL{
RawQuery: "watch=true",
},
},
expectedVerb: "GET",
expectedVerb: "WATCH",
},
{
desc: "LIST is transformed to WATCH for the old pattern watch",
initialVerb: "LIST",
suggestedVerb: "WATCH",
request: &http.Request{
Method: "GET",
URL: &url.URL{
RawQuery: "/api/v1/watch/pods",
},
@ -91,6 +98,7 @@ func TestCleanVerb(t *testing.T) {
initialVerb: "LIST",
suggestedVerb: "WATCHLIST",
request: &http.Request{
Method: "GET",
URL: &url.URL{
RawQuery: "/api/v1/watch/pods",
},