Skip to content

[DOCS] Add examples in watchers definitions that uses throttle_period_in_millis #45346

@laraMorenoIgle

Description

@laraMorenoIgle

Description of the problem including expected versus actual behavior:

When defining an action in a watcher you can configure a throttle period.

In the documentation all the examples use throttle_period parameter, but you could use throttle_period_in_millis instead, since, as per the code both parameters are accepted.
However, throttle_period_in_millis parameter is mentioned neither in the examples related to watchers in the Elasticsearch documentation nor anywhere in the docs.

Examples in the doc using throttle_period
https://www.elastic.co/guide/en/elastic-stack-overview/7.2/actions-slack.html
https://www.elastic.co/guide/en/elastic-stack-overview/7.1/actions.html#actions-ack-throttle

Example in the discussion forum using throttle_period_in_millis
https://discuss.elastic.co/t/how-to-set-a-time-range-in-the-watcher/93679/4

It would be good to include examples in the documentation using throttle_period_in_millis too.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions