Skip to content

Add a note about following naming conventions in OCP #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
simonpasquier merged 1 commit into from
Sep 1, 2025
Merged

Add a note about following naming conventions in OCP #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/Products/OpenshiftMonitoring/instrumentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 2 additions & 0 deletions content/Products/OpenshiftMonitoring/telemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/).

@simonpasquier simonpasquier Aug 29, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since we add the comment today :)

Suggested change
Recording rule names should follow the [`level:metric:operations` pattern](https://prometheus.io/docs/practices/rules/).
Recording rule names should follow the [`level:metric:operations` pattern](https://prometheus.io/docs/practices/rules/). When counting items, prefer the `:count` suffix over the `:total` suffix (the latter is used to signal an accumulating counter, for example a total count of requests).


### Modify the Telemeter client's configuration

1. Clone the [cluster-monitoring-operator](https://github.com/openshift/cluster-monitoring-operator) repository locally.
Expand Down