Skip to content

Commit 6e85fc7

Browse files
authored
Add warning about unstable metrics in Prometheus documentation (#34097)
<!-- Describe the contents of the PR briefly but completely. If you write detailed commit messages, it is acceptable to copy/paste them here, or write "see commit messages for details." If there is only one commit in the PR, GitHub will have already added its commit message above. --> Will need to backport into the 25.2 docs branch <img width="820" height="154" alt="Screenshot 2025-11-12 at 2 38 25 PM" src="https://github.com/user-attachments/assets/a101051e-0030-4753-93bc-db204c8a2757" /> ### Motivation Adding this disclaimer because these metrics are inherently unstable https://materializeinc.slack.com/archives/C08ACQNGSQK/p1762900180147019 <!-- Which of the following best describes the motivation behind this PR? * This PR fixes a recognized bug. [Ensure issue is linked somewhere.] * This PR adds a known-desirable feature. [Ensure issue is linked somewhere.] * This PR fixes a previously unreported bug. [Describe the bug in detail, as if you were filing a bug report.] * This PR adds a feature that has not yet been specified. [Write a brief specification for the feature, including justification for its inclusion in Materialize, as if you were writing the original feature specification.] * This PR refactors existing code. [Describe what was wrong with the existing code, if it is not obvious.] --> ### Tips for reviewer <!-- Leave some tips for your reviewer, like: * The diff is much smaller if viewed with whitespace hidden. * [Some function/module/file] deserves extra attention. * [Some function/module/file] is pure code movement and only needs a skim. Delete this section if no tips. --> ### Checklist - [ ] This PR has adequate test coverage / QA involvement has been duly considered. ([trigger-ci for additional test/nightly runs](https://trigger-ci.dev.materialize.com/)) - [ ] This PR has an associated up-to-date [design doc](https://github.com/MaterializeInc/materialize/blob/main/doc/developer/design/README.md), is a design doc ([template](https://github.com/MaterializeInc/materialize/blob/main/doc/developer/design/00000000_template.md)), or is sufficiently small to not require a design. <!-- Reference the design in the description. --> - [ ] If this PR evolves [an existing `$T ⇔ Proto$T` mapping](https://github.com/MaterializeInc/materialize/blob/main/doc/developer/command-and-response-binary-encoding.md) (possibly in a backwards-incompatible way), then it is tagged with a `T-proto` label. - [ ] If this PR will require changes to cloud orchestration or tests, there is a companion cloud PR to account for those changes that is tagged with the release-blocker label ([example](MaterializeInc/cloud#5021)). <!-- Ask in #team-cloud on Slack if you need help preparing the cloud PR. --> - [ ] If this PR includes major [user-facing behavior changes](https://github.com/MaterializeInc/materialize/blob/main/doc/developer/guide-changes.md#what-changes-require-a-release-note), I have pinged the relevant PM to schedule a changelog post.
1 parent a100b7e commit 6e85fc7

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

doc/user/content/manage/monitor/self-managed/prometheus.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ menu:
88
identifier: "grafana-prometheus-sm"
99
---
1010

11+
{{< warning >}}
12+
The metrics scraped are unstable and may change across releases.
13+
{{< /warning >}}
14+
1115
This guide walks you through the steps required to monitor the performance and
1216
overall health of your Materialize instance using Prometheus and Grafana.
1317

0 commit comments

Comments
 (0)