Skip to content

Commit 70886e8

Browse files
Document default change for legacy-replication-lag-algorithm flag
1 parent 401264f commit 70886e8

2 files changed

Lines changed: 9 additions & 1 deletion

File tree

content/en/docs/24.0/reference/programs/vtgate/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ vtgate \
126126
--keep-logs-by-mtime duration keep logs for this long (using mtime) (zero to keep forever)
127127
--keyspaces-to-watch strings Specifies which keyspaces this vtgate should have access to while routing queries or accessing the vschema.
128128
--lameduck-period duration keep running at least this long after SIGTERM before stopping (default 50ms)
129-
--legacy-replication-lag-algorithm Use the legacy algorithm when selecting vttablets for serving. (default true)
129+
--legacy-replication-lag-algorithm (DEPRECATED) Use the legacy algorithm when selecting vttablets for serving.
130130
--lock-heartbeat-time duration If there is lock function used. This will keep the lock connection active by using this heartbeat (default 5s)
131131
--lock-timeout duration Maximum time to wait when attempting to acquire a lock from the topo server (default 45s)
132132
--log-err-stacks log stack traces for errors

content/en/docs/24.0/user-guides/configuration-advanced/query-load-balancing.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ weight: 12
55

66
For applications which scale out read queries using replicas, Vitess can safely avoid sending queries to replicas with replication lag beyond acceptable thresholds.
77

8+
{{< info >}}
9+
**Note:** Starting in Vitess v24, VTGate uses a simpler default algorithm for handling replication lag based on low lag thresholds, high lag thresholds, and minimum number of tablets. This algorithm is more stable in production environments.
10+
11+
The legacy algorithm is deprecated and will be removed in a future release.
12+
13+
For more details about the algorithm change, see the [v24.0 release notes](https://github.com/vitessio/vitess/blob/main/changelog/24.0/24.0.0/summary.md#vtgate-new-default-legacy-replication-lag-algorithm).
14+
{{< /info >}}
15+
816
## Flags
917

1018
You can set the following flags on VTGate to control load-balancing of read queries for replicas:

0 commit comments

Comments
 (0)