Merge pull request #2675 from IgorIgnatevBolt/feat-hpa-created-metric

feat: Add HorizontalPodAutoscaler created and deletionTimestamp info into metrics

docs/metrics/workload/horizontalpodautoscaler-metrics.md

@@ -1,7 +1,7 @@
 # Horizontal Pod Autoscaler Metrics
 
 | Metric name                                          | Metric type | Description                                                                                                                             | Labels/tags                                                                                                                                                                                                                                              | Status       |
-| ---------------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
+| ---------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
 | kube_horizontalpodautoscaler_info                    | Gauge       |                                                                                                                                         | `horizontalpodautoscaler`=&lt;hpa-name&gt; <br> `namespace`=&lt;hpa-namespace&gt; <br> `scaletargetref_api_version`=&lt;hpa-target-api-version&gt; <br> `scaletargetref_kind`=&lt;hpa-target-kind&gt; <br> `scaletargetref_name`=&lt;hpa-target-name&gt; | EXPERIMENTAL |
 | kube_horizontalpodautoscaler_annotations             | Gauge       | Kubernetes annotations converted to Prometheus labels controlled via [--metric-annotations-allowlist](../../developer/cli-arguments.md) | `horizontalpodautoscaler`=&lt;hpa-name&gt; <br> `namespace`=&lt;hpa-namespace&gt;                                                                                                                                                                        | EXPERIMENTAL |
 | kube_horizontalpodautoscaler_labels                  | Gauge       | Kubernetes labels converted to Prometheus labels controlled via [--metric-labels-allowlist](../../developer/cli-arguments.md)           | `horizontalpodautoscaler`=&lt;hpa-name&gt; <br> `namespace`=&lt;hpa-namespace&gt;                                                                                                                                                                        | STABLE       |
@@ -13,3 +13,5 @@
 | kube_horizontalpodautoscaler_status_condition        | Gauge       |                                                                                                                                         | `horizontalpodautoscaler`=&lt;hpa-name&gt; <br> `namespace`=&lt;hpa-namespace&gt; <br> `condition`=&lt;hpa-condition&gt; <br> `status`=&lt;true\|false\|unknown&gt;                                                                                      | STABLE       |
 | kube_horizontalpodautoscaler_status_current_replicas | Gauge       |                                                                                                                                         | `horizontalpodautoscaler`=&lt;hpa-name&gt; <br> `namespace`=&lt;hpa-namespace&gt;                                                                                                                                                                        | STABLE       |
 | kube_horizontalpodautoscaler_status_desired_replicas | Gauge       |                                                                                                                                         | `horizontalpodautoscaler`=&lt;hpa-name&gt; <br> `namespace`=&lt;hpa-namespace&gt;                                                                                                                                                                        | STABLE       |
+| kube_horizontalpodautoscaler_created                 | Gauge       |                                                                                                                                         | `horizontalpodautoscaler`=&lt;hpa-name&gt; <br> `namespace`=&lt;hpa-namespace&gt;                                                                                                                                                                        | EXPERIMENTAL |
+| kube_horizontalpodautoscaler_deletion_timestamp      | Gauge       |                                                                                                                                         | `horizontalpodautoscaler`=&lt;hpa-name&gt; <br> `namespace`=&lt;hpa-namespace&gt;                                                                                                                                                                        | EXPERIMENTAL |

internal/store/horizontalpodautoscaler.go

@@ -66,6 +66,8 @@ func hpaMetricFamilies(allowAnnotationsList, allowLabelsList []string) []generat
 		createHPAAnnotations(allowAnnotationsList),
 		createHPALabels(allowLabelsList),
 		createHPAStatusCondition(),
+		createHPACreated(),
+		createHPADeletionTimestamp(),
 	}
 }
 
@@ -413,3 +415,49 @@ func createHPAStatusCondition() generator.FamilyGenerator {
 		}),
 	)
 }
+
+func createHPACreated() generator.FamilyGenerator {
+	return *generator.NewFamilyGeneratorWithStability(
+		"kube_horizontalpodautoscaler_created",
+		"Unix creation timestamp",
+		metric.Gauge,
+		basemetrics.ALPHA,
+		"",
+		wrapHPAFunc(func(a *autoscaling.HorizontalPodAutoscaler) *metric.Family {
+			ms := []*metric.Metric{}
+
+			if !a.CreationTimestamp.IsZero() {
+				ms = append(ms, &metric.Metric{
+					Value: float64(a.CreationTimestamp.Unix()),
+				})
+			}
+
+			return &metric.Family{
+				Metrics: ms,
+			}
+		}),
+	)
+}
+
+func createHPADeletionTimestamp() generator.FamilyGenerator {
+	return *generator.NewFamilyGeneratorWithStability(
+		"kube_horizontalpodautoscaler_deletion_timestamp",
+		"Unix deletion timestamp",
+		metric.Gauge,
+		basemetrics.ALPHA,
+		"",
+		wrapHPAFunc(func(a *autoscaling.HorizontalPodAutoscaler) *metric.Family {
+			ms := []*metric.Metric{}
+
+			if !a.DeletionTimestamp.IsZero() {
+				ms = append(ms, &metric.Metric{
+					Value: float64(a.DeletionTimestamp.Unix()),
+				})
+			}
+
+			return &metric.Family{
+				Metrics: ms,
+			}
+		}),
+	)
+}

