Skip to content

Commit b763076

Browse files
yasicaryasicar
committed
Promote StatefulSet metrics to stable
1 parent 0db5451 commit b763076

File tree

3 files changed

+19
-19
lines changed

3 files changed

+19
-19
lines changed

‎docs/metrics/workload/statefulset-metrics.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22

33
| Metric name | Metric type | Description | Labels/tags | Status |
44
| ------------------------------------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
5-
| kube_statefulset_annotations | Gauge | Kubernetes annotations converted to Prometheus labels controlled via [--metric-annotations-allowlist](../../developer/cli-arguments.md) | `statefulset`=&lt;statefulset-name&gt; <br> `namespace`=&lt;statefulset-namespace&gt; <br> `annotation_STATEFULSET_ANNOTATION`=&lt;STATEFULSET_ANNOTATION&gt; | BETA |
5+
| kube_statefulset_annotations | Gauge | Kubernetes annotations converted to Prometheus labels controlled via [--metric-annotations-allowlist](../../developer/cli-arguments.md) | `statefulset`=&lt;statefulset-name&gt; <br> `namespace`=&lt;statefulset-namespace&gt; <br> `annotation_STATEFULSET_ANNOTATION`=&lt;STATEFULSET_ANNOTATION&gt; | STABLE |
66
| kube_statefulset_status_replicas | Gauge | | `statefulset`=&lt;statefulset-name&gt; <br> `namespace`=&lt;statefulset-namespace&gt; | STABLE |
77
| kube_statefulset_status_replicas_current | Gauge | | `statefulset`=&lt;statefulset-name&gt; <br> `namespace`=&lt;statefulset-namespace&gt; | STABLE |
88
| kube_statefulset_status_replicas_ready | Gauge | | `statefulset`=&lt;statefulset-name&gt; <br> `namespace`=&lt;statefulset-namespace&gt; | STABLE |
9-
| kube_statefulset_status_replicas_available | Gauge | | `statefulset`=&lt;statefulset-name&gt; <br> `namespace`=&lt;statefulset-namespace&gt; | BETA |
9+
| kube_statefulset_status_replicas_available | Gauge | | `statefulset`=&lt;statefulset-name&gt; <br> `namespace`=&lt;statefulset-namespace&gt; | STABLE |
1010
| kube_statefulset_status_replicas_updated | Gauge | | `statefulset`=&lt;statefulset-name&gt; <br> `namespace`=&lt;statefulset-namespace&gt; | STABLE |
1111
| kube_statefulset_status_observed_generation | Gauge | | `statefulset`=&lt;statefulset-name&gt; <br> `namespace`=&lt;statefulset-namespace&gt; | STABLE |
1212
| kube_statefulset_replicas | Gauge | | `statefulset`=&lt;statefulset-name&gt; <br> `namespace`=&lt;statefulset-namespace&gt; | STABLE |
1313
| kube_statefulset_ordinals_start | Gauge | | `statefulset`=&lt;statefulset-name&gt; <br> `namespace`=&lt;statefulset-namespace&gt; | STABLE |
1414
| kube_statefulset_metadata_generation | Gauge | | `statefulset`=&lt;statefulset-name&gt; <br> `namespace`=&lt;statefulset-namespace&gt; | STABLE |
15-
| kube_statefulset_persistentvolumeclaim_retention_policy | Gauge | | `statefulset`=&lt;statefulset-name&gt; <br> `namespace`=&lt;statefulset-namespace&gt; <br> `when_deleted`=&lt;statefulset-when-deleted-pvc-policy&gt; <br> `when_scaled`=&lt;statefulset-when-scaled-pvc-policy&gt; | BETA |
15+
| kube_statefulset_persistentvolumeclaim_retention_policy | Gauge | | `statefulset`=&lt;statefulset-name&gt; <br> `namespace`=&lt;statefulset-namespace&gt; <br> `when_deleted`=&lt;statefulset-when-deleted-pvc-policy&gt; <br> `when_scaled`=&lt;statefulset-when-scaled-pvc-policy&gt; | STABLE |
1616
| kube_statefulset_created | Gauge | | `statefulset`=&lt;statefulset-name&gt; <br> `namespace`=&lt;statefulset-namespace&gt; | STABLE |
1717
| kube_statefulset_labels | Gauge | Kubernetes labels converted to Prometheus labels controlled via [--metric-labels-allowlist](../../developer/cli-arguments.md) | `statefulset`=&lt;statefulset-name&gt; <br> `namespace`=&lt;statefulset-namespace&gt; <br> `label_STATEFULSET_LABEL`=&lt;STATEFULSET_LABEL&gt; | STABLE |
1818
| kube_statefulset_status_current_revision | Gauge | | `statefulset`=&lt;statefulset-name&gt; <br> `namespace`=&lt;statefulset-namespace&gt; <br> `revision`=&lt;statefulset-current-revision&gt; | STABLE |
1919
| kube_statefulset_status_update_revision | Gauge | | `statefulset`=&lt;statefulset-name&gt; <br> `namespace`=&lt;statefulset-namespace&gt; <br> `revision`=&lt;statefulset-update-revision&gt; | STABLE |
20-
| kube_statefulset_deletion_timestamp | Gauge | Unix deletion timestamp | `statefulset`=&lt;statefulset-name&gt; <br> `namespace`=&lt;statefulset-namespace&gt; | BETA |
20+
| kube_statefulset_deletion_timestamp | Gauge | Unix deletion timestamp | `statefulset`=&lt;statefulset-name&gt; <br> `namespace`=&lt;statefulset-namespace&gt; | STABLE |
2121

