You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: keps/sig-instrumentation/3498-extending-stability/README.md
+6-5Lines changed: 6 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -224,8 +224,9 @@ Alpha metrics have no stability guarantees but are parseable by the static analy
224
224
`Beta` metrics have *some* stability guarantees. Specifically, we guarantee that:
225
225
226
226
-`Beta` metrics will not be removed without first being explicitly deprecated.
227
-
+ you can deprecate Beta metrics at any point if because of changes in underlying code/feature (i.e. it's impossible to compute such metric with the code changes, you can remove it after one release)
228
-
+ if the metric is still possible to expose (we just think it's not the right one, e.g. we want to remove some label), but technically can still expose it, we leave it deprecated for 3 releases
227
+
+ you can deprecate Beta metrics at any point:
228
+
* if because of changes in underlying code/feature it's impossible to compute such metric the metric can be removed after one release
229
+
* if the metric is still possible to expose (we just think it's not the right one, e.g. we want to remove some label), but technically can still expose it, we leave it deprecated for 3 releases
229
230
- Furthermore, `Beta` metrics are guaranteed to be **forward compatible** in respect to alerts and queries which may be written against them. By "forward compatible", we mean that queries and alerts which are written against the metric and its labels will continue to work in the future. We ensure forward compatibility by ensuring that **labels can only be added**, *and not removed*, from `Beta` metrics.
230
231
-`Beta` metrics will be included in metric auto-documentation
231
232
@@ -343,7 +344,7 @@ This should not affect upgrade/rollback paths.
343
344
344
345
###### Is the rollout accompanied by any deprecations and/or removals of features, APIs, fields of API types, flags, etc.?
345
346
346
-
No.
347
+
`Alpha` metrics will be recategorized as `Internal`.
347
348
348
349
### Monitoring Requirements
349
350
@@ -365,15 +366,15 @@ N/A
365
366
366
367
###### Are there any missing metrics that would be useful to have to improve observability of this feature?
367
368
368
-
`registered_metrics_total` will be used to calculate the number of registered stable metrics.
369
+
No.
369
370
370
371
### Dependencies
371
372
372
373
Prometheus and the Kubernetes metric framework.
373
374
374
375
###### Does this feature depend on any specific services running in the cluster?
375
376
376
-
In order to ingest these metrics, one needs a prometheus scraping agent and some backend to persist the metric data.
0 commit comments