fix issue #2297 Missing metric for updatedReplicas (#2300)

incl. documentation and enhanced test incl. fix rollout_info_replicas_desired was not documented Signed-off-by: nitram509 <[email protected]> Signed-off-by: nitram509 <[email protected]> Signed-off-by: zachaller <[email protected]> Co-authored-by: zachaller <[email protected]>
argoproj · Nov 8, 2022 · 3aa87aa · 3aa87aa
1 parent 40e0166
commit 3aa87aa
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 4 deletions.
diff --git a/controller/metrics/prommetrics.go b/controller/metrics/prommetrics.go
@@ -58,6 +58,13 @@ var (
 		nil,
 	)
 
+	MetricRolloutInfoReplicasUpdated = prometheus.NewDesc(
+		"rollout_info_replicas_updated",
+		"The number of updated replicas per rollout.",
+		namespaceNameLabels,
+		nil,
+	)
+
 	MetricRolloutEventsTotal = prometheus.NewCounterVec(
 		prometheus.CounterOpts{
 			Name: "rollout_events_total",

diff --git a/controller/metrics/rollout_test.go b/controller/metrics/rollout_test.go
@@ -113,7 +113,13 @@ rollout_info_replicas_available{name="guestbook-bluegreen",namespace="default"}
 rollout_info_replicas_desired{name="guestbook-bluegreen",namespace="default"} 1
 # HELP rollout_info_replicas_unavailable The number of unavailable replicas per rollout.
 # TYPE rollout_info_replicas_unavailable gauge
-rollout_info_replicas_unavailable{name="guestbook-bluegreen",namespace="default"} 0`,
+rollout_info_replicas_unavailable{name="guestbook-bluegreen",namespace="default"} 0
+# HELP rollout_info_replicas_unavailable The number of unavailable replicas per rollout.
+# TYPE rollout_info_replicas_unavailable gauge
+rollout_info_replicas_unavailable{name="guestbook-bluegreen",namespace="default"} 0
+# HELP rollout_info_replicas_updated The number of updated replicas per rollout.
+# TYPE rollout_info_replicas_updated gauge
+rollout_info_replicas_updated{name="guestbook-bluegreen",namespace="default"} 0`,
 		},
 
 		{
@@ -131,7 +137,13 @@ rollout_info_replicas_available{name="guestbook-bluegreen",namespace="default"}
 rollout_info_replicas_desired{name="guestbook-bluegreen",namespace="default"} 1
 # HELP rollout_info_replicas_unavailable The number of unavailable replicas per rollout.
 # TYPE rollout_info_replicas_unavailable gauge
-rollout_info_replicas_unavailable{name="guestbook-bluegreen",namespace="default"} 0`,
+rollout_info_replicas_unavailable{name="guestbook-bluegreen",namespace="default"} 0
+# HELP rollout_info_replicas_unavailable The number of unavailable replicas per rollout.
+# TYPE rollout_info_replicas_unavailable gauge
+rollout_info_replicas_unavailable{name="guestbook-bluegreen",namespace="default"} 0
+# HELP rollout_info_replicas_updated The number of updated replicas per rollout.
+# TYPE rollout_info_replicas_updated gauge
+rollout_info_replicas_updated{name="guestbook-bluegreen",namespace="default"} 0`,
 		},
 		{
 			fakeCanaryRollout,
@@ -148,7 +160,13 @@ rollout_info_replicas_available{name="guestbook-canary",namespace="default"} 1
 rollout_info_replicas_desired{name="guestbook-canary",namespace="default"} 1
 # HELP rollout_info_replicas_unavailable The number of unavailable replicas per rollout.
 # TYPE rollout_info_replicas_unavailable gauge
-rollout_info_replicas_unavailable{name="guestbook-canary",namespace="default"} 0`,
+rollout_info_replicas_unavailable{name="guestbook-canary",namespace="default"} 0
+# HELP rollout_info_replicas_unavailable The number of unavailable replicas per rollout.
+# TYPE rollout_info_replicas_unavailable gauge
+rollout_info_replicas_unavailable{name="guestbook-canary",namespace="default"} 0
+# HELP rollout_info_replicas_updated The number of updated replicas per rollout.
+# TYPE rollout_info_replicas_updated gauge
+rollout_info_replicas_updated{name="guestbook-canary",namespace="default"} 0`,
 		},
 	}
 

diff --git a/controller/metrics/rollouts.go b/controller/metrics/rollouts.go
@@ -131,6 +131,7 @@ func collectRollouts(ch chan<- prometheus.Metric, rollout *v1alpha1.Rollout) {
 	addGauge(MetricRolloutInfoReplicasAvailable, float64(rollout.Status.AvailableReplicas))
 	addGauge(MetricRolloutInfoReplicasUnavailable, float64(rollout.Status.Replicas-rollout.Status.AvailableReplicas))
 	addGauge(MetricRolloutInfoReplicasDesired, float64(defaults.GetReplicasOrDefault(rollout.Spec.Replicas)))
+	addGauge(MetricRolloutInfoReplicasUpdated, float64(rollout.Status.UpdatedReplicas))
 
 	// DEPRECATED
 	addGauge(MetricRolloutPhase, boolFloat64(calculatedPhase == RolloutCompleted), strategyType, string(RolloutCompleted))

diff --git a/docs/features/controller-metrics.md b/docs/features/controller-metrics.md
@@ -46,10 +46,12 @@ You can import this Dashboard in your Grafana installation [as a JSON file](http
 The Argo Rollouts controller publishes the following prometheus metrics about Argo Rollout objects.
 
 | Name                                | Description |
-| ----------------------------------- | ----------- |
+|-------------------------------------| ----------- |
 | `rollout_info`                      | Information about rollout. |
 | `rollout_info_replicas_available`   | The number of available replicas per rollout. |
 | `rollout_info_replicas_unavailable` | The number of unavailable replicas per rollout. |
+| `rollout_info_replicas_desired`     | The number of desired replicas per rollout. |
+| `rollout_info_replicas_updated`     | The number of updated replicas per rollout. |
 | `rollout_phase`                     | [**DEPRECATED - use rollout_info**] Information on the state of the rollout. |
 | `rollout_reconcile`                 | Rollout reconciliation performance. |
 | `rollout_reconcile_error`           | Error occurring during the rollout. |