Skip to content

Commit be47e0e

Browse files
authored
Merge pull request #5529 from richabanker/metrics-stability
[KEP: 1209] Update metrics stability KEP to match official metrics deprecation policy
2 parents df74511 + bad2bce commit be47e0e

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

keps/sig-instrumentation/1209-metrics-stability/kubernetes-control-plane-metrics-stability.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,12 @@ some_counter 0
235235
```
236236
Like their stable metric counterparts, deprecated metrics will be automatically registered to the metrics endpoint.
237237

238-
On a subsequent release (when the metric's deprecatedVersion is equal to current_kubernetes_version - 1)), a deprecated metric will become a __hidden metric__. _Unlike_ their deprecated counterparts, hidden metrics will __*no longer be automatically registered*__ to the metrics endpoint (hence hidden). However, they can be explicitly enabled through a command line flag on the binary (i.e. '--show-hidden-metrics-for-version=<previous minor release>'). This is to provide cluster admins an escape hatch to properly migrate off of a deprecated metric, if they were not able to react to the earlier deprecation warnings. Hidden metrics should be deleted after one release.
238+
On a subsequent release, a deprecated metric will become a hidden metric. This occurs after a specific period following its announced deprecation, based on the metric's stability level:
239+
* STABLE metrics become hidden after a minimum of 3 releases or 9 months, whichever is longer.
240+
* BETA metrics become hidden after a minimum of 1 release or 4 months, whichever is longer.
241+
* ALPHA metrics can be hidden or removed in the same release in which they are deprecated.
242+
243+
A hidden metric is __*no longer automatically registered*__ but can be explicitly enabled by a cluster administrator for a single release through a command line flag on the binary (i.e. '--show-hidden-metrics-for-version=<previous minor release>') before it is deleted entirely.
239244
240245
### Show Hidden Metrics
241246
As described above, admins can enable hidden metrics through a command-line flag on a specific binary.

0 commit comments

Comments
 (0)