Merge pull request #1652 from adammw/adammw/ingressclass

Add ingressclass to kube_ingress_info metric

Author: k8s-ci-robot

docs/ingress-metrics.md

@@ -3,7 +3,7 @@
 | Metric name| Metric type | Labels/tags | Status |
 | ---------- | ----------- | ----------- | ----------- |
 | kube_ingress_annotations | Gauge | `ingress`=&lt;ingress-name&gt; <br> `namespace`=&lt;ingress-namespace&gt; <br> `annotation_INGRESS_ANNOTATION`=&lt;ANNOTATION_LABEL&gt; | EXPERIMENTAL |
-| kube_ingress_info | Gauge | `ingress`=&lt;ingress-name&gt; <br> `namespace`=&lt;ingress-namespace&gt; | STABLE |
+| kube_ingress_info | Gauge | `ingress`=&lt;ingress-name&gt; <br> `namespace`=&lt;ingress-namespace&gt; <br> `ingressclass`=&lt;ingress-class&gt; or `_default` if not set | STABLE |
 | kube_ingress_labels | Gauge | `ingress`=&lt;ingress-name&gt; <br> `namespace`=&lt;ingress-namespace&gt; <br> `label_INGRESS_LABEL`=&lt;INGRESS_LABEL&gt; | STABLE |
 | kube_ingress_created  | Gauge | `ingress`=&lt;ingress-name&gt; <br> `namespace`=&lt;ingress-namespace&gt; | STABLE |
 | kube_ingress_metadata_resource_version  | Gauge | `ingress`=&lt;ingress-name&gt; <br> `namespace`=&lt;ingress-namespace&gt; | EXPERIMENTAL |

internal/store/ingress.go

@@ -46,11 +46,21 @@ func ingressMetricFamilies(allowAnnotationsList, allowLabelsList []string) []gen
 			"Information about ingress.",
 			metric.Gauge,
 			"",
