• Plugin version: v3.0.7 (Other versions)
• Released on: 2020-09-04
• Changelog

For questions about the plugin, open a topic in theDiscuss forums. For bugs or feature requests, open an issue inGithub. For the list of Elastic supported plugins, please consult theElastic Support Matrix.

Sleep a given amount of time. This will cause logstash to stall for the given amount of time. This is useful for rate limiting, etc.

This plugin supports the following configuration options plus theCommon options described later.

Also seeCommon options for a list of options supported by all filter plugins.

• Value type isstring
• Default value is1

Sleep on every N’th. This option is ignored in replay mode.

Example:

filter {  sleep {    time => "1"    every => 10  }}

1. Sleep 1 second
2. on every 10th event

• Value type isboolean
• Default value isfalse

Enable replay mode.

Replay mode tries to sleep based on timestamps in each event.

The amount of time to sleep is computed by subtracting the previous event’s timestamp from the current event’s timestamp. This helps you replay events in the same timeline as original.

If you specify atime setting as well, this filter will use thetime value as a speed modifier. For example, atime value of 2 will replay at double speed, while a value of 0.25 will replay at 1/4th speed.

For example:

filter {  sleep {    time => 2    replay => true  }}

The above will sleep in such a way that it will perform replay 2-times faster than the original time speed.

• Value type isstring
• There is no default value for this setting.

The length of time to sleep, in seconds, for every event.

This can be a number (eg, 0.5), or a string (eg,%{foo}) The second form (string with a field value) is useful if you have an attribute of your event that you want to use to indicate the amount of time to sleep.

Example:

filter {  sleep {    # Sleep 1 second for every event.    time => "1"  }}

These configuration options are supported by all filter plugins:

• Value type ishash
• Default value is{}

If this filter is successful, add any arbitrary fields to this event. Field names can be dynamic and include parts of the event using the%{field}.

Example:

filter {  sleep {    add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }  }}

# You can also add multiple fields at once:filter {  sleep {    add_field => {      "foo_%{somefield}" => "Hello world, from %{host}"      "new_field" => "new_static_value"    }  }}

If the event has field"somefield" == "hello" this filter, on success, would add fieldfoo_hello if it is present, with the value above and the%{host} piece replaced with that value from the event. The second example would also add a hardcoded field.

• Value type isarray
• Default value is[]

If this filter is successful, add arbitrary tags to the event. Tags can be dynamic and include parts of the event using the%{field} syntax.

Example:

filter {  sleep {    add_tag => [ "foo_%{somefield}" ]  }}

# You can also add multiple tags at once:filter {  sleep {    add_tag => [ "foo_%{somefield}", "taggedy_tag"]  }}

If the event has field"somefield" == "hello" this filter, on success, would add a tagfoo_hello (and the second example would of course add ataggedy_tag tag).

• Value type isboolean
• Default value istrue

Disable or enable metric logging for this specific plugin instance by default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

• Value type isstring
• There is no default value for this setting.

Add a uniqueID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 sleep filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

filter {  sleep {    id => "ABC"  }}

• Value type isboolean
• Default value isfalse

Call the filter flush method at regular interval. Optional.

• Value type isarray
• Default value is[]

If this filter is successful, remove arbitrary fields from this event. Fields names can be dynamic and include parts of the event using the %{field} Example:

filter {  sleep {    remove_field => [ "foo_%{somefield}" ]  }}

# You can also remove multiple fields at once:filter {  sleep {    remove_field => [ "foo_%{somefield}", "my_extraneous_field" ]  }}

If the event has field"somefield" == "hello" this filter, on success, would remove the field with namefoo_hello if it is present. The second example would remove an additional, non-dynamic field.

• Value type isarray
• Default value is[]

If this filter is successful, remove arbitrary tags from the event. Tags can be dynamic and include parts of the event using the%{field} syntax.

Example:

filter {  sleep {    remove_tag => [ "foo_%{somefield}" ]  }}

# You can also remove multiple tags at once:filter {  sleep {    remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"]  }}

If the event has field"somefield" == "hello" this filter, on success, would remove the tagfoo_hello if it is present. The second example would remove a sad, unwanted tag as well.