fix inconsistent-label-cardinality for prometheus metrics: nginx_ingress_controller_requests (#8225)

* fix inconsistent-label-cardinality

for prometheus metrics: nginx_ingress_controller_requests

* add host to collectorLabels only if metricsPerHost is true
This commit is contained in:
Endre Kovács 2022-02-13 19:33:47 +01:00 committed by GitHub
parent 53a232f829
commit 86964b15a8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 42 additions and 4 deletions

View file

@ -217,6 +217,7 @@ func NewSocketCollector(pod, namespace, class string, metricsPerHost bool, bucke
}
sc.metricMapping = map[string]interface{}{
prometheus.BuildFQName(PrometheusNamespace, "", "requests"): sc.requests,
prometheus.BuildFQName(PrometheusNamespace, "", "request_duration_seconds"): sc.requestTime,
prometheus.BuildFQName(PrometheusNamespace, "", "request_size"): sc.requestLength,
@ -258,9 +259,6 @@ func (sc *SocketCollector) handleMessage(msg []byte) {
"service": stats.Service,
"canary": stats.Canary,
}
if sc.metricsPerHost {
requestLabels["host"] = stats.Host
}
collectorLabels := prometheus.Labels{
"namespace": stats.Namespace,
@ -268,6 +266,12 @@ func (sc *SocketCollector) handleMessage(msg []byte) {
"status": stats.Status,
"service": stats.Service,
"canary": stats.Canary,
"method": stats.Method,
"path": stats.Path,
}
if sc.metricsPerHost {
requestLabels["host"] = stats.Host
collectorLabels["host"] = stats.Host
}
latencyLabels := prometheus.Labels{
@ -415,6 +419,12 @@ func (sc *SocketCollector) RemoveMetrics(ingresses []string, registry prometheus
klog.V(2).InfoS("metric not removed", "name", metricName, "ingress", ingKey, "labels", labels)
}
}
if c, ok := metric.(*prometheus.CounterVec); ok {
if removed := c.Delete(labels); !removed {
klog.V(2).InfoS("metric not removed", "name", metricName, "ingress", ingKey, "labels", labels)
}
}
}
}
}

View file

@ -153,7 +153,35 @@ func TestCollector(t *testing.T) {
wantAfter: `
`,
},
{
name: "valid metric object should update requests metrics",
data: []string{`[{
"host":"testshop.com",
"status":"200",
"bytesSent":150.0,
"method":"GET",
"path":"/admin",
"requestLength":300.0,
"requestTime":60.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="GET",namespace="test-app-production",path="/admin",service="test-app",status="200"} 1
`,
removeIngresses: []string{"test-app-production/web-yml"},
wantAfter: `
`,
},
{
name: "valid metric object with canary information should update prometheus metrics",
data: []string{`[{