add some documentation around the metrics stability migration changes for clarity

This commit is contained in:
Han Kang
2019-08-26 19:15:30 -07:00
parent 6eee64c308
commit 4e5d906c4d
10 changed files with 80 additions and 0 deletions

View File

@@ -46,6 +46,14 @@ import (
"k8s.io/klog"
)
/*
* By default, all the following metrics are defined as falling under
* ALPHA stability level https://github.com/kubernetes/enhancements/blob/master/keps/sig-instrumentation/20190404-kubernetes-control-plane-metrics-stability.md#stability-classes)
*
* Promoting the stability level of the metric is a responsibility of the component owner, since it
* involves explicitly acknowledging support for the metric across multiple releases, in accordance with
* the metric stability policy.
*/
var (
tunnelOpenCounter = metrics.NewCounter(
&metrics.CounterOpts{