Add guidelines for metric graduation #8709
Conversation
k8s-ci-robot
added
the
area/developer-guide
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: richabanker The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
size/S
k8s-ci-robot
added
approved
|
Unknown CLA label state. Rechecking for CLA labels. Send feedback to sig-contributor-experience at kubernetes/community. /check-cla |
k8s-ci-robot
added
the
cncf-cla: yes
| 1. **Testing requirement**: The metric must have comprehensive tests that validate: | ||
| - The metric is registered and emitted correctly | ||
| - The metric has the expected labels and values under known conditions | ||
| - The metric is included in the [stable metrics list](https://github.com/kubernetes/kubernetes/blob/master/test/instrumentation/testdata/stable-metrics-list.yaml). See the [instrumentation test README](https://github.com/kubernetes/kubernetes/tree/master/test/instrumentation/README.md) for steps on how to generate this file correctly. |
There was a problem hiding this comment.
Is this something we can enforce with a presubmit? E.g. a hack verify script?
|
|
||
| 2. **Stability validation**: The metric should have been at Beta stability for at least one release to ensure it has been sufficiently validated in production environments. | ||
|
|
||
| 3. **API Review**: Graduating a metric to Stable requires an API review by SIG Instrumentation, as it represents a contractual API agreement. See the [API Review](/contributors/devel/sig-instrumentation/metric-stability.md#api-review) section in the metrics stability documentation. |
There was a problem hiding this comment.
I think ideally we want to be part of beta graduation? Most of the time by the time something is going stable it is too late to make changes without breaking existing users.
Or maybe we should do API review when it is added and for beta graduation?
| #### Graduating to Stable | ||
|
|
||
| 1. **Testing requirement**: The metric must have comprehensive tests that validate: | ||
| - The metric is registered and emitted correctly |
There was a problem hiding this comment.
Can we just say that stable needs to meet all of the beta requirements?
4 participants
Which issue(s) this PR fixes: