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/manage/partials/monitor-health.adoc b/modules/manage/partials/monitor-health.adoc index 465788c853..60671d762f 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,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. @@ -394,3 +398,6 @@ rate(redpanda_rest_proxy_request_errors_total[5m]) === Data transforms See xref:develop:data-transforms/monitor.adoc[]. + +// end::single-source[] + diff --git a/modules/reference/pages/properties/cluster-properties.adoc b/modules/reference/pages/properties/cluster-properties.adoc index d2b4f4a8c7..cd39f4d37e 100644 --- a/modules/reference/pages/properties/cluster-properties.adoc +++ b/modules/reference/pages/properties/cluster-properties.adoc @@ -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: @@ -1225,7 +1226,9 @@ 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 @@ -1233,12 +1236,22 @@ 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::[] + +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 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