Skip to content
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.

Sign up for GitHub

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

Improve HTTP method label handling in prometheus metrics #12638

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve HTTP method label handling in prometheus metrics #12638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions internal/ingress/metric/collectors/socket.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import (
"io"
"net"
"os"
"slices"
"strings"
"syscall"

Expand Down Expand Up @@ -98,6 +99,19 @@ var requestTags = []string{
"canary",
}

var validHTTPMethods = []string{
// Unless otherwise noted, these are defined in RFC 7231 section 4.3.
"GET",
"HEAD",
"POST",
"PUT",
"PATCH", // RFC 5789
"DELETE",
"CONNECT",
"OPTIONS",
"TRACE",
}

// NewSocketCollector creates a new SocketCollector instance using
// the ingress watch namespace and class used by the controller
func NewSocketCollector(pod, namespace, class string, metricsPerHost, metricsPerUndefinedHost, reportStatusClasses bool, buckets HistogramBuckets, bucketFactor float64, maxBuckets uint32, excludeMetrics []string) (*SocketCollector, error) {
Expand Down Expand Up @@ -316,6 +330,9 @@ func (sc *SocketCollector) handleMessage(msg []byte) {
if sc.reportStatusClasses && stats.Status != "" {
stats.Status = fmt.Sprintf("%cxx", stats.Status[0])
}
if !slices.Contains(validHTTPMethods, stats.Method) {
stats.Method = "invalid_method"
}

// Note these must match the order in requestTags at the top
requestLabels := prometheus.Labels{
Expand Down
31 changes: 31 additions & 0 deletions internal/ingress/metric/collectors/socket_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -648,6 +648,37 @@ func TestCollector(t *testing.T) {
metrics: []string{"nginx_ingress_controller_requests"},
useStatusClasses: true,
},
{
name: "invalid http methods should not be set as label values",
data: []string{`[{
"host":"testshop.com",
"status":"200",
"bytesSent":150.0,
"method":"XYZGET",
"path":"/admin",
"requestLength":300.0,
"requestTime":60.0,
"upstreamLatency":1.0,
"upstreamHeaderTime":5.0,
"upstreamName":"test-upstream",
"upstreamIP":"1.1.1.1:8080",
"upstreamResponseTime":200,
"upstreamStatus":"220",
"namespace":"test-app-production",
"ingress":"web-yml",
"service":"test-app",
"canary":""
}]`},
metrics: []string{"nginx_ingress_controller_requests"},
wantBefore: `
# HELP nginx_ingress_controller_requests The total number of client requests
# TYPE nginx_ingress_controller_requests counter
nginx_ingress_controller_requests{canary="",controller_class="ingress",controller_namespace="default",controller_pod="pod",host="testshop.com",ingress="web-yml",method="invalid_method",namespace="test-app-production",path="/admin",service="test-app",status="200"} 1
`,
removeIngresses: []string{"test-app-production/web-yml"},
wantAfter: `
`,
},
}

for _, c := range cases {
Expand Down
Loading