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
Clarify Grafana usage on Cloud monitoring page (#582)
* Clarify Grafana usage on Cloud monitoring page
The Cloud Prometheus endpoint is a scrape (exposition) endpoint, not a
PromQL query API, so users who plug the Console-displayed URL/credentials
straight into a Grafana Prometheus data source get 401 Unauthorized.
Add a "Connect Grafana" section explaining the architecture and showing
the Prometheus/Alloy/Mimir-in-the-middle pattern, label the scrape YAML
explicitly, and move the rpk generate grafana-dashboard tip next to the
Grafana steps where readers will look for it.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* minor edit after testing
* Move Connect Grafana section before Configure Datadog
Places the Grafana section directly after Configure Redpanda monitoring,
since the scrape YAML already mentions Grafana-compatible scrapers and
the Grafana section back-references that config. Datadog moves after.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: modules/manage/pages/monitor-cloud.adoc
+32-17Lines changed: 32 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,15 +14,16 @@ Redpanda Cloud exports Redpanda metrics for all brokers and connectors from a si
14
14
- Operating system-level and node-level metrics (such as CPU, memory, disk, and network usage) are not available through this endpoint. For infrastructure monitoring, use your cloud provider's native monitoring tools (such as Azure Monitor, AWS CloudWatch, or Google Cloud Monitoring).
15
15
====
16
16
17
+
[#configure-redpanda-monitoring]
17
18
== Configure Redpanda monitoring
18
19
19
20
To monitor a Redpanda Cloud cluster:
20
21
21
-
. On the Redpanda Cloud *Overview* page for your cluster, under *How to connect*, click the *Prometheus* tab.
22
+
. On the Redpanda Cloud *Overview* page for your cluster, under *How to connect*, click the *Prometheus* tab.
22
23
23
-
. Click the copy icon for *Prometheus YAML* to copy the contents to your clipboard.
24
+
. Click the copy icon for *Prometheus YAML* to copy the contents to your clipboard.
24
25
+
25
-
The YAML contains the Prometheus scrape target configuration, as well as authentication, for the cluster.
26
+
The YAML is a Prometheus scrape configuration. Use it with Prometheus, or with any Prometheus-compatible scraper such as Grafana Alloy, Grafana Agent, Grafana Mimir, Thanos, or VictoriaMetrics.
26
27
+
27
28
image::shared:cloud_metrics.png[How to connect screenshot]
28
29
+
@@ -45,9 +46,35 @@ image::shared:cloud_metrics.png[How to connect screenshot]
45
46
* `<prom_pass>`: Copy and paste the onscreen Prometheus password.
46
47
47
48
49
+
[#connect-grafana]
50
+
== Connect Grafana
51
+
52
+
The Redpanda Cloud metrics endpoint (`/api/cloud/prometheus/public_metrics`) is a Prometheus exposition (scrape) endpoint, not a Prometheus query API. You cannot point a Grafana Prometheus data source at it directly. Grafana issues PromQL queries to paths such as `/api/v1/query`, which the endpoint does not serve, so the requests fail with `401 Unauthorized`.
53
+
54
+
To use Grafana with Redpanda Cloud metrics, run a Prometheus-compatible scraper between Redpanda Cloud and Grafana:
55
+
56
+
. Configure a scraper to pull metrics from Redpanda Cloud, using the Basic Auth scrape configuration from <<configure-redpanda-monitoring>>. Compatible scrapers include:
57
+
+
58
+
* Prometheus
59
+
* Grafana Alloy or Grafana Agent
60
+
* Grafana Mimir, Thanos, or VictoriaMetrics
61
+
62
+
. In Grafana, add a Prometheus data source pointing at your scraper, not at the Redpanda Cloud endpoint.
63
+
64
+
. Import a sample dashboard into Grafana. Use xref:reference:rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc[`rpk generate grafana-dashboard`] to generate a dashboard from the https://github.com/redpanda-data/observability/tree/main/cloud[redpanda-data/observability^] repository, or browse the https://github.com/redpanda-data/observability#grafana-dashboards[example Grafana dashboards^] directly.
65
+
+
66
+
For example, to generate the sample Serverless dashboard, run:
For an end-to-end example with Prometheus and Grafana running in Docker, see the https://github.com/redpanda-data/observability#sandbox-environment[Redpanda Cloud sandbox^] in the same repository.
74
+
48
75
== Configure Datadog
49
76
50
-
To monitor a BYOC or Dedicated cluster in https://www.datadoghq.com/[Datadog^]:
77
+
To monitor a BYOC or Dedicated cluster in https://www.datadoghq.com/[Datadog^]:
51
78
52
79
. Follow the steps to configure Redpanda monitoring.
53
80
@@ -76,19 +103,7 @@ For hands-on learning, Redpanda provides a repository with examples of monitorin
It includes https://github.com/redpanda-data/observability#grafana-dashboards[example Grafana dashboards^] and a https://github.com/redpanda-data/observability#sandbox-environment[sandbox environment^] in which you launch a Dockerized Redpanda cluster and create a custom workload to monitor with dashboards.
80
-
81
-
[TIP]
82
-
====
83
-
Use xref:reference:rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc[`rpk generate grafana-dashboard`] to generate a sample dashboard from the examples repository that you can import into a Grafana instance.
84
-
85
-
For example, to generate the sample Serverless dashboard, run:
It includes https://github.com/redpanda-data/observability#grafana-dashboards[example Grafana dashboards^] and a https://github.com/redpanda-data/observability#sandbox-environment[Redpanda Cloud sandbox^] in which you launch a Dockerized Redpanda cluster and create a custom workload to monitor with dashboards.
0 commit comments