Add a note about following naming conventions in OCP#82
Add a note about following naming conventions in OCP#82simonpasquier merged 1 commit intorhobs:mainfrom
Conversation
jan--f
force-pushed
the
note-naming-convention
branch
from
8cd3134 to
e5f1e1b
Compare
| 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. OpenShift follows the outlined conventions whenever possible. Any exceptions should be reviewed and properly motivated. |
There was a problem hiding this comment.
maybe move it after the bullet points and put the sentence into a big warning box?
we could also mention in https://rhobs-handbook.netlify.app/products/openshiftmonitoring/telemetry.md/#configure-recording-rules that recording rule names should follow the cluster:metric:operations pattern and link to https://prometheus.io/docs/practices/rules/. WDYT?
There was a problem hiding this comment.
maybe move it after the bullet points and put the sentence into a big warning box?
Hmm which syntax do we use for a waring box?
I added it before intentionally since I fear its easier to ignore after the list.
There was a problem hiding this comment.
our doc theme supports alert boxes. I'm trying it here: https://www.docsy.dev/docs/adding-content/shortcodes/#alert
jan--f
force-pushed
the
note-naming-convention
branch
2 times, most recently
from
9b77e1b to
fa30fbb
Compare
|
|
||
| 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/). |
There was a problem hiding this comment.
since we add the comment today :)
| 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). |
| 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. OpenShift follows the outlined conventions whenever possible. Any exceptions should be reviewed and properly motivated. |
There was a problem hiding this comment.
our doc theme supports alert boxes. I'm trying it here: https://www.docsy.dev/docs/adding-content/shortcodes/#alert
Signed-off-by: Jan Fajerski <jfajersk@redhat.com>
jan--f
force-pushed
the
note-naming-convention
branch
from
fa30fbb to
fac75e1
Compare
2 participants
No description provided.