Importing Grafana Dashboards#

The Grafana dashboards below are recommended for managing Materialize and its infrastructure. This page covers the ways to import them and where to download them.

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.

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.

  1. Download one of the corresponding .json files from the Download Dashboards section below.
  2. If you are not logged in via gcx, run gcx login --server YOUR_GRAFANA to authenticate with your Grafana instance.
  3. Run gcx dashboards create -f DOWNLOADED_FILE.json to import the dashboard to your Grafana instance.

Importing Dashboards via Grafana Operator#

This is the recommended path when the dashboards are installed by the materialize-monitoring Helm chart, since it keeps them in sync rather than importing a point-in-time copy. Refer to the Grafana Operator documentation.

For how the chart wires Grafana, the Grafana Operator, and the datasources together, see Grafana Architecture.

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 12 and 13 (Dashboard Schema v2)#

Right now, these are the only supported dashboards.

DashboardDescriptionAnnotations
Materialize Environment Overview
(env-top.json)

Overview of a Materialize Environment.

This provides a high-level summary to catch more obvious issues that may require further investigation.

min-mz-version: v26.24.0
rec-mz-version: v26.29.0
sql-metric-prefix: mz_
target-cloud: generic
target-export: generic
Materialize Environment Overview
(gcp-env-top.json)

Overview of a Materialize Environment.

This provides a high-level summary to catch more obvious issues that may require further investigation.

min-mz-version: v26.24.0
rec-mz-version: v26.29.0
sql-metric-prefix: mz_
target-cloud: gcp
target-export: generic

There are minor differences in Google Cloud Platform metrics exposed by GKE, so you should select a dashboard that has that particular cloud annotation.

Grafana 10 and 11 (Dashboard Schema v1)#

No matching dashboards found.