Monitoring and alerting
View as MarkdownCloud
Monitoring
You can monitor the performance and overall health of your Materialize region. To help you get started, the following guides are available:
Alerting
After setting up a monitoring tool, you can configure alert rules. Alert rules send a notification when a metric surpasses a threshold. This will help you prevent operational incidents. For alert rules guidelines, see Alerting.
Self-Managed
Monitoring
You can monitor the performance and overall health of your Self-Managed Materialize.
The Materialize Terraform modules (AWS ⧉, Azure ⧉, GCP ⧉) install a monitoring stack alongside your deployment. It is enabled by default starting with v12.0.0 of the Materialize Terraform Modules. For the module install steps, see Install using Terraform modules.
The stack collects metrics and logs from Materialize and from the cluster, stores them in your own infrastructure, and ships dashboards to query them:
-
How logs and metrics are stored, including the backends you can forward them to.
-
Grafana, the dashboards and query interface that ship with the stack.
To configure the stack outside the Materialize Terraform modules, or to see the
full set of module variables, see the materialize-monitoring Terraform
installation guide
⧉.
To send metrics and logs to a platform you already run, a guide is available for each destination:
-
OpenTelemetry, for any other OTLP endpoint, including your own collector.
-
Prometheus remote write, for Mimir, Amazon Managed Prometheus, Grafana Cloud, or a Thanos you run elsewhere.
Alerting
After setting up a monitoring tool, you can configure alert rules. Alert rules send a notification when a metric surpasses a threshold. This will help you prevent operational incidents. For alert rules guidelines, see Alerting.