Grafana Dashboards#
This section contains documentation for Grafana Dashboards that are recommended for managing Materialize and its infrastructure.
Importing Dashboards via the Grafana UI#
Download one of the corresponding .json files from the Download Dashboards section below.
From a Grafana instance, navigate to the “New” menu on any page or within a specific folder. Then, select “Import” and choose the “Upload .json file” option.
You may opt to change the title or UID at time of import. The recommended filters are already in place.
TODO: expose other toggles upon import. TODO: move some filters off of hidden variables.
Importing Dashboards via gcx (grafana-cli)#
gcx is a CLI interface for managing Grafana from the command line. It is built for Dashboards-as-Code workflows and AI agent usage.
- Download one of the corresponding
.jsonfiles from the Download Dashboards section below. - If you are not logged in via
gcx, rungcx login --server YOUR_GRAFANAto authenticate with your Grafana instance. - Run
gcx dashboards create -f DOWNLOADED_FILE.jsonto import the dashboard to your Grafana instance.
Importing Dashboards via Grafana Operator#
Refer to the Grafana Operator documentation.
Download Dashboards#
Below you will find links to download the Grafana dashboards in JSON format. These dashboards use features from latest Grafana versions, so be sure to check the compatibility of your Grafana instance before importing.
Checking your Grafana Version#
To check your Grafana version, navigate to the Grafana instance and click on the “Help” menu (represented by a question mark icon) in the left sidebar. Selecting it will show the current version.
Grafana 13 (Dashboard Schema v2)#
Right now, these are the only supported dashboards.
| Dashboard | Description | Download |
|---|---|---|
| Materialize Environment Overview | Overview of a Materialize Environment. This provides a high-level summary to catch more obvious issues that may require further investigation. | mz-mon-env-top |
Grafana 12 (Dashboard Schema v2beta1)#
No matching dashboards found.
Grafana 10 and 11 (Dashboard Schema v1)#
No matching dashboards found.