add ingress labels

Documentation/README.md

@@ -61,6 +61,7 @@ Per group of metrics there is one file for each metrics. See each file for speci
 * [Endpoint Metrics](endpoint-metrics.md)
 * [Secret Metrics](secret-metrics.md)
 * [ConfigMap Metrics](configmap-metrics.md)
+* [Ingress Metrics](ingress-metrics.md)
 
 
 ## Join Metrics

Documentation/ingress-metrics.md

@@ -0,0 +1,8 @@
+# Ingress Metrics
+
+| Metric name| Metric type | Labels/tags | Status |
+| ---------- | ----------- | ----------- | ----------- |
+| kube_ingress_info | Gauge | `ingress`=&lt;ingress-name&gt; <br> `namespace`=&lt;ingress-namespace&gt; | 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; <br> `resource_version`=&lt;ingress-resource-version&gt; | STABLE |

internal/collector/builder.go

@@ -119,6 +119,7 @@ var availableCollectors = map[string]func(f *Builder) *coll.Collector{
 	"deployments":              func(b *Builder) *coll.Collector { return b.buildDeploymentCollector() },
 	"endpoints":                func(b *Builder) *coll.Collector { return b.buildEndpointsCollector() },
 	"horizontalpodautoscalers": func(b *Builder) *coll.Collector { return b.buildHPACollector() },
+	"ingress":                  func(b *Builder) *coll.Collector { return b.buildIngressCollector() },
 	"jobs":                     func(b *Builder) *coll.Collector { return b.buildJobCollector() },
 	"limitranges":              func(b *Builder) *coll.Collector { return b.buildLimitRangeCollector() },
 	"namespaces":               func(b *Builder) *coll.Collector { return b.buildNamespaceCollector() },
@@ -225,6 +226,21 @@ func (b *Builder) buildHPACollector() *coll.Collector {
 	return coll.NewCollector(store)
 }
 
+func (b *Builder) buildIngressCollector() *coll.Collector {
+	filteredMetricFamilies := metric.FilterMetricFamilies(b.whiteBlackList, ingressMetricFamilies)
+	composedMetricGenFuncs := metric.ComposeMetricGenFuncs(filteredMetricFamilies)
+
+	familyHeaders := metric.ExtractMetricFamilyHeaders(filteredMetricFamilies)
+
+	store := metricsstore.NewMetricsStore(
+		familyHeaders,
+		composedMetricGenFuncs,
+	)
+	reflectorPerNamespace(b.ctx, b.kubeClient, &extensions.Ingress{}, store, b.namespaces, createIngressListWatch)
+
+	return coll.NewCollector(store)
+}
+
 func (b *Builder) buildJobCollector() *coll.Collector {
 	filteredMetricFamilies := metric.FilterMetricFamilies(b.whiteBlackList, jobMetricFamilies)
 	composedMetricGenFuncs := metric.ComposeMetricGenFuncs(filteredMetricFamilies)

internal/collector/ingress.go

@@ -0,0 +1,127 @@
+/*
+Copyright 2019 The Kubernetes Authors All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package collector
+
+import (
+	"k8s.io/kube-state-metrics/pkg/metric"
+
+	"k8s.io/api/extensions/v1beta1"
+
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/runtime"
+	"k8s.io/apimachinery/pkg/watch"
+	clientset "k8s.io/client-go/kubernetes"
+	"k8s.io/client-go/tools/cache"
+)
+
+var (
+	descIngressLabelsName          = "kube_ingress_labels"
+	descIngressLabelsHelp          = "Kubernetes labels converted to Prometheus labels."
+	descIngressLabelsDefaultLabels = []string{"namespace", "ingress"}
+
+	ingressMetricFamilies = []metric.FamilyGenerator{
+		{
+			Name: "kube_ingress_info",
+			Type: metric.MetricTypeGauge,
+			Help: "Information about ingress.",
+			GenerateFunc: wrapIngressFunc(func(s *v1beta1.Ingress) *metric.Family {
+				return &metric.Family{
+					Metrics: []*metric.Metric{
+						{
+							Value: 1,
+						},
+					}}
+			}),
+		},
+		{
+			Name: descIngressLabelsName,
+			Type: metric.MetricTypeGauge,
+			Help: descIngressLabelsHelp,
+			GenerateFunc: wrapIngressFunc(func(i *v1beta1.Ingress) *metric.Family {
+				labelKeys, labelValues := kubeLabelsToPrometheusLabels(i.Labels)
+				return &metric.Family{
+					Metrics: []*metric.Metric{
+						{
+							LabelKeys:   labelKeys,
+							LabelValues: labelValues,
+							Value:       1,
+						},
+					}}
+
+			}),
+		},
+		{
+			Name: "kube_ingress_created",
+			Type: metric.MetricTypeGauge,
+			Help: "Unix creation timestamp",
+			GenerateFunc: wrapIngressFunc(func(i *v1beta1.Ingress) *metric.Family {
+				ms := []*metric.Metric{}
+
+				if !i.CreationTimestamp.IsZero() {
+					ms = append(ms, &metric.Metric{
+						Value: float64(i.CreationTimestamp.Unix()),
+					})
+				}
+
+				return &metric.Family{
+					Metrics: ms,
+				}
+			}),
+		},
+		{
+			Name: "kube_ingress_metadata_resource_version",
+			Type: metric.MetricTypeGauge,
+			Help: "Resource version representing a specific version of ingress.",
+			GenerateFunc: wrapIngressFunc(func(i *v1beta1.Ingress) *metric.Family {
+				return &metric.Family{
+					Metrics: []*metric.Metric{
+						{
+							LabelKeys:   []string{"resource_version"},
+							LabelValues: []string{string(i.ObjectMeta.ResourceVersion)},
+							Value:       1,
+						},
+					}}
+			}),
+		},
+	}
+)
+
+func wrapIngressFunc(f func(*v1beta1.Ingress) *metric.Family) func(interface{}) *metric.Family {
+	return func(obj interface{}) *metric.Family {
+		ingress := obj.(*v1beta1.Ingress)
+
+		metricFamily := f(ingress)
+
+		for _, m := range metricFamily.Metrics {
+			m.LabelKeys = append(descIngressLabelsDefaultLabels, m.LabelKeys...)
+			m.LabelValues = append([]string{ingress.Namespace, ingress.Name}, m.LabelValues...)
+		}
+
+		return metricFamily
+	}
+}
+
+func createIngressListWatch(kubeClient clientset.Interface, ns string) cache.ListWatch {
+	return cache.ListWatch{
+		ListFunc: func(opts metav1.ListOptions) (runtime.Object, error) {
+			return kubeClient.ExtensionsV1beta1().Ingresses(ns).List(opts)
+		},
+		WatchFunc: func(opts metav1.ListOptions) (watch.Interface, error) {
+			return kubeClient.ExtensionsV1beta1().Ingresses(ns).Watch(opts)
+		},
+	}
+}

internal/collector/ingress_test.go

@@ -0,0 +1,103 @@
+/*
+Copyright 2019 The Kubernetes Authors All rights reserved.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package collector
+
+import (
+	"testing"
+
+	"k8s.io/api/extensions/v1beta1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/kube-state-metrics/pkg/metric"
+)
+
+func TestIngressCollector(t *testing.T) {
+	// 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.
+
+	startTime := 1501569018
+	metav1StartTime := metav1.Unix(int64(startTime), 0)
+
+	const metadata = `
+		# HELP kube_ingress_labels Kubernetes labels converted to Prometheus labels.
+		# TYPE kube_ingress_labels gauge
+		# HELP kube_ingress_info Information about ingress.
+		# TYPE kube_ingress_info gauge
+		# HELP kube_ingress_created Unix creation timestamp
+		# TYPE kube_ingress_created gauge
+		# HELP kube_ingress_metadata_resource_version Resource version representing a specific version of ingress.
+		# TYPE kube_ingress_metadata_resource_version gauge
+	`
+	cases := []generateMetricsTestCase{
+		{
+			Obj: &v1beta1.Ingress{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:            "ingress1",
+					Namespace:       "ns1",
+					ResourceVersion: "000000",
+				},
+			},
+			Want: `
+				kube_ingress_info{namespace="ns1",ingress="ingress1"} 1
+				kube_ingress_metadata_resource_version{namespace="ns1",resource_version="000000",ingress="ingress1"} 1
+				kube_ingress_labels{namespace="ns1",ingress="ingress1"} 1
+`,
+			MetricNames: []string{"kube_ingress_info", "kube_ingress_metadata_resource_version", "kube_ingress_created", "kube_ingress_labels"},
+		},
+		{
+			Obj: &v1beta1.Ingress{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:              "ingress2",
+					Namespace:         "ns2",
+					CreationTimestamp: metav1StartTime,
+					ResourceVersion:   "123456",
+				},
+			},
+			Want: `
+				kube_ingress_info{namespace="ns2",ingress="ingress2"} 1
+				kube_ingress_created{namespace="ns2",ingress="ingress2"} 1.501569018e+09
+				kube_ingress_metadata_resource_version{namespace="ns2",resource_version="123456",ingress="ingress2"} 1
+				kube_ingress_labels{namespace="ns2",ingress="ingress2"} 1
+				`,
+			MetricNames: []string{"kube_ingress_info", "kube_ingress_metadata_resource_version", "kube_ingress_created", "kube_ingress_labels"},
+		},
+		{
+			Obj: &v1beta1.Ingress{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:              "ingress3",
+					Namespace:         "ns3",
+					CreationTimestamp: metav1StartTime,
+					Labels:            map[string]string{"test-3": "test-3"},
+					ResourceVersion:   "abcdef",
+				},
+			},
+			Want: `
+				kube_ingress_info{namespace="ns3",ingress="ingress3"} 1
+				kube_ingress_created{namespace="ns3",ingress="ingress3"} 1.501569018e+09
+				kube_ingress_metadata_resource_version{namespace="ns3",resource_version="abcdef",ingress="ingress3"} 1
+				kube_ingress_labels{label_test_3="test-3",namespace="ns3",ingress="ingress3"} 1
+`,
+			MetricNames: []string{"kube_ingress_info", "kube_ingress_metadata_resource_version", "kube_ingress_created", "kube_ingress_labels"},
+		},
+	}
+	for i, c := range cases {
+		c.Func = metric.ComposeMetricGenFuncs(ingressMetricFamilies)
+		if err := c.run(); err != nil {
+			t.Errorf("unexpected collecting result in %vth run:\n%s", i, err)
+		}
+
+	}
+}

pkg/options/collector.go

@@ -43,5 +43,6 @@ var (
 		"endpoints":                struct{}{},
 		"secrets":                  struct{}{},
 		"configmaps":               struct{}{},
+		"ingress":                  struct{}{},
 	}
 )

tests/manifests/ingress.yaml

@@ -0,0 +1,18 @@
+apiVersion: extensions/v1beta1
+kind: Ingress
+metadata:
+  name: example-ingress
+  annotations:
+    ingress.kubernetes.io/rewrite-target: /
+spec:
+  rules:
+  - http:
+      paths:
+        - path: /apple
+          backend:
+            serviceName: apple-service
+            servicePort: 5678
+        - path: /banana
+          backend:
+            serviceName: banana-service
+            servicePort: 5678