Skip to content

[DOCS] Document throttle_period_in_millis for watcher actions #45607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 19, 2019
Merged

[DOCS] Document throttle_period_in_millis for watcher actions #45607

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
369941b
[DOCS] Document `throttle_period_in_millis` for watcher actions
jrodewig Aug 15, 2019
cfe41d9
Reverse override statements
jrodewig Aug 16, 2019
deaef45
Correct override based on request order
jrodewig Aug 16, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion x-pack/docs/en/rest-api/watcher/put-watch.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,18 @@ A watch has the following fields:

| `throttle_period` | The minimum time between actions being run, the default
for this is 5 seconds. This default can be changed in the
config file with the setting `xpack.watcher.throttle.period.default_period`.
config file with the setting
`xpack.watcher.throttle.period.default_period`. If both
this value and the `throttle_period_in_millis` parameter
are specified, {watcher} uses the last parameter
included in the request.

| `throttle_period_in_millis` | Minimum time in milliseconds between actions
being run. Defaults to `5000`. If both this
value and the `throttle_period` parameter are
specified, {watcher} uses the last parameter
included in the request.

|======

[float]
Expand Down