Skip to content

Commit 361aeb6

Browse files
authored
docs: condense throttle-control-replicas note per review feedback
1 parent 838e59a commit 361aeb6

1 file changed

Lines changed: 2 additions & 8 deletions

File tree

doc/throttle.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,14 @@ Otherwise you may specify your own list of replica servers you wish it to observ
2424

2525
- `--throttle-control-replicas`: list of replicas you explicitly wish `gh-ost` to check for replication lag.
2626

27+
- _Note:_ these hosts should be actual replicas within the migrated table's replication chain — pointing this at unrelated hosts can report healthy lag while leaving your real downstream replicas unmonitored.
28+
2729
Example: `--throttle-control-replicas=myhost1.com:3306,myhost2.com,myhost3.com:3307`
2830

2931
- `--max-lag-millis`: maximum allowed lag; any controlled replica lagging more than this value will cause throttling to kick in. When all control replicas have smaller lag than indicated, operation resumes.
3032

3133
Note that you may dynamically change both `--max-lag-millis` and the `throttle-control-replicas` list via [interactive commands](interactive-commands.md)
3234

33-
### Important: choosing the right hosts for `--throttle-control-replicas`
34-
35-
The hosts you list here should be genuine replicas within the actual replication topology of the table being migrated — not arbitrary hosts, and not replicas of an unrelated database or instance.
36-
37-
It's possible to point `--throttle-control-replicas` at hosts that gh-ost can successfully connect to and poll for lag, even if those hosts have no replication relationship to the table actually being migrated. In that scenario, gh-ost will report healthy, low lag numbers throughout the migration — but this gives a false sense of safety, because the replica that actually matters (e.g., one serving downstream read traffic or analytics for the table being changed) is never being monitored at all, and could be silently falling behind without triggering any throttling.
38-
39-
Before running a migration, confirm the hosts you're passing to `--throttle-control-replicas` are actually replicating from the same primary and the same table you're migrating — ideally, the specific replica(s) that downstream consumers of that table's data depend on.
40-
4135

4236
#### Status thresholds
4337

0 commit comments

Comments
 (0)