-			wrapIngressFunc(func(s *networkingv1.Ingress) *metric.Family {
+			wrapIngressFunc(func(i *networkingv1.Ingress) *metric.Family {
+				ingressClassName := "_default"
+				if i.Spec.IngressClassName != nil {
+					ingressClassName = *i.Spec.IngressClassName
+				}
+				if className, ok := i.Annotations["kubernetes.io/ingress.class"]; ok {
+					ingressClassName = className
+				}
+
 				return &metric.Family{
 					Metrics: []*metric.Metric{
 						{
-							Value: 1,
+							LabelKeys:   []string{"ingressclass"},
+							LabelValues: []string{ingressClassName},
+							Value:       1,
 						},
 					}}
 			}),

internal/store/ingress_test.go

@@ -28,6 +28,7 @@ import (
 func TestIngressStore(t *testing.T) {
 	startTime := 1501569018
 	metav1StartTime := metav1.Unix(int64(startTime), 0)
+	testIngressClass := "test"
 
 	// Fixed metadata on type and help text. We prepend this to every expected
 	// output so we only have to modify a single place when doing adjustments.
@@ -70,7 +71,7 @@ func TestIngressStore(t *testing.T) {
 				# TYPE kube_ingress_annotations gauge
 				# TYPE kube_ingress_labels gauge
 				# TYPE kube_ingress_metadata_resource_version gauge
-				kube_ingress_info{namespace="ns1",ingress="ingress1"} 1
+				kube_ingress_info{namespace="ns1",ingress="ingress1",ingressclass="_default"} 1
 				kube_ingress_metadata_resource_version{namespace="ns1",ingress="ingress1"} 0
 				kube_ingress_annotations{annotation_app_k8s_io_owner="@foo",namespace="ns1",ingress="ingress1"} 1
 				kube_ingress_labels{namespace="ns1",ingress="ingress1"} 1
@@ -92,7 +93,7 @@ func TestIngressStore(t *testing.T) {
 				},
 			},
 			Want: metadata + `
-				kube_ingress_info{namespace="ns2",ingress="ingress2"} 1
+				kube_ingress_info{namespace="ns2",ingress="ingress2",ingressclass="_default"} 1
 				kube_ingress_created{namespace="ns2",ingress="ingress2"} 1.501569018e+09
 				kube_ingress_metadata_resource_version{namespace="ns2",ingress="ingress2"} 123456
 				kube_ingress_labels{namespace="ns2",ingress="ingress2"} 1
@@ -110,7 +111,7 @@ func TestIngressStore(t *testing.T) {
 				},
 			},
 			Want: metadata + `
-				kube_ingress_info{namespace="ns3",ingress="ingress3"} 1
+				kube_ingress_info{namespace="ns3",ingress="ingress3",ingressclass="_default"} 1
 				kube_ingress_created{namespace="ns3",ingress="ingress3"} 1.501569018e+09
 				kube_ingress_labels{namespace="ns3",ingress="ingress3"} 1
 `,
@@ -154,7 +155,7 @@ func TestIngressStore(t *testing.T) {
 				},
 			},
 			Want: metadata + `
-				kube_ingress_info{namespace="ns4",ingress="ingress4"} 1
+				kube_ingress_info{namespace="ns4",ingress="ingress4",ingressclass="_default"} 1
 				kube_ingress_created{namespace="ns4",ingress="ingress4"} 1.501569018e+09
 				kube_ingress_labels{namespace="ns4",ingress="ingress4"} 1
 				kube_ingress_path{namespace="ns4",ingress="ingress4",host="somehost",path="/somepath",service_name="someservice",service_port="1234"} 1
@@ -180,14 +181,54 @@ func TestIngressStore(t *testing.T) {
 				},
 			},
 			Want: metadata + `
-				kube_ingress_info{namespace="ns5",ingress="ingress5"} 1
+				kube_ingress_info{namespace="ns5",ingress="ingress5",ingressclass="_default"} 1
 				kube_ingress_created{namespace="ns5",ingress="ingress5"} 1.501569018e+09
 				kube_ingress_labels{namespace="ns5",ingress="ingress5"} 1
 				kube_ingress_tls{namespace="ns5",ingress="ingress5",tls_host="somehost1",secret="somesecret"} 1
 				kube_ingress_tls{namespace="ns5",ingress="ingress5",tls_host="somehost2",secret="somesecret"} 1
 `,
 			MetricNames: []string{"kube_ingress_info", "kube_ingress_metadata_resource_version", "kube_ingress_created", "kube_ingress_labels", "kube_ingress_path", "kube_ingress_tls"},
 		},
+		{
+			Obj: &networkingv1.Ingress{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:              "ingress6",
+					Namespace:         "ns6",
+					CreationTimestamp: metav1StartTime,
+					ResourceVersion:   "123456",
+				},
+				Spec: networkingv1.IngressSpec{
+					IngressClassName: &testIngressClass,
+				},
+			},
+			Want: metadata + `
+				kube_ingress_info{namespace="ns6",ingress="ingress6",ingressclass="test"} 1
+				kube_ingress_created{namespace="ns6",ingress="ingress6"} 1.501569018e+09
+				kube_ingress_metadata_resource_version{namespace="ns6",ingress="ingress6"} 123456
+				kube_ingress_labels{namespace="ns6",ingress="ingress6"} 1
+				`,
+			MetricNames: []string{"kube_ingress_info", "kube_ingress_metadata_resource_version", "kube_ingress_created", "kube_ingress_labels", "kube_ingress_path", "kube_ingress_tls"},
+		},
+		{
+			Obj: &networkingv1.Ingress{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:              "ingress7",
+					Namespace:         "ns7",
+					CreationTimestamp: metav1StartTime,
+					ResourceVersion:   "123456",
+					Annotations: map[string]string{
+						"kubernetes.io/ingress.class": "test",
+					},
+				},
+			},
+			Want: metadata + `
+				kube_ingress_info{namespace="ns7",ingress="ingress7",ingressclass="test"} 1
+				kube_ingress_created{namespace="ns7",ingress="ingress7"} 1.501569018e+09
+				kube_ingress_metadata_resource_version{namespace="ns7",ingress="ingress7"} 123456
+				kube_ingress_labels{namespace="ns7",ingress="ingress7"} 1
+				`,
+			MetricNames: []string{"kube_ingress_info", "kube_ingress_metadata_resource_version", "kube_ingress_created", "kube_ingress_labels", "kube_ingress_path", "kube_ingress_tls"},
+		},
 	}
 	for i, c := range cases {
 		c.Func = generator.ComposeMetricGenFuncs(ingressMetricFamilies(c.AllowAnnotationsList, c.AllowLabelsList))