Skip to content

Commit c1b9cd1

Browse files
soepic1ericyan
andauthored
Apply suggestions from code review
Co-authored-by: Eric Yan <ericyan@github.com>
1 parent 361aeb6 commit c1b9cd1

1 file changed

Lines changed: 2 additions & 3 deletions

File tree

doc/throttle.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +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-
2927
Example: `--throttle-control-replicas=myhost1.com:3306,myhost2.com,myhost3.com:3307`
3028

29+
Note that these must be replicas within the migrated table's replication chain. `gh-ost` does not verify that the hosts in the list are part of it, so unrelated hosts will report healthy lag while your real replicas go unmonitored.
30+
3131
- `--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.
3232

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

35-
3635
#### Status thresholds
3736

3837
- `--max-load`: list of metrics and threshold values; topping the threshold of any will cause throttler to kick in.

0 commit comments

Comments
 (0)