internal/store/horizontalpodautoscaler_test.go

@@ -18,6 +18,7 @@ package store
 
 import (
 	"testing"
+	"time"
 
 	autoscaling "k8s.io/api/autoscaling/v2"
 	v1 "k8s.io/api/core/v1"
@@ -46,6 +47,8 @@ func TestHPAStore(t *testing.T) {
 		# HELP kube_horizontalpodautoscaler_status_condition [STABLE] The condition of this autoscaler.
 		# HELP kube_horizontalpodautoscaler_status_current_replicas [STABLE] Current number of replicas of pods managed by this autoscaler.
 		# HELP kube_horizontalpodautoscaler_status_desired_replicas [STABLE] Desired number of replicas of pods managed by this autoscaler.
+		# HELP kube_horizontalpodautoscaler_created Unix creation timestamp
+		# HELP kube_horizontalpodautoscaler_deletion_timestamp Unix deletion timestamp
 		# TYPE kube_horizontalpodautoscaler_info gauge
 		# TYPE kube_horizontalpodautoscaler_annotations gauge
 		# TYPE kube_horizontalpodautoscaler_labels gauge
@@ -57,6 +60,8 @@ func TestHPAStore(t *testing.T) {
 		# TYPE kube_horizontalpodautoscaler_status_condition gauge
 		# TYPE kube_horizontalpodautoscaler_status_current_replicas gauge
 		# TYPE kube_horizontalpodautoscaler_status_desired_replicas gauge
+		# TYPE kube_horizontalpodautoscaler_created gauge
+		# TYPE kube_horizontalpodautoscaler_deletion_timestamp gauge
 	`
 	cases := []generateMetricsTestCase{
 		{
@@ -65,6 +70,8 @@ func TestHPAStore(t *testing.T) {
 				ObjectMeta: metav1.ObjectMeta{
 					Generation:        2,
 					Name:              "hpa1",
+					CreationTimestamp: metav1.Time{Time: time.Unix(1500000000, 0)},
+					DeletionTimestamp: &metav1.Time{Time: time.Unix(1800000000, 0)},
 					Namespace:         "ns1",
 					Labels: map[string]string{
 						"app": "foobar",
@@ -233,6 +240,8 @@ func TestHPAStore(t *testing.T) {
 				kube_horizontalpodautoscaler_status_condition{condition="AbleToScale",horizontalpodautoscaler="hpa1",namespace="ns1",status="unknown"} 0
 				kube_horizontalpodautoscaler_status_current_replicas{horizontalpodautoscaler="hpa1",namespace="ns1"} 2
 				kube_horizontalpodautoscaler_status_desired_replicas{horizontalpodautoscaler="hpa1",namespace="ns1"} 2
+				kube_horizontalpodautoscaler_created{horizontalpodautoscaler="hpa1",namespace="ns1"} 1.5e+09
+				kube_horizontalpodautoscaler_deletion_timestamp{horizontalpodautoscaler="hpa1",namespace="ns1"} 1.8e+09
 			`,
 			MetricNames: []string{
 				"kube_horizontalpodautoscaler_info",
@@ -246,6 +255,8 @@ func TestHPAStore(t *testing.T) {
 				"kube_horizontalpodautoscaler_status_condition",
 				"kube_horizontalpodautoscaler_annotations",
 				"kube_horizontalpodautoscaler_labels",
+				"kube_horizontalpodautoscaler_created",
+				"kube_horizontalpodautoscaler_deletion_timestamp",
 			},
 		},
 		{
@@ -257,6 +268,8 @@ func TestHPAStore(t *testing.T) {
 				ObjectMeta: metav1.ObjectMeta{
 					Generation:        2,
 					Name:              "hpa2",
+					CreationTimestamp: metav1.Time{Time: time.Unix(1500000000, 0)},
+					DeletionTimestamp: &metav1.Time{Time: time.Unix(1800000000, 0)},
 					Namespace:         "ns1",
 					Labels: map[string]string{
 						"app": "foobar",
@@ -408,6 +421,8 @@ func TestHPAStore(t *testing.T) {
 				kube_horizontalpodautoscaler_status_condition{condition="AbleToScale",horizontalpodautoscaler="hpa2",namespace="ns1",status="unknown"} 0
 				kube_horizontalpodautoscaler_status_current_replicas{horizontalpodautoscaler="hpa2",namespace="ns1"} 2
 				kube_horizontalpodautoscaler_status_desired_replicas{horizontalpodautoscaler="hpa2",namespace="ns1"} 2
+				kube_horizontalpodautoscaler_created{horizontalpodautoscaler="hpa2",namespace="ns1"} 1.5e+09
+				kube_horizontalpodautoscaler_deletion_timestamp{horizontalpodautoscaler="hpa2",namespace="ns1"} 1.8e+09
 			`,
 			MetricNames: []string{
 				"kube_horizontalpodautoscaler_info",
@@ -421,6 +436,8 @@ func TestHPAStore(t *testing.T) {
 				"kube_horizontalpodautoscaler_status_condition",
 				"kube_horizontalpodautoscaler_annotation",
 				"kube_horizontalpodautoscaler_labels",
+				"kube_horizontalpodautoscaler_created",
+				"kube_horizontalpodautoscaler_deletion_timestamp",
 			},
 		},
 	}