From de09429f0cd431ed4e3782ef5b2dc666b50e0e5b Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Tue, 27 May 2025 17:29:18 -0600 Subject: [PATCH 1/5] DOC-1407 single source additions for Cloud --- local-antora-playbook.yml | 2 +- .../pages/properties/cluster-properties.adoc | 15 +++++++++++++++ .../rpk/rpk-cluster/rpk-cluster-config-get.adoc | 5 ++++- 3 files changed, 20 insertions(+), 2 deletions(-) diff --git a/local-antora-playbook.yml b/local-antora-playbook.yml index 0f53a55d6e..f25059d6e1 100644 --- a/local-antora-playbook.yml +++ b/local-antora-playbook.yml @@ -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'] diff --git a/modules/reference/pages/properties/cluster-properties.adoc b/modules/reference/pages/properties/cluster-properties.adoc index d2b4f4a8c7..e80ca040ef 100644 --- a/modules/reference/pages/properties/cluster-properties.adoc +++ b/modules/reference/pages/properties/cluster-properties.adoc @@ -1215,10 +1215,12 @@ 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: +ifndef::env-cloud[] - `group`: Enables the xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_consumers[`redpanda_kafka_consumer_group_consumers`] and xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_topics[`redpanda_kafka_consumer_group_topics`] metrics. - `partition`: Enables the xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_committed_offset[`redpanda_kafka_consumer_group_committed_offset`] metric. - `consumer_lag`: Enables the xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_lag_max[`redpanda_kafka_consumer_group_lag_max`] and xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_lag_sum[`redpanda_kafka_consumer_group_lag_sum`] metrics @@ -1226,6 +1228,15 @@ 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. + 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::[] + +ifdef::env-cloud[] +- `group`: Enables the `redpanda_kafka_consumer_group_consumers` and `redpanda_kafka_consumer_group_topics` metrics. +- `partition`: Enables the `redpanda_kafka_consumer_group_committed_offset` metric. +- `consumer_lag`: Enables the `redpanda_kafka_consumer_group_lag_max` and `redpanda_kafka_consumer_group_lag_sum` metrics ++ +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. +endif::[] *Requires restart:* No @@ -1233,12 +1244,16 @@ Use the xref:reference:properties/cluster-properties.adoc#consumer_group_lag_col *Type:* array +ifndef::env-cloud[] *Default:* `["group", "partition"]` *Related topics*: - xref:manage:monitoring.adoc#consumers[Monitor consumer group lag] +endif::[] + --- +// end::enable_consumer_group_metrics[] === enable_controller_log_rate_limiting diff --git a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc index ccca664eee..3633e0e607 100644 --- a/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc +++ b/modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc @@ -1,4 +1,5 @@ = rpk cluster config get +// tag::single-source[] Get a cluster configuration property. @@ -29,4 +30,6 @@ rpk cluster config get [flags] |--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details. |-v, --verbose |- |Enable verbose logging. -|=== \ No newline at end of file +|=== + +// end::single-source[] \ No newline at end of file From ee8acf30ebb884cb9626a2d6bfeae4aa6d237f5a Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Thu, 29 May 2025 16:32:26 -0600 Subject: [PATCH 2/5] single source monitor-health partial --- modules/manage/partials/monitor-health.adoc | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/modules/manage/partials/monitor-health.adoc b/modules/manage/partials/monitor-health.adoc index 465788c853..3595989c4b 100644 --- a/modules/manage/partials/monitor-health.adoc +++ b/modules/manage/partials/monitor-health.adoc @@ -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. @@ -237,10 +238,12 @@ 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[] - 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. @@ -394,3 +397,6 @@ rate(redpanda_rest_proxy_request_errors_total[5m]) === Data transforms See xref:develop:data-transforms/monitor.adoc[]. + +// end::single-source[] + From e86448e0260081d4c7813ad19bcd1181ed29a86d Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Thu, 29 May 2025 16:38:47 -0600 Subject: [PATCH 3/5] unconditionalize, temporary --- modules/manage/partials/monitor-health.adoc | 2 -- 1 file changed, 2 deletions(-) diff --git a/modules/manage/partials/monitor-health.adoc b/modules/manage/partials/monitor-health.adoc index 3595989c4b..8b3914c7c9 100644 --- a/modules/manage/partials/monitor-health.adoc +++ b/modules/manage/partials/monitor-health.adoc @@ -241,9 +241,7 @@ Aggregates the lag across all partitions, providing an overall view of data cons 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[] - 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. From 10dbadf604f966afcd07241f240ed9ab8a676abb Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Thu, 29 May 2025 20:54:50 -0600 Subject: [PATCH 4/5] add related topic for Cloud --- modules/reference/pages/properties/cluster-properties.adoc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/modules/reference/pages/properties/cluster-properties.adoc b/modules/reference/pages/properties/cluster-properties.adoc index e80ca040ef..256ff31e3b 100644 --- a/modules/reference/pages/properties/cluster-properties.adoc +++ b/modules/reference/pages/properties/cluster-properties.adoc @@ -1236,6 +1236,10 @@ ifdef::env-cloud[] - `consumer_lag`: Enables the `redpanda_kafka_consumer_group_lag_max` and `redpanda_kafka_consumer_group_lag_sum` metrics + 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. + +*Related topics*: + +- xref:manage:monitor-cloud.adoc#consumers[Monitor consumer group lag] endif::[] *Requires restart:* No From 90ce28ecb15699040a9d76de5e8830023b77b6ed Mon Sep 17 00:00:00 2001 From: Michele Cyran Date: Mon, 2 Jun 2025 12:05:05 -0600 Subject: [PATCH 5/5] fix links --- modules/manage/partials/monitor-health.adoc | 3 +++ .../pages/properties/cluster-properties.adoc | 20 +++++++------------ 2 files changed, 10 insertions(+), 13 deletions(-) diff --git a/modules/manage/partials/monitor-health.adoc b/modules/manage/partials/monitor-health.adoc index 8b3914c7c9..60671d762f 100644 --- a/modules/manage/partials/monitor-health.adoc +++ b/modules/manage/partials/monitor-health.adoc @@ -241,7 +241,10 @@ Aggregates the lag across all partitions, providing an overall view of data cons 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. diff --git a/modules/reference/pages/properties/cluster-properties.adoc b/modules/reference/pages/properties/cluster-properties.adoc index 256ff31e3b..cd39f4d37e 100644 --- a/modules/reference/pages/properties/cluster-properties.adoc +++ b/modules/reference/pages/properties/cluster-properties.adoc @@ -1220,28 +1220,16 @@ Enables cluster metadata uploads. Required for xref:manage:whole-cluster-restore List of enabled consumer group metrics. Accepted values include: -ifndef::env-cloud[] - `group`: Enables the xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_consumers[`redpanda_kafka_consumer_group_consumers`] and xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_topics[`redpanda_kafka_consumer_group_topics`] metrics. - `partition`: Enables the xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_committed_offset[`redpanda_kafka_consumer_group_committed_offset`] metric. - `consumer_lag`: Enables the xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_lag_max[`redpanda_kafka_consumer_group_lag_max`] and xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_lag_sum[`redpanda_kafka_consumer_group_lag_sum`] metrics + 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::[] -ifdef::env-cloud[] -- `group`: Enables the `redpanda_kafka_consumer_group_consumers` and `redpanda_kafka_consumer_group_topics` metrics. -- `partition`: Enables the `redpanda_kafka_consumer_group_committed_offset` metric. -- `consumer_lag`: Enables the `redpanda_kafka_consumer_group_lag_max` and `redpanda_kafka_consumer_group_lag_sum` metrics -+ -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. - -*Related topics*: - -- xref:manage:monitor-cloud.adoc#consumers[Monitor consumer group lag] -endif::[] - *Requires restart:* No *Visibility:* `user` @@ -1256,6 +1244,12 @@ ifndef::env-cloud[] - 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[]