Skip to content

Commit bdf0a73

Browse files
author
Han Kang
committed
amend beta requirements
1 parent 135c8a1 commit bdf0a73

File tree

1 file changed

+3
-1
lines changed
  • keps/sig-instrumentation/3498-extending-stability

1 file changed

+3
-1
lines changed

keps/sig-instrumentation/3498-extending-stability/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,9 @@ Alpha metrics have no stability guarantees but are parseable by the static analy
223223

224224
`Beta` metrics have *some* stability guarantees. Specifically, we guarantee that:
225225

226-
- `Beta` metrics will not be removed without first being explicitly deprecated. After deprecation, the metric will be removed in 4 months or 1 release.
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
227229
- 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.
228230
- `Beta` metrics will be included in metric auto-documentation
229231

0 commit comments

Comments
 (0)