Skip to content

Commit 96d00d4

Browse files
authored
Update throttle.md to describe --throttle-HTTP
1 parent 49270ee commit 96d00d4

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

doc/throttle.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,14 @@ Note that you may dynamically change both `--max-lag-millis` and the `throttle-c
4646

4747
An example query could be: `--throttle-query="select hour(now()) between 8 and 17"` which implies throttling auto-starts `8:00am` and migration auto-resumes at `18:00pm`.
4848

49+
#### HTTP Throttle
50+
51+
The `--throttle-HTTP` flag allows for throttling via HTTP. Every 100ms `gh-ost` issues a `HEAD` request to the provided URL. If the response status code is not `200` throttling will kick in until a `200` response status code is returned.
52+
53+
If no URL is provided or the URL provided doesn't contain the scheme then the HTTP check will be disabled. For example `--throttle-HTTP="http://1.2.3.4:6789/throttle"` will enable the HTTP check/throttling, but `--throttle-HTTP=1.2.3.4:6789/throttle` will not.
54+
55+
The URL can be queried and updated dynamically via [interactive interface](interactive-commands.md).
56+
4957
#### Manual control
5058

5159
In addition to the above, you are able to take control and throttle the operation any time you like.

0 commit comments

Comments
 (0)