Skip to content

Commit ba27e2d

Browse files
committed
Rename volume reconstruction metrics
To better match other kubelet total/error_total metrics.
1 parent 42a4b1c commit ba27e2d

File tree

2 files changed

+18
-11
lines changed

2 files changed

+18
-11
lines changed

keps/sig-storage/3756-volume-reconstruction/README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -426,14 +426,14 @@ then periodically does:
426426
Today, any errors during volume reconstruction are exposed only as log messages.
427427
We propose adding these new metrics, both to the old and new VolumeManager code:
428428

429-
* `reconstructed_volumes_total` with label `result={success, error}`: nr. of
430-
successfully / unsuccessfully reconstructed volumes.
429+
* `reconstruct_volume_operations_total` / `reconstruct_volume_operations_errors_total`:
430+
nr. of all / unsuccessfully reconstructed volumes.
431431
* In the new VolumeManager code, this will include all volume mounts in
432432
`/var/lib/kubelet/pods/*/volumes`
433433
* In the old VolumeManager it will include only volumes that were not already
434434
in ASW (those are not reconstructed).
435-
* `force_cleaned_failed_volumes_total` with label `result={success, error}`: nr.
436-
of successful / unsuccessful cleanups of volumes that failed reconstruction.
435+
* `force_cleaned_failed_volume_operations_total` / `force_cleaned_failed_volume_operation_errors_total`: nr.
436+
of all / unsuccessful cleanups of volumes that failed reconstruction.
437437
* `orphaned_volumes_cleanup_errors_total`: nr. of reports
438438
like `orphaned pod "<uid>" found, but XYZ failed`
439439
([example](https://github.com/kubernetes/kubernetes/blob/4fac7486d41c033d6bba9dfeda2356e8189035cd/pkg/kubelet/kubelet_volumes.go#L215)).
@@ -740,7 +740,10 @@ What signals should users be paying attention to when the feature is young
740740
that might indicate a serious problem?
741741
-->
742742

743-
`reconstructed_volumes_total`, `force_cleaned_failed_volumes_total`,
743+
`reconstruct_volume_operations_total`,
744+
`reconstruct_volume_operations_errors_total`,
745+
`force_cleaned_failed_volume_operations_total`,
746+
`force_cleaned_failed_volume_operation_errors_total`,
744747
`orphaned_volumes_cleanup_errors_total`
745748

746749
See Observability in the detail design section. All newly introduced metrics
@@ -824,12 +827,12 @@ question.
824827

825828
These two metrics are populated during kubelet startup:
826829

827-
* `reconstructed_volumes_total{result="error"}` should be zero. An error here
830+
* `reconstruct_volume_operations_errors_total` should be zero. An error here
828831
means that kubelet was not able to reconstruct its cache of mounted volumes
829832
and appropriate volume plugin was not called to clean up a volume mount.
830833
There could be a leaked file or directory on the filesystem.
831834

832-
* `force_cleaned_failed_volumes_total{result="error"}` should be zero. An error
835+
* `force_cleaned_failed_volume_operation_errors_total` should be zero. An error
833836
here means that kubelet was not able to unmount a volume even with all
834837
fallbacks it has. There *is* at least a leaked directory on the filesystem,
835838
there could be also a leaked mount.
@@ -842,8 +845,10 @@ Pick one more of these and delete the rest.
842845

843846
- [X] Metrics
844847
- Metric name:
845-
- `reconstructed_volumes_total`
846-
- `force_cleaned_failed_volumes_total`
848+
- `reconstruct_volume_operations_total`
849+
- `reconstruct_volume_operations_errors_total`
850+
- `force_cleaned_failed_volume_operations_total`
851+
- `force_cleaned_failed_volume_operation_errors_total`
847852
- `orphaned_volumes_cleanup_errors_total`
848853
- Components exposing the metric: kubelet
849854

keps/sig-storage/3756-volume-reconstruction/kep.yaml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ disable-supported: true
4242

4343
# The following PRR answers are required at beta release
4444
metrics:
45-
- reconstructed_volumes_total
46-
- force_cleaned_failed_volumes_total
45+
- reconstruct_volume_operations_total
46+
- reconstruct_volume_operations_errors_total
47+
- force_cleaned_failed_volume_operations_total
48+
- force_cleaned_failed_volume_operation_errors_total
4749
- orphaned_volumes_cleanup_errors_total

0 commit comments

Comments
 (0)