fix the description of the 'kube_pod_container_status_last_terminated…

…_timestamp' metric Signed-off-by: Tetiana Kravchenko <tetiana.kravchenko@elastic.co>
kubernetes · Mar 4, 2024 · 393430e · 393430e
1 parent dbdb77c
commit 393430e
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/docs/pod-metrics.md b/docs/pod-metrics.md
@@ -23,7 +23,7 @@
 | kube_pod_container_status_terminated_reason           | Gauge       | Describes the reason the container is currently in terminated state                                                                                                                 |                                                | `container`=&lt;container-name&gt; <br> `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `reason`=&lt;container-terminated-reason&gt; <br> `uid`=&lt;pod-uid&gt;                                                                                                                                                                                | EXPERIMENTAL | -      |
 | kube_pod_container_status_last_terminated_reason      | Gauge       | Describes the last reason the container was in terminated state                                                                                                                     |                                                | `container`=&lt;container-name&gt; <br> `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `reason`=&lt;last-terminated-reason&gt; <br> `uid`=&lt;pod-uid&gt;                                                                                                                                                                                     | EXPERIMENTAL | -      |
 | kube_pod_container_status_last_terminated_exitcode    | Gauge       | Describes the exit code for the last container in terminated state.                                                                                                                 |                                                | `container`=&lt;container-name&gt; <br> `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `uid`=&lt;pod-uid&gt;                                                                                                                                                                                                                                  | EXPERIMENTAL | -      |
-| kube_pod_container_status_last_terminated_timestamp   | Gauge       | Last terminated time for a pod container, when container was terminated with kube_pod_container_status_last_terminated_reason, in unix timestamp.                                                                                                             |                                                | `container`=&lt;container-name&gt; <br> `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `uid`=&lt;pod-uid&gt;                                                                                                                                                                                                                                  | EXPERIMENTAL | -      |
+| kube_pod_container_status_last_terminated_timestamp   | Gauge       | Last terminated time for a pod container in unix timestamp.                                                                                                             |                                                | `container`=&lt;container-name&gt; <br> `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `uid`=&lt;pod-uid&gt;                                                                                                                                                                                                                                  | EXPERIMENTAL | -      |
 | kube_pod_container_status_ready                       | Gauge       | Describes whether the containers readiness check succeeded                                                                                                                          |                                                | `container`=&lt;container-name&gt; <br> `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `uid`=&lt;pod-uid&gt;                                                                                                                                                                                                                                  | STABLE       | -      |
 | kube_pod_status_initialized_time                      | Gauge       | Time when the pod is initialized.                                                                                                                                                   | seconds                                        | `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `uid`=&lt;pod-uid&gt;                                                                                                                                                                                                                                                                          | EXPERIMENTAL |
 | kube_pod_status_ready_time                            | Gauge       | Time when pod passed readiness probes.                                                                                                                                              | seconds                                        | `pod`=&lt;pod-name&gt; <br> `namespace`=&lt;pod-namespace&gt; <br> `uid`=&lt;pod-uid&gt;                                                                                                                                                                                                                                                                          | EXPERIMENTAL |

diff --git a/internal/store/pod.go b/internal/store/pod.go
@@ -379,7 +379,7 @@ func createPodContainerStatusLastTerminatedExitCodeFamilyGenerator() generator.F
 func createPodContainerStatusLastTerminatedTimestampFamilyGenerator() generator.FamilyGenerator {
 	return *generator.NewFamilyGeneratorWithStability(
 		"kube_pod_container_status_last_terminated_timestamp",
-		"Last terminated time for a pod container, when container was terminated with kube_pod_container_status_last_terminated_reason, in unix timestamp.",
+		"Last terminated time for a pod container in unix timestamp.",
 		metric.Gauge,
 		basemetrics.ALPHA,
 		"",

diff --git a/internal/store/pod_test.go b/internal/store/pod_test.go
@@ -731,7 +731,7 @@ func TestPodStore(t *testing.T) {
 			Want: `
 				# HELP kube_pod_container_status_last_terminated_reason Describes the last reason the container was in terminated state.
 				# HELP kube_pod_container_status_last_terminated_exitcode Describes the exit code for the last container in terminated state.
-				# HELP kube_pod_container_status_last_terminated_timestamp Last terminated time for a pod container, when container was terminated with kube_pod_container_status_last_terminated_reason, in unix timestamp.
+				# HELP kube_pod_container_status_last_terminated_timestamp Last terminated time for a pod container in unix timestamp.
 				# HELP kube_pod_container_status_running [STABLE] Describes whether the container is currently in running state.
 				# HELP kube_pod_container_status_terminated [STABLE] Describes whether the container is currently in terminated state.
 				# HELP kube_pod_container_status_terminated_reason Describes the reason the container is currently in terminated state.
@@ -808,7 +808,7 @@ func TestPodStore(t *testing.T) {
 			Want: `
 				# HELP kube_pod_container_status_last_terminated_exitcode Describes the exit code for the last container in terminated state.
 				# HELP kube_pod_container_status_last_terminated_reason Describes the last reason the container was in terminated state.
-				# HELP kube_pod_container_status_last_terminated_timestamp Last terminated time for a pod container, when container was terminated with kube_pod_container_status_last_terminated_reason, in unix timestamp.
+				# HELP kube_pod_container_status_last_terminated_timestamp Last terminated time for a pod container in unix timestamp.
 				# HELP kube_pod_container_status_running [STABLE] Describes whether the container is currently in running state.
 				# HELP kube_pod_container_state_started [STABLE] Start time in unix timestamp for a pod container.
 				# HELP kube_pod_container_status_terminated [STABLE] Describes whether the container is currently in terminated state.

diff --git a/pkg/app/server_test.go b/pkg/app/server_test.go
@@ -209,7 +209,7 @@ func TestFullScrapeCycle(t *testing.T) {
 # HELP kube_pod_container_state_started [STABLE] Start time in unix timestamp for a pod container.
 # HELP kube_pod_container_status_last_terminated_exitcode Describes the exit code for the last container in terminated state.
 # HELP kube_pod_container_status_last_terminated_reason Describes the last reason the container was in terminated state.
-# HELP kube_pod_container_status_last_terminated_timestamp Last terminated time for a pod container, when container was terminated with kube_pod_container_status_last_terminated_reason, in unix timestamp.
+# HELP kube_pod_container_status_last_terminated_timestamp Last terminated time for a pod container in unix timestamp.
 # HELP kube_pod_container_status_ready [STABLE] Describes whether the containers readiness check succeeded.
 # HELP kube_pod_container_status_restarts_total [STABLE] The number of container restarts per container.
 # HELP kube_pod_container_status_running [STABLE] Describes whether the container is currently in running state.