kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #6565 from logicalhan/deprecate 

add deprecation policy guidelines to instrumenting kubernetes guide
This commit is contained in:
Kubernetes Prow Robot 2022-04-27 10:24:11 -07:00 committed by GitHub
parent e796bdd340 d03420721e
commit a858ed2d6d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
contributors/devel/sig-instrumentation/instrumentation.md
View File

@ -89,7 +89,7 @@ apply additionally.
Please see our documentation on Kubernetes [metrics stability](/contributors/devel/sig-instrumentation/metric-stability.md). 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. 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. 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”} 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.