Skip to content

Commit 8eddc56

Browse files
authored
update observability docs to align with prometheus's docs (#7000)
Signed-off-by: Adam D. Cornett <adc@redhat.com>
1 parent 8c4d551 commit 8eddc56

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

website/content/en/docs/best-practices/observability-best-practices.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,15 @@ See [Alerts, Metrics and Recording Rules Tests](#alerts-metrics-and-recording-ru
8888
As per [Prometheus](https://prometheus.io/docs/prometheus) documentation, [Recording rules](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#recording-rules) allow you to pre-compute frequently needed or computationally expensive expressions and save their result as a new set of time series.
8989

9090
**Note:** The Prometheus recording rules appear in Prometheus UI as metrics.
91-
In order to easily identify your operator recording rules, their names should usually follow the same naming guidelines as the metrics.
91+
Recording rule names should follow the `level:metric:operations` format as specified in the [Prometheus recording rules best practices](https://prometheus.io/docs/practices/rules/). This naming convention makes it clear that the metric is a recording rule and helps consumers understand they need to examine the underlying query to fully understand what the metric provides.
92+
93+
- **level:** represents the aggregation level and labels of the rule output
94+
- **metric:** is the metric name
95+
- **operations:** is a list of operations that were applied to the metric, newest operation first
96+
97+
For example: `job:up:avg_over_time` or `instance:node_cpu_utilisation:rate5m`
98+
99+
In addition to this format, your operator recording rules should also follow the same naming guidelines as metrics for consistency within your operator's observability stack.
92100

93101
See [Alerts, Metrics and Recording Rules Tests](#alerts-metrics-and-recording-rules-tests) section for recording rules testing recommendations.
94102

0 commit comments

Comments
 (0)