diff options
| author | Kubernetes Prow Robot <k8s-ci-robot@users.noreply.github.com> | 2022-04-27 10:24:11 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-04-27 10:24:11 -0700 |
| commit | a858ed2d6db36fcb8aea48e1cd0ba724eece33b7 (patch) | |
| tree | 25754a13f3a0218a07b912b616c26dcfea1e349c | |
| parent | e796bdd340a1e200cfc35a494fc7974ce45ce17e (diff) | |
| parent | d03420721e0c2a922382e247c0326e2b25be1d85 (diff) | |
Merge pull request #6565 from logicalhan/deprecate
add deprecation policy guidelines to instrumenting kubernetes guide
| -rw-r--r-- | contributors/devel/sig-instrumentation/instrumentation.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/contributors/devel/sig-instrumentation/instrumentation.md b/contributors/devel/sig-instrumentation/instrumentation.md index 4cd9bd1d..2c48ffcc 100644 --- a/contributors/devel/sig-instrumentation/instrumentation.md +++ b/contributors/devel/sig-instrumentation/instrumentation.md @@ -89,7 +89,7 @@ apply additionally. Please see our documentation on Kubernetes [metrics stability](/contributors/devel/sig-instrumentation/metric-stability.md). -## Naming +## Naming General [metric and label naming best practices](https://prometheus.io/docs/practices/naming/) apply. Beyond that, metrics added directly by application or package code should have a unique name. @@ -242,3 +242,7 @@ metric could look as follows: ``` kube_pod_restarts and on(namespace, pod) kube_pod_info{uuid=”ABC”} ``` + +## Deprecating Metrics + +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. |