Skip to content

Commit 9698f43

Browse files
authored
Update cloud pages for Serverless metrics (#471)
* Update cloud pages for Serverless metrics * rpk generate grafana dashboard * Add serverless metrics to What's New * Add rpk generate grafana-dashboard page to Cloud * Update local-antora-playbook.yml
1 parent 6f64e23 commit 9698f43

File tree

6 files changed

+24
-7
lines changed

6 files changed

+24
-7
lines changed

modules/ROOT/nav.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -537,6 +537,7 @@
537537
***** xref:reference:rpk/rpk-cluster/rpk-cluster-txn-list.adoc[]
538538
*** xref:reference:rpk/rpk-generate/rpk-generate.adoc[]
539539
**** xref:reference:rpk/rpk-generate/rpk-generate-app.adoc[]
540+
**** xref:reference:rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc[]
540541
**** xref:reference:rpk/rpk-generate/rpk-generate-shell-completion.adoc[]
541542
*** xref:reference:rpk/rpk-group/rpk-group.adoc[]
542543
**** xref:reference:rpk/rpk-group/rpk-group-delete.adoc[]

modules/get-started/pages/cloud-overview.adoc

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Redpanda Cloud offers three fully-managed cloud deployment options, each designe
8484
| ✓
8585

8686
| *Prometheus/OpenMetrics endpoint for cluster metrics*
87-
|
87+
|
8888
| ✓
8989
| ✓
9090

@@ -179,7 +179,6 @@ Consider BYOC or Dedicated if you need more control over the deployment or if yo
179179

180180
* Private networking
181181
* Multiple availability zones (AZs). A multi-AZ cluster provides higher resiliency in the event of a failure in one of the zones.
182-
* Ability to export Redpanda metrics to a third-party monitoring system
183182
* Role-based access control (RBAC) in the data plane
184183
* Kafka Connect
185184
* Higher limits and quotas. See xref:reference:tiers/byoc-tiers.adoc[BYOC usage tiers] and xref:reference:tiers/dedicated-tiers.adoc[Dedicated usage tiers] compared to xref:get-started:cluster-types/serverless.adoc#serverless-usage-limits[Serverless limits].

modules/get-started/pages/cluster-types/serverless.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,6 @@ Explore the rest of the UI:
8989
Not all features included in BYOC clusters are available in Serverless. For example, the following features are not supported:
9090

9191
* HTTP Proxy API
92-
* Ability to export metrics to a third-party monitoring system
9392
* Private networking (VPC peering or AWS PrivateLink)
9493
* Multiple availability zones (AZs)
9594
* RBAC in the data plane and mTLS authentication for Kafka API clients

modules/get-started/pages/whats-new-cloud.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ This page lists new features added to Redpanda Cloud.
88

99
== December 2025
1010

11+
=== Metrics for Serverless
12+
13+
You can now view and export metrics from Serverless clusters to third-party monitoring systems like Prometheus and Grafana. See xref:manage:monitor-cloud.adoc[Monitor Redpanda Cloud] for details on configuring monitoring for your Serverless cluster and xref:reference:public-metrics-reference.adoc[Metrics Reference] for a list of metrics available in Serverless.
14+
1115
=== Redpanda Connect updates
1216

1317
* Tracers:

modules/manage/pages/monitor-cloud.adoc

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,19 @@
44

55
You can configure monitoring on your cluster to maintain system health and optimize performance. You can monitor Redpanda with https://prometheus.io/[Prometheus^] or with any other monitoring and alerting tool, such as Datadog, New Relic, Elastic Cloud, Google Cloud, or Azure.
66

7-
Redpanda Cloud exports Redpanda metrics for all brokers and connectors from a single OpenMetrics endpoint. This endpoint can be found on the *Overview* page for your BYOC or Dedicated cluster, under *How to connect* and *Prometheus*.
7+
Redpanda Cloud exports Redpanda metrics for all brokers and connectors from a single OpenMetrics endpoint. This endpoint can be found on the *Overview* page for your cluster, under *How to connect* and *Prometheus*.
88

99

1010
[NOTE]
1111
====
1212
13-
- BYOC and Dedicated clusters can export Redpanda metrics to a third-party monitoring system. Serverless clusters _cannot_ export Redpanda metrics.
1413
- To maximize performance, Redpanda exports some metrics only when the underlying feature is in use. For example, a metric for consumer groups, xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_committed_offset[`redpanda_kafka_consumer_group_committed_offset`], is only exported when groups are registered.
1514
- 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).
1615
====
1716

1817
== Configure Redpanda monitoring
1918

20-
To monitor a BYOC or Dedicated cluster:
19+
To monitor a Redpanda Cloud cluster:
2120

2221
. On the Redpanda Cloud *Overview* page for your cluster, under *How to connect*, click the *Prometheus* tab.
2322

@@ -48,7 +47,7 @@ image::shared:cloud_metrics.png[How to connect screenshot]
4847

4948
== Configure Datadog
5049

51-
To monitor a Dedicated or BYOC cluster in https://www.datadoghq.com/[Datadog^]:
50+
To monitor a BYOC or Dedicated cluster in https://www.datadoghq.com/[Datadog^]:
5251

5352
. Follow the steps to configure Redpanda monitoring.
5453

@@ -79,6 +78,18 @@ image::https://github.com/redpanda-data/observability/blob/main/docs/images/Ops%
7978

8079
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.
8180

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:
86+
87+
[,bash]
88+
----
89+
rpk generate grafana-dashboard --dashboard serverless
90+
----
91+
====
92+
8293
== Monitor health and performance
8394

8495
include::ROOT:manage:partial$monitor-health.adoc[tag=single-source]
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
= rpk generate grafana-dashboard
2+
3+
include::ROOT:reference:rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc[tag=single-source]

0 commit comments

Comments
 (0)