Update instructions generally for Grafana/prometheus setups#37306
Open
Alphadelta14 wants to merge 2 commits into
Open
Update instructions generally for Grafana/prometheus setups#37306Alphadelta14 wants to merge 2 commits into
Alphadelta14 wants to merge 2 commits into
Conversation
val-materialize
approved these changes
Jun 25, 2026
| overall health of your Materialize instance using Prometheus and Grafana. | ||
|
|
||
| {{< important >}} | ||
| Every monitoring setup is unique, so be sure to adopt the steps in this guide to your specific environment and requirements. |
Contributor
There was a problem hiding this comment.
Typo: "adopt" → "adapt" — should read "be sure to adapt the steps in this guide to your specific environment."
| ```bash | ||
| MZ_POD_GRAFANA=$(kubectl get pods -n monitoring -l app.kubernetes.io/name=grafana -o custom-columns="NAME:.metadata.name" --no-headers) | ||
| kubectl port-forward pod/$MZ_POD_GRAFANA 3000:3000 -n monitoring | ||
| kubectl port-forward svc/grafana 3000:80 -n monitoring |
Contributor
There was a problem hiding this comment.
Where does Grafana come from? This targets svc/grafana in the monitoring namespace, but the guide only shows installing Prometheus into the prometheus namespace — nothing deploys Grafana into monitoring. Does it ship via the observability.* helm values? If so, worth a one-line note so this port-forward resolves for anyone following top-to-bottom.
| # freshness_overview_dashboard.json | ||
| curl -O https://raw.githubusercontent.com/MaterializeInc/materialize/refs/heads/self-managed-docs/v25.2/doc/user/data/monitoring/grafana_dashboards/freshness_overview_dashboard.json | ||
| ``` | ||
| 4. Download dashboards from our [Grafana dashboards repository](https://materializeinc.github.io/materialize-monitoring/dashboards/grafana/) |
Contributor
There was a problem hiding this comment.
Suggested change
| 4. Download dashboards from our [Grafana dashboards repository](https://materializeinc.github.io/materialize-monitoring/dashboards/grafana/) | |
| 5. Download dashboards from our [Grafana dashboards repository](https://materializeinc.github.io/materialize-monitoring/dashboards/grafana/) |
| ``` | ||
| 4. Download dashboards from our [Grafana dashboards repository](https://materializeinc.github.io/materialize-monitoring/dashboards/grafana/) | ||
|
|
||
| 5. [Import the dashboards using the Prometheus data source](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/import-dashboards/#importing-a-dashboard) |
Contributor
There was a problem hiding this comment.
Suggested change
| 5. [Import the dashboards using the Prometheus data source](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/import-dashboards/#importing-a-dashboard) | |
| 6. [Import the dashboards using the Prometheus data source](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/import-dashboards/#importing-a-dashboard) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
We added new dashboards and scrapeconfigs for Grafana and prometheus. This updates our existing instructions to point to the new resources.
Description
Our newer terraform modules does support setting up prometheus and Grafana, but not everyone is using our newer terraform modules unfortunately.
In the meantime, we are just updating our helm instructions.
In the future, we will provide an extensive productionalized monitoring setup in self-managed that will totally supersede these docs.
This is a short term stopgap to declare success where we currently are.
Verification
Tested on Self-Managed AWS, and Self-Managed GCP.