2222
## Common PromQL Queries
2323

‎internal/store/statefulset.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ func statefulSetMetricFamilies(allowAnnotationsList, allowLabelsList []string) [
8282
"kube_statefulset_status_replicas_available",
8383
"The number of available replicas per StatefulSet.",
8484
metric.Gauge,
85-
basemetrics.BETA,
85+
basemetrics.STABLE,
8686
"",
8787
wrapStatefulSetFunc(func(s *v1.StatefulSet) *metric.Family {
8888
return &metric.Family{
@@ -218,7 +218,7 @@ func statefulSetMetricFamilies(allowAnnotationsList, allowLabelsList []string) [
218218
"kube_statefulset_persistentvolumeclaim_retention_policy",
219219
"Count of retention policy for StatefulSet template PVCs",
220220
metric.Gauge,
221-
basemetrics.BETA,
221+
basemetrics.STABLE,
222222

223223
"",
224224
wrapStatefulSetFunc(func(s *v1.StatefulSet) *metric.Family {
@@ -245,7 +245,7 @@ func statefulSetMetricFamilies(allowAnnotationsList, allowLabelsList []string) [
245245
descStatefulSetAnnotationsName,
246246
descStatefulSetAnnotationsHelp,
247247
metric.Gauge,
248-
basemetrics.BETA,
248+
basemetrics.STABLE,
249249
"",
250250
wrapStatefulSetFunc(func(s *v1.StatefulSet) *metric.Family {
251251
if len(allowAnnotationsList) == 0 {
@@ -325,7 +325,7 @@ func statefulSetMetricFamilies(allowAnnotationsList, allowLabelsList []string) [
325325
"kube_statefulset_deletion_timestamp",
326326
"Unix deletion timestamp",
327327
metric.Gauge,
328-
basemetrics.BETA,
328+
basemetrics.STABLE,
329329
"",
330330
wrapStatefulSetFunc(func(s *v1.StatefulSet) *metric.Family {
331331
ms := []*metric.Metric{}

‎internal/store/statefulset_test.go‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,13 @@ func TestStatefulSetStore(t *testing.T) {
6464
# HELP kube_statefulset_created [STABLE] Unix creation timestamp
6565
# HELP kube_statefulset_labels [STABLE] Kubernetes labels converted to Prometheus labels.
6666
# HELP kube_statefulset_metadata_generation [STABLE] Sequence number representing a specific generation of the desired state for the StatefulSet.
67-
# HELP kube_statefulset_persistentvolumeclaim_retention_policy [BETA] Count of retention policy for StatefulSet template PVCs
67+
# HELP kube_statefulset_persistentvolumeclaim_retention_policy [STABLE] Count of retention policy for StatefulSet template PVCs
6868
# HELP kube_statefulset_replicas [STABLE] Number of desired pods for a StatefulSet.
6969
# HELP kube_statefulset_ordinals_start [STABLE] Start ordinal of the StatefulSet.
7070
# HELP kube_statefulset_status_current_revision [STABLE] Indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
7171
# HELP kube_statefulset_status_observed_generation [STABLE] The generation observed by the StatefulSet controller.
7272
# HELP kube_statefulset_status_replicas [STABLE] The number of replicas per StatefulSet.
73-
# HELP kube_statefulset_status_replicas_available [BETA] The number of available replicas per StatefulSet.
73+
# HELP kube_statefulset_status_replicas_available [STABLE] The number of available replicas per StatefulSet.
7474
# HELP kube_statefulset_status_replicas_current [STABLE] The number of current replicas per StatefulSet.
7575
# HELP kube_statefulset_status_replicas_ready [STABLE] The number of ready replicas per StatefulSet.
7676
# HELP kube_statefulset_status_replicas_updated [STABLE] The number of updated replicas per StatefulSet.
@@ -146,12 +146,12 @@ func TestStatefulSetStore(t *testing.T) {
146146
Want: `
147147
# HELP kube_statefulset_labels [STABLE] Kubernetes labels converted to Prometheus labels.
148148
# HELP kube_statefulset_metadata_generation [STABLE] Sequence number representing a specific generation of the desired state for the StatefulSet.
149-
# HELP kube_statefulset_persistentvolumeclaim_retention_policy [BETA] Count of retention policy for StatefulSet template PVCs
149+
# HELP kube_statefulset_persistentvolumeclaim_retention_policy [STABLE] Count of retention policy for StatefulSet template PVCs
150150
# HELP kube_statefulset_replicas [STABLE] Number of desired pods for a StatefulSet.
151151
# HELP kube_statefulset_status_current_revision [STABLE] Indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
152152
# HELP kube_statefulset_status_observed_generation [STABLE] The generation observed by the StatefulSet controller.
153153
# HELP kube_statefulset_status_replicas [STABLE] The number of replicas per StatefulSet.
154-
# HELP kube_statefulset_status_replicas_available [BETA] The number of available replicas per StatefulSet.
154+
# HELP kube_statefulset_status_replicas_available [STABLE] The number of available replicas per StatefulSet.
155155
# HELP kube_statefulset_status_replicas_current [STABLE] The number of current replicas per StatefulSet.
156156
# HELP kube_statefulset_status_replicas_ready [STABLE] The number of ready replicas per StatefulSet.
157157
# HELP kube_statefulset_status_replicas_updated [STABLE] The number of updated replicas per StatefulSet.
@@ -218,11 +218,11 @@ func TestStatefulSetStore(t *testing.T) {
218218
Want: `
219219
# HELP kube_statefulset_labels [STABLE] Kubernetes labels converted to Prometheus labels.
220220
# HELP kube_statefulset_metadata_generation [STABLE] Sequence number representing a specific generation of the desired state for the StatefulSet.
221-
# HELP kube_statefulset_persistentvolumeclaim_retention_policy [BETA] Count of retention policy for StatefulSet template PVCs
221+
# HELP kube_statefulset_persistentvolumeclaim_retention_policy [STABLE] Count of retention policy for StatefulSet template PVCs
222222
# HELP kube_statefulset_replicas [STABLE] Number of desired pods for a StatefulSet.
223223
# HELP kube_statefulset_status_current_revision [STABLE] Indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
224224
# HELP kube_statefulset_status_replicas [STABLE] The number of replicas per StatefulSet.
225-
# HELP kube_statefulset_status_replicas_available [BETA] The number of available replicas per StatefulSet.
225+
# HELP kube_statefulset_status_replicas_available [STABLE] The number of available replicas per StatefulSet.
226226
# HELP kube_statefulset_status_replicas_current [STABLE] The number of current replicas per StatefulSet.
227227
# HELP kube_statefulset_status_replicas_ready [STABLE] The number of ready replicas per StatefulSet.
228228
# HELP kube_statefulset_status_replicas_updated [STABLE] The number of updated replicas per StatefulSet.
@@ -290,11 +290,11 @@ func TestStatefulSetStore(t *testing.T) {
290290
Want: `
291291
# HELP kube_statefulset_labels [STABLE] Kubernetes labels converted to Prometheus labels.
292292
# HELP kube_statefulset_metadata_generation [STABLE] Sequence number representing a specific generation of the desired state for the StatefulSet.
293-
# HELP kube_statefulset_persistentvolumeclaim_retention_policy [BETA] Count of retention policy for StatefulSet template PVCs
293+
# HELP kube_statefulset_persistentvolumeclaim_retention_policy [STABLE] Count of retention policy for StatefulSet template PVCs
294294
# HELP kube_statefulset_replicas [STABLE] Number of desired pods for a StatefulSet.
295295
# HELP kube_statefulset_status_current_revision [STABLE] Indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
296296
# HELP kube_statefulset_status_replicas [STABLE] The number of replicas per StatefulSet.
297-
# HELP kube_statefulset_status_replicas_available [BETA] The number of available replicas per StatefulSet.
297+
# HELP kube_statefulset_status_replicas_available [STABLE] The number of available replicas per StatefulSet.
298298
# HELP kube_statefulset_status_replicas_current [STABLE] The number of current replicas per StatefulSet.
299299
# HELP kube_statefulset_status_replicas_ready [STABLE] The number of ready replicas per StatefulSet.
300300
# HELP kube_statefulset_status_replicas_updated [STABLE] The number of updated replicas per StatefulSet.
@@ -363,12 +363,12 @@ func TestStatefulSetStore(t *testing.T) {
363363
Want: `
364364
# HELP kube_statefulset_labels [STABLE] Kubernetes labels converted to Prometheus labels.
365365
# HELP kube_statefulset_metadata_generation [STABLE] Sequence number representing a specific generation of the desired state for the StatefulSet.
366-
# HELP kube_statefulset_persistentvolumeclaim_retention_policy [BETA] Count of retention policy for StatefulSet template PVCs
366+
# HELP kube_statefulset_persistentvolumeclaim_retention_policy [STABLE] Count of retention policy for StatefulSet template PVCs
367367
# HELP kube_statefulset_replicas [STABLE] Number of desired pods for a StatefulSet.
368368
# HELP kube_statefulset_ordinals_start [STABLE] Start ordinal of the StatefulSet.
369369
# HELP kube_statefulset_status_current_revision [STABLE] Indicates the version of the StatefulSet used to generate Pods in the sequence [0,currentReplicas).
370370
# HELP kube_statefulset_status_replicas [STABLE] The number of replicas per StatefulSet.
371-
# HELP kube_statefulset_status_replicas_available [BETA] The number of available replicas per StatefulSet.
371+
# HELP kube_statefulset_status_replicas_available [STABLE] The number of available replicas per StatefulSet.
372372
# HELP kube_statefulset_status_replicas_current [STABLE] The number of current replicas per StatefulSet.
373373
# HELP kube_statefulset_status_replicas_ready [STABLE] The number of ready replicas per StatefulSet.
374374
# HELP kube_statefulset_status_replicas_updated [STABLE] The number of updated replicas per StatefulSet.
@@ -432,7 +432,7 @@ func TestStatefulSetStore(t *testing.T) {
432432
},
433433
},
434434
Want: `
435-
# HELP kube_statefulset_deletion_timestamp [BETA] Unix deletion timestamp
435+
# HELP kube_statefulset_deletion_timestamp [STABLE] Unix deletion timestamp
436436
# TYPE kube_statefulset_deletion_timestamp gauge
437437
kube_statefulset_deletion_timestamp{statefulset="statefulset6",namespace="ns6"} 1.8e+09
438438
`,

0 commit comments

Comments
 (0)