|
4 | 4 |
|
5 | 5 | 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. |
6 | 6 |
|
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*. |
8 | 8 |
|
9 | 9 |
|
10 | 10 | [NOTE] |
11 | 11 | ==== |
12 | 12 |
|
13 | | -- BYOC and Dedicated clusters can export Redpanda metrics to a third-party monitoring system. Serverless clusters _cannot_ export Redpanda metrics. |
14 | 13 | - 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. |
15 | 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). |
16 | 15 | ==== |
17 | 16 |
|
18 | 17 | == Configure Redpanda monitoring |
19 | 18 |
|
20 | | -To monitor a BYOC or Dedicated cluster: |
| 19 | +To monitor a Redpanda Cloud cluster: |
21 | 20 |
|
22 | 21 | . On the Redpanda Cloud *Overview* page for your cluster, under *How to connect*, click the *Prometheus* tab. |
23 | 22 |
|
@@ -48,7 +47,7 @@ image::shared:cloud_metrics.png[How to connect screenshot] |
48 | 47 |
|
49 | 48 | == Configure Datadog |
50 | 49 |
|
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^]: |
52 | 51 |
|
53 | 52 | . Follow the steps to configure Redpanda monitoring. |
54 | 53 |
|
@@ -79,6 +78,18 @@ image::https://github.com/redpanda-data/observability/blob/main/docs/images/Ops% |
79 | 78 |
|
80 | 79 | 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. |
81 | 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: |
| 86 | +
|
| 87 | +[,bash] |
| 88 | +---- |
| 89 | +rpk generate grafana-dashboard --dashboard serverless |
| 90 | +---- |
| 91 | +==== |
| 92 | + |
82 | 93 | == Monitor health and performance |
83 | 94 |
|
84 | 95 | include::ROOT:manage:partial$monitor-health.adoc[tag=single-source] |
|
0 commit comments