DEP-194 Replace observability docs with information about new stack - #38062
Open
Alphadelta14 wants to merge 2 commits into
Open
DEP-194 Replace observability docs with information about new stack#38062Alphadelta14 wants to merge 2 commits into
Alphadelta14 wants to merge 2 commits into
Conversation
Co-authored-by: Claude <claude@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the self-managed observability documentation to reflect the new Terraform-provisioned monitoring stack (Grafana + metrics + logs), replacing the prior Prometheus-scrape-config–focused docs and artifacts.
Changes:
- Removes the legacy “Grafana using Prometheus” guide and associated Prometheus scrape-config download/config artifacts.
- Adds a new Grafana guide describing the Terraform-managed monitoring stack and how to access it, including an alias to preserve the old
/manage/monitor/self-managed/prometheus/URL. - Updates self-managed monitoring index pages and Terraform variable documentation to point users to the new Grafana guide and
enable_observability.
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| doc/user/layouts/shortcodes/self-managed/step-download-prometheus-scrape-configs.html | Removes the old shortcode that instructed downloading Prometheus scrape configs. |
| doc/user/data/self_managed/monitoring/prometheus.yml | Removes the bundled Prometheus scrape configuration file from docs data. |
| doc/user/data/self_managed/installation.yml | Documents the enable_observability Terraform variable and links to the new Grafana page. |
| doc/user/content/manage/monitor/self-managed/prometheus.md | Removes the legacy Prometheus/Grafana setup guide. |
| doc/user/content/manage/monitor/self-managed/grafana.md | Adds the new Terraform-based monitoring stack documentation and keeps backward compatibility via an alias. |
| doc/user/content/manage/monitor/self-managed/_index.md | Updates the self-managed monitoring landing page link to the new Grafana guide. |
| doc/user/content/manage/monitor/_index.md | Updates the overall monitoring landing page link to the new Grafana guide. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|  | ||
|
|
||
| For what each dashboard covers, see the [dashboard documentation | ||
| ⧉](https://materializeinc.github.io/materialize-monitoring/dashboards/). |
Contributor
There was a problem hiding this comment.
I see a blank page when I click on this link https://materializeinc.github.io/materialize-monitoring/dashboards/
Member
Author
There was a problem hiding this comment.
claude sends you his regards
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
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
To fully release our new observability infrastructure in self-managed, we need to document it.
Description
This documents the changes landing in MaterializeInc/materialize-terraform-self-managed#359.
Simply enabling enable_observability=true will stand up the new observability modules once the new TF lands.
To discriminate external resources, I included the ⧉ marker (which I have in the monitoring docsite automatically, but had to add specifically here).
Verification
This has been rigorously tested in various environments over the past few weeks in many variations.
Doc preview: https://preview.materialize.com/materialize/38062/manage/monitor/self-managed/grafana/