Skip to content

Commit d034207

Browse files
author
Han Kang
committed
add deprecation policy guidelines to instrumenting kubernetes guide
1 parent dbb243f commit d034207

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

contributors/devel/sig-instrumentation/instrumentation.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ apply additionally.
8989

9090
Please see our documentation on Kubernetes [metrics stability](/contributors/devel/sig-instrumentation/metric-stability.md).
9191

92-
## Naming
92+
## Naming
9393

9494
General [metric and label naming best practices](https://prometheus.io/docs/practices/naming/) apply.
9595
Beyond that, metrics added directly by application or package code should have a unique name.
@@ -242,3 +242,7 @@ metric could look as follows:
242242
```
243243
kube_pod_restarts and on(namespace, pod) kube_pod_info{uuid=”ABC”}
244244
```
245+
246+
## Deprecating Metrics
247+
248+
The process of metric deprecation is outlined in the official [Kubernetes Deprecation Policy](https://kubernetes.io/docs/reference/using-api/deprecation-policy/). When deprecating a metric, one must set the deprecated version for a version which is in the future from which point that metric will be considered deprecated. If there is a replacement metric, please note that in the help text of the deprecated metric as well as in the corresponding release note of the relevant pull request.

0 commit comments

Comments
 (0)