Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion local-antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ content:
- url: https://github.com/redpanda-data/docs
branches: [v/*, api, shared, site-search,'!v-end-of-life/*']
- url: https://github.com/redpanda-data/cloud-docs
branches: 'main'
branches: 'DOC-1404-Document-new-configurable-property'
- url: https://github.com/redpanda-data/redpanda-labs
branches: main
start_paths: [docs,'*/docs']
Expand Down
9 changes: 8 additions & 1 deletion modules/manage/partials/monitor-health.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
== Monitor for performance and health
// tag::single-source[]

This section provides guidelines and example queries using Redpanda's public metrics to optimize your system's performance and monitor its health.

Expand Down Expand Up @@ -237,10 +238,13 @@ Reports the maximum lag observed among all partitions for a consumer group. This
- xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_lag_sum[`redpanda_kafka_consumer_group_lag_sum`]:
Aggregates the lag across all partitions, providing an overall view of data consumption delay for the consumer group.

To enable these dedicated gauges, you must enable consumer group metrics in your cluster properties. Add the following settings to your Redpanda configuration:
To enable these dedicated gauges, you must enable consumer group metrics in your cluster properties. Add the following to your Redpanda configuration:

- xref:reference:properties/cluster-properties.adoc#enable_consumer_group_metrics[`enable_consumer_group_metrics`]: A list of properties to enable for consumer group metrics. You must add the `consumer_lag` property to enable consumer group lag metrics.
ifndef::env-cloud[]
[,bash]
- xref:reference:properties/cluster-properties.adoc#consumer_group_lag_collection_interval_sec[`consumer_group_lag_collection_interval_sec`] (optional): The interval in seconds for collecting consumer group lag metrics. The default is 60 seconds.
endif::[]
+
Set this value equal to the scrape interval of your metrics collection system. Aligning these intervals ensures synchronized data collection, reducing the likelihood of missing or misaligned lag measurements.

Expand Down Expand Up @@ -394,3 +398,6 @@ rate(redpanda_rest_proxy_request_errors_total[5m])
=== Data transforms

See xref:develop:data-transforms/monitor.adoc[].

// end::single-source[]

13 changes: 13 additions & 0 deletions modules/reference/pages/properties/cluster-properties.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1215,6 +1215,7 @@ Enables cluster metadata uploads. Required for xref:manage:whole-cluster-restore

---

// tag::enable_consumer_group_metrics[]
=== enable_consumer_group_metrics

List of enabled consumer group metrics. Accepted values include:
Expand All @@ -1225,20 +1226,32 @@ List of enabled consumer group metrics. Accepted values include:
+
Enabling `consumer_lag` may add a small amount of additional processing overhead to the brokers, especially in environments with a high number of consumer groups or partitions.
+
ifndef::env-cloud[]
Use the xref:reference:properties/cluster-properties.adoc#consumer_group_lag_collection_interval_sec[`consumer_group_lag_collection_interval_sec`] property to control the frequency of consumer lag metric collection.
endif::[]

*Requires restart:* No

*Visibility:* `user`

*Type:* array

ifndef::env-cloud[]
*Default:* `["group", "partition"]`

*Related topics*:

- xref:manage:monitoring.adoc#consumers[Monitor consumer group lag]
endif::[]

ifdef::env-cloud[]
*Related topics*:

- xref:manage:monitor-cloud.adoc#consumers[Monitor consumer group lag]
endif::[]

---
// end::enable_consumer_group_metrics[]

=== enable_controller_log_rate_limiting

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= rpk cluster config get
// tag::single-source[]

Get a cluster configuration property.

Expand Down Expand Up @@ -29,4 +30,6 @@ rpk cluster config get <key> [flags]
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.

|-v, --verbose |- |Enable verbose logging.
|===
|===

// end::single-source[]