You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update Prometheus monitoring documentation to include Grafana integration and new dashboards
- Made section less specific to prometheus-community
- Added steps to install Grafana
- Introduced two new Grafana dashboard JSON files: `environment_overview_dashboard.json` and `freshness_overview_dashboard.json`.
description: "How to monitor the performance and overall health of your Materialize instance using the prometheus-community helm chart."
2
+
title: "Grafana using Prometheus"
3
+
description: "How to monitor the performance and overall health of your Materialize instance using Prometheus and Grafana."
4
4
menu:
5
5
main:
6
6
parent: "monitor"
7
7
weight: 1
8
8
---
9
9
10
10
This guide walks you through the steps required to monitor the performance and
11
-
overall health of your Materialize instance using the [`prometheus-community/prometheus`](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus) helm chart.
11
+
overall health of your Materialize instance using Prometheus and Grafana.
12
12
13
13
## Before you begin
14
14
@@ -22,51 +22,60 @@ Ensure you have:
22
22
This guide assumes you have administrative access to your Kubernetes cluster and the necessary permissions to install Prometheus.
23
23
{{< /important >}}
24
24
25
-
## 1. Install Prometheus to your Kubernetes cluster using [`prometheus-community/prometheus`](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus)
2. Download the prometheus-community default chart values:
31
+
## 2. Install Prometheus to your Kubernetes cluster using [`prometheus-community/prometheus`](https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus) (Optional)
32
+
33
+
1. Download the prometheus-community default chart values (`values.yaml`):
1. Install the Grafana helm chart following [this guide](https://grafana.com/docs/grafana/latest/setup-grafana/installation/helm/)
59
52
60
-
{{< note >}}
61
-
The port forwarding method described below is for testing purposes only. For production environments, configure an ingress controller to securely expose the Prometheus UI.
62
-
{{< /note >}}
63
53
64
-
1. Set up port forwarding to access the Prometheus UI:
54
+
2. Set up port forwarding to access the Grafana UI:
55
+
```bash
56
+
MZ_POD_GRAFANA=$(kubectl get pods -n monitoring -l app.kubernetes.io/name=grafana -o custom-columns="NAME:.metadata.name" --no-headers)
The port forwarding method is for testing purposes only. For production environments, configure an ingress controller to securely expose the Grafana UI.
62
+
{{< /note >}}
63
+
64
+
3. Within the UI, add a Prometheus data source where the URL is `http://<prometheus server name>.<namespace>.svc.cluster.local:<port>`(i.e. `http://prometheus-server.prometheus.svc.cluster.local:80`)
65
+
66
+

67
+
68
+
4. Download the following dashboards:
69
+
```bash
70
+
# Environment overview: An overview of the state of different objects in your environment
5. [Import the dashboards using the Prometheus data source](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/import-dashboards/#importing-a-dashboard)
70
80
71
-
2. Access the Prometheus UI by navigating to `localhost:9090` in your web
72
-
browser.
81
+

0 commit comments