Skip to content

Commit 8be2d3e

Browse files
authored
DOC-1070 Prometheus endpoint scrapes Redpanda metrics (#375)
* DOC-1070 Prometheus endpoint scrapes Redpanda metrics * minor edits * review feedback * explain OpenMetrics endpoint + clarifying edits
1 parent c7483d0 commit 8be2d3e

File tree

2 files changed

+21
-16
lines changed

2 files changed

+21
-16
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Consider BYOC or Dedicated if you need more control over the deployment or if yo
9999

100100
* Private networking
101101
* Multiple availability zones (AZs). A multi-AZ cluster provides higher resiliency in the event of a failure in one of the zones.
102-
* Ability to export metrics to a 3rd-party monitoring system
102+
* Ability to export Redpanda metrics to a third-party monitoring system
103103
* Kafka Connect
104104
* 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].
105105

modules/manage/pages/monitor-cloud.adoc

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,55 @@
11
= Monitor Redpanda Cloud
2-
:description: Learn how to configure monitoring on your Dedicated or BYOC cluster to maintain system health and optimize performance.
2+
:description: Learn how to configure monitoring on your BYOC or Dedicated cluster to maintain system health and optimize performance.
33
:page-aliases: manage:monitoring.adoc, deploy:deployment-option/cloud/monitor-cloud.adoc
44

5-
You can configure monitoring on your Redpanda Dedicated or BYOC cluster to maintain system health and optimize performance. Redpanda Cloud exports metrics for all brokers and Kafka Connect workers from a single Prometheus endpoint. This endpoint can be found on the *Overview* page for your cluster, under *How to connect*.
5+
You can configure monitoring on your Redpanda BYOC or Dedicated 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+
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*.
68

7-
You can monitor Redpanda with Prometheus or with any other monitoring and alerting tool, such as Datadog, New Relic, Elastic Cloud, Google, or Azure.
89

910
[NOTE]
1011
====
11-
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.
12+
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.
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).
1215
====
1316

14-
== Configure Prometheus
17+
== Configure Redpanda monitoring
1518

16-
To monitor a Dedicated or BYOC cluster in https://prometheus.io/[Prometheus^]:
19+
To monitor a BYOC or Dedicated cluster:
1720

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

2023
. Click the copy icon for *Prometheus YAML* to copy the contents to your clipboard.
2124
+
22-
image::shared:cloud_metrics.png[How to connect screenshot]
23-
+
2425
The YAML contains the Prometheus scrape target configuration, as well as authentication, for the cluster.
2526
+
27+
image::shared:cloud_metrics.png[How to connect screenshot]
28+
+
2629
[,yaml]
2730
----
2831
- job_name: redpandaCloud-sample
2932
static_configs:
3033
- targets:
31-
- console-<id>.<identifier>.fmc.cloud.redpanda.com
34+
- console-<id>.<identifier>.byoc.cloud.redpanda.com
3235
metrics_path: /api/cloud/prometheus/public_metrics
3336
basic_auth:
3437
username: prometheus
3538
password: "<prom_pass>"
3639
scheme: https
3740
----
3841

39-
. Save this information to Prometheus, and observe in Prometheus that metrics from Redpanda endpoints are scraped.
42+
. Save these settings to Prometheus or another monitoring tool, replacing the following placeholders:
43+
+
44+
* `<id>.<identifier>`: ID and identifier from the HTTPS endpoint.
45+
* `<prom_pass>`: Copy and paste the onscreen Prometheus password.
46+
4047

4148
== Configure Datadog
4249

43-
To monitor a Dedicated or BYOC cluster in https://www.datadoghq.com/[Datadog]:
44-
45-
. On the Redpanda Cloud *Overview* page for your cluster, under *How to connect*, click the *Prometheus* tab.
50+
To monitor a Dedicated or BYOC cluster in https://www.datadoghq.com/[Datadog^]:
4651

47-
. Click the copy icon for *Prometheus YAML* to find scrape target configuration, as well as authentication, for the cluster.
52+
. Follow the steps to configure Redpanda monitoring.
4853

4954
. In Datadog, define the `openmetrics_endpoint` URL for that monitored cluster. The integration configuration should look similar to the following:
5055
+
@@ -63,7 +68,7 @@ instances:
6368

6469
. Restart the Datadog agent.
6570

66-
NOTE: Because the Prometheus endpoint in Redpanda Cloud aggregates metrics for all cluster services, only a single Datadog agent is required. The agent must run in a container in your own container infrastructure. Redpanda does not support launching this container inside a Dedicated or BYOC Kubernetes cluster. For more information, see the https://docs.datadoghq.com/integrations/redpanda/?tab=host[Datadog documentation^] and https://github.com/DataDog/integrations-extras/tree/master/redpanda[Redpanda Datadog integration^].
71+
NOTE: Because the OpenMetrics endpoint in Redpanda Cloud aggregates Redpanda metrics for all cluster services, only a single Datadog agent is required. The agent must run in a container in your own container infrastructure. Redpanda does not support launching this container inside a Dedicated or BYOC Kubernetes cluster. For more information, see the https://docs.datadoghq.com/integrations/redpanda/?tab=host[Datadog documentation^] and https://github.com/DataDog/integrations-extras/tree/master/redpanda[Redpanda Datadog integration^].
6772

6873
== Use Redpanda monitoring examples
6974

0 commit comments

Comments
 (0)