Skip to content

Commit 9012001

Browse files
micheleRPJakeSCahill
authored andcommitted
DOC-1407 single source additions for Cloud (#1139)
1 parent 151a4eb commit 9012001

4 files changed

Lines changed: 26 additions & 3 deletions

File tree

local-antora-playbook.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ content:
1717
- url: https://github.com/redpanda-data/docs
1818
branches: [main, v/*, api, shared, site-search,'!v-end-of-life/*']
1919
- url: https://github.com/redpanda-data/cloud-docs
20-
branches: 'main'
20+
branches: 'DOC-1404-Document-new-configurable-property'
2121
- url: https://github.com/redpanda-data/redpanda-labs
2222
branches: main
2323
start_paths: [docs,'*/docs']

modules/manage/partials/monitor-health.adoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
== Monitor for performance and health
2+
// tag::single-source[]
23

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

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

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

242243
- 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.
244+
ifndef::env-cloud[]
245+
[,bash]
243246
- 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.
247+
endif::[]
244248
+
245249
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.
246250

@@ -394,3 +398,6 @@ rate(redpanda_rest_proxy_request_errors_total[5m])
394398
=== Data transforms
395399

396400
See xref:develop:data-transforms/monitor.adoc[].
401+
402+
// end::single-source[]
403+

modules/reference/pages/properties/cluster-properties.adoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1215,6 +1215,7 @@ Enables cluster metadata uploads. Required for xref:manage:whole-cluster-restore
12151215

12161216
---
12171217

1218+
// tag::enable_consumer_group_metrics[]
12181219
=== enable_consumer_group_metrics
12191220

12201221
List of enabled consumer group metrics. Accepted values include:
@@ -1225,20 +1226,32 @@ List of enabled consumer group metrics. Accepted values include:
12251226
+
12261227
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.
12271228
+
1229+
ifndef::env-cloud[]
12281230
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.
1231+
endif::[]
12291232

12301233
*Requires restart:* No
12311234

12321235
*Visibility:* `user`
12331236

12341237
*Type:* array
12351238

1239+
ifndef::env-cloud[]
12361240
*Default:* `["group", "partition"]`
12371241

12381242
*Related topics*:
12391243

12401244
- xref:manage:monitoring.adoc#consumers[Monitor consumer group lag]
1245+
endif::[]
1246+
1247+
ifdef::env-cloud[]
1248+
*Related topics*:
1249+
1250+
- xref:manage:monitor-cloud.adoc#consumers[Monitor consumer group lag]
1251+
endif::[]
1252+
12411253
---
1254+
// end::enable_consumer_group_metrics[]
12421255

12431256
=== enable_controller_log_rate_limiting
12441257

modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-get.adoc

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
= rpk cluster config get
2+
// tag::single-source[]
23

34
Get a cluster configuration property.
45

@@ -31,4 +32,6 @@ rpk cluster config get <key> [flags]
3132
|--profile |string |Profile to use. See xref:reference:rpk/rpk-profile.adoc[`rpk profile`] for more details.
3233

3334
|-v, --verbose |- |Enable verbose logging.
34-
|===
35+
|===
36+
37+
// end::single-source[]

0 commit comments

Comments
 (0)