From fac75e133fd0a7e5096405411e850dcb0d87cddc Mon Sep 17 00:00:00 2001 From: Jan Fajerski Date: Wed, 27 Aug 2025 15:51:53 +0200 Subject: [PATCH] Add a note about following naming conventions in OCP Signed-off-by: Jan Fajerski --- content/Products/OpenshiftMonitoring/instrumentation.md | 2 +- content/Products/OpenshiftMonitoring/telemetry.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/content/Products/OpenshiftMonitoring/instrumentation.md b/content/Products/OpenshiftMonitoring/instrumentation.md index ca744c8..edc28aa 100644 --- a/content/Products/OpenshiftMonitoring/instrumentation.md +++ b/content/Products/OpenshiftMonitoring/instrumentation.md @@ -27,7 +27,7 @@ Prometheus supports 4 [metric types](https://prometheus.io/docs/concepts/metric_ Adding metrics for any operation should be part of the code review process like any other factor that is kept in mind for production ready code. -To learn more about when to use which metric type, how to name metrics and how to choose labels, read the following documentation: +To learn more about when to use which metric type, how to name metrics and how to choose labels, read the following documentation. {{% alert color="info" %}}OpenShift follows the outlined conventions whenever possible. Any exceptions should be reviewed and properly motivated.{{% /alert %}} * [Prometheus naming recommendations](https://prometheus.io/docs/practices/naming/) * [Prometheus instrumentation](https://prometheus.io/docs/practices/instrumentation/) * [Kubernetes metric instrumentation guide](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-instrumentation/metric-instrumentation.md) diff --git a/content/Products/OpenshiftMonitoring/telemetry.md b/content/Products/OpenshiftMonitoring/telemetry.md index c66e1c1..15006cc 100644 --- a/content/Products/OpenshiftMonitoring/telemetry.md +++ b/content/Products/OpenshiftMonitoring/telemetry.md @@ -110,6 +110,8 @@ spec: Your `PrometheusRule` object(s) should be created by your operator with your `ServiceMonitor` and/or `PodMonitor` objects. +Recording rule names should follow the [`level:metric:operations` pattern](https://prometheus.io/docs/practices/rules/). + ### Modify the Telemeter client's configuration 1. Clone the [cluster-monitoring-operator](https://github.com/openshift/cluster-monitoring-operator) repository locally.