Skip to content

Commit 1b4a73c

Browse files
committed
adjust hwm and apply code review
1 parent 16e4761 commit 1b4a73c

File tree

3 files changed

+11
-3
lines changed

3 files changed

+11
-3
lines changed

modules/manage/pages/disaster-recovery/shadowing/failover-runbook.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,12 @@ Name: <topic-name>, State: ACTIVE
128128
1 2345 2579 2568 11
129129
----
130130

131+
The partition information shows:
132+
* **SRC_LSO**: Source partition Last Stable Offset
133+
* **SRC_HWM**: Source partition High Watermark
134+
* **DST_HWM**: Shadow (destination) partition High Watermark
135+
* **Lag**: Message count difference between source and shadow partitions
136+
131137
[IMPORTANT]
132138
====
133139
Note the replication lag to estimate potential data loss during failover. The `Tasks` section shows the health of shadow link replication tasks. For details about what each task does, see xref:setup.adoc#shadow-link-tasks[].

modules/manage/pages/disaster-recovery/shadowing/monitor.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The status output includes:
5353
* **Shadow link state**: Overall operational state (`ACTIVE`)
5454
* **Individual topic states**: Current state of each replicated topic (`ACTIVE`, `FAULTED`, `FAILING_OVER`, `FAILED_OVER`)
5555
* **Task status**: Health of replication tasks across brokers (`ACTIVE`, `FAULTED`, `NOT_RUNNING`, `LINK_UNAVAILABLE`). For details about shadow link tasks, see xref:setup.adoc#shadow-link-tasks[].
56-
* **Lag information**: Replication lag per partition showing source vs shadow watermarks
56+
* **Lag information**: Replication lag per partition showing source vs shadow high watermarks (HWM)
5757

5858
[[shadow-link-metrics]]
5959
== Metrics
@@ -66,7 +66,7 @@ Shadowing provides comprehensive metrics to track replication performance and he
6666

6767
|`redpanda_shadow_link_shadow_lag`
6868
|Gauge
69-
|The lag of the shadow partition against the source partition, calculated as source partition LSO minus shadow partition HWM. Monitor by `shadow_link_name`, `topic`, and `partition` to understand replication lag for each partition.
69+
|The lag of the shadow partition against the source partition, calculated as source partition LSO (Last Stable Offset) minus shadow partition HWM (High Watermark). Monitor by `shadow_link_name`, `topic`, and `partition` to understand replication lag for each partition.
7070

7171
|`redpanda_shadow_link_total_bytes_fetched`
7272
|Count

modules/manage/pages/disaster-recovery/shadowing/setup.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,8 @@ acl_filters:
278278

279279
Consumer group filters determine which consumer groups have their offsets replicated to the shadow cluster by the <<consumer-group-shadowing-task,Consumer Group Shadowing task>>. By default, all consumer groups are replicated unless you specify filters.
280280

281+
Offset replication operates selectively within each consumer group. Only committed offsets for active shadow topics are synchronized, even if the consumer group has offsets for additional topics that aren't being shadowed. For example, if consumer group "app-consumers" has committed offsets for "orders", "payments", and "inventory" topics, but only "orders" is an active shadow topic, then only the "orders" offsets will be replicated to the shadow cluster.
282+
281283
[,yaml]
282284
----
283285
consumer_offset_sync_options:
@@ -296,7 +298,7 @@ consumer_offset_sync_options:
296298

297299
**Avoid name conflicts:** If you plan to consume data from the shadow cluster, do not use the same consumer group names as those used on the source cluster. While this won't break shadow linking, it can impact your RPO/RTO because conflicting group names may interfere with offset replication and consumer resumption during disaster recovery.
298300

299-
**Offset clamping:** When Redpanda replicates consumer group offsets from the source cluster, offsets are automatically "clamped" during the commit process. If a replicated offset is above the high watermark (HWM) of the shadow partition, Redpanda clamps the offset to the shadow partition's HWM. This ensures offsets remain valid and prevents consumers from seeking beyond available data on the shadow cluster.
301+
**Offset clamping:** When Redpanda replicates consumer group offsets from the source cluster, offsets are automatically "clamped" during the commit process on the shadow cluster. If a committed offset from the source cluster is above the high watermark (HWM) of the corresponding shadow partition, Redpanda clamps the offset to the shadow partition's HWM before committing it to the shadow cluster. This ensures offsets remain valid and prevents consumers from seeking beyond available data on the shadow cluster.
300302

301303
=== Starting offset for new shadow topics
302304

0 commit comments

Comments
 (0)