Skip to content

Commit bf6f435

Browse files
committed
Add an Observability Compatibility Policy
Signed-off-by: Shirly Radco <[email protected]>
1 parent 7eb8dff commit bf6f435

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/monitoring-guidelines.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## Cluster Network Addons Operator Monitoring
2+
3+
### Observability Compatibility Policy
4+
5+
This policy covers all Cluster Network Addons Operator observability signals. Like: metrics (and their names, label sets, and types), Prometheus recording rules, and alerting rules. Unless explicitly stated otherwise, these signals are considered implementation details and are subject to change.
6+
7+
- Stability: Cluster Network Addons Operator does not guarantee long-term backwards compatibility for observability signals. Names, labels, types, and semantics may change between releases to improve correctness, performance, or operability.
8+
- Deprecation: When feasible, we will deprecate renamed or removed signals by:
9+
- Marking the old name as Deprecated in documentation.
10+
- Optionally providing short-lived compatibility recording rules (aliases) that map new signals to old names.
11+
- Keeping deprecated signals for at least one minor release when possible. In exceptional cases (security, correctness, or scalability), changes may occur without a deprecation window.
12+
- Communication: Material changes will be documented in release notes and reflected in `docs/observability/metrics.md`. Alert and rule updates will also be surfaced via PR descriptions.
13+
- Consumer guidance: Dashboards and alerts should:
14+
- When creating PromQL queries, expect label sets to change; avoid relying on exhaustive or fixed labels. Select, join, and group by the minimum labels required.
15+
- Example: Prefer `sum by (namespace)(...)` over `sum by (namespace,pod,container,instance)(...)` when possible.
16+
- Treat deprecated signals as temporary and migrate to replacements promptly.
17+
18+
Contributors adding or changing observability signals should update documentation, consider temporary compatibility rules if practical, and include migration notes in the PR and release notes.

0 commit comments

Comments
 (0)