Skip to content

Commit de09429

Browse files
committed
DOC-1407 single source additions for Cloud
1 parent 3dc1e40 commit de09429

File tree

3 files changed

+20
-2
lines changed

3 files changed

+20
-2
lines changed

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: [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/reference/pages/properties/cluster-properties.adoc

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1215,30 +1215,45 @@ 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:
12211222

1223+
ifndef::env-cloud[]
12221224
- `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.
12231225
- `partition`: Enables the xref:reference:public-metrics-reference.adoc#redpanda_kafka_consumer_group_committed_offset[`redpanda_kafka_consumer_group_committed_offset`] metric.
12241226
- `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
12251227
+
12261228
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.
12271229
+
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::[]
1232+
1233+
ifdef::env-cloud[]
1234+
- `group`: Enables the `redpanda_kafka_consumer_group_consumers` and `redpanda_kafka_consumer_group_topics` metrics.
1235+
- `partition`: Enables the `redpanda_kafka_consumer_group_committed_offset` metric.
1236+
- `consumer_lag`: Enables the `redpanda_kafka_consumer_group_lag_max` and `redpanda_kafka_consumer_group_lag_sum` metrics
1237+
+
1238+
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.
1239+
endif::[]
12291240

12301241
*Requires restart:* No
12311242

12321243
*Visibility:* `user`
12331244

12341245
*Type:* array
12351246

1247+
ifndef::env-cloud[]
12361248
*Default:* `["group", "partition"]`
12371249

12381250
*Related topics*:
12391251

12401252
- xref:manage:monitoring.adoc#consumers[Monitor consumer group lag]
1253+
endif::[]
1254+
12411255
---
1256+
// end::enable_consumer_group_metrics[]
12421257

12431258
=== enable_controller_log_rate_limiting
12441259

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

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

3132
|-v, --verbose |- |Enable verbose logging.
32-
|===
33+
|===
34+
35+
// end::single-source[]

0 commit comments

Comments
 (0)