› ›

Sleep 过滤器插件

编辑

Sleep 过滤器插件

编辑

插件版本：v3.0.7
发布日期：2020-09-04
更新日志

其他版本，请查看版本化插件文档.

获取帮助

编辑

如有任何关于插件的问题，请在 Discuss 论坛中发帖提问。如发现错误或有功能需求，请在 Github 上提交 issue。如需查看 Elastic 支持的插件列表，请查阅 Elastic 支持矩阵.

描述

编辑

暂停指定时间。这将导致 Logstash 暂停指定的时间。这对于速率限制等非常有用。

Sleep 过滤器配置选项

编辑

此插件支持以下配置选项以及稍后描述的常用选项。

设置	输入类型	必填
`every`	字符串	否
`replay`	布尔值	否
`time`	字符串	否

另请参见常用选项，了解所有过滤器插件支持的选项列表。

`every`

编辑

值类型为字符串
默认值为 1

每 N 个事件暂停一次。此选项在回放模式下被忽略。

示例

    filter {
      sleep {
        time => "1"   # Sleep 1 second
        every => 10   # on every 10th event
      }
    }

`replay`

编辑

值类型为布尔值
默认值为 false

启用回放模式。

回放模式尝试根据每个事件中的时间戳进行暂停。

暂停时间通过从当前事件的时间戳中减去前一个事件的时间戳来计算。这有助于您在与原始时间线相同的时间线上回放事件。

如果您也指定了 time 设置，则此过滤器将使用 time 值作为速度修改器。例如，time 值为 2 将以两倍速度回放，而值为 0.25 将以 1/4 的速度回放。

例如

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

以上将以比原始时间速度快两倍的速度执行回放。

`time`

编辑

值类型为字符串
此设置没有默认值。

每个事件的暂停时间长度（秒）。

可以是数字（例如，0.5），也可以是字符串（例如，%{foo}）。第二种形式（带有字段值的字符串）在您具有要用于指示暂停时间的事件属性时非常有用。

示例

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

常用选项

编辑

所有过滤器插件都支持这些配置选项

设置	输入类型	必填
`add_field`	哈希表	否
`add_tag`	数组	否
`enable_metric`	布尔值	否
`id`	字符串	否
`periodic_flush`	布尔值	否
`remove_field`	数组	否
`remove_tag`	数组	否

`add_field`

编辑

值类型为哈希表
默认值为 {}

如果此过滤器成功，则向此事件添加任意字段。字段名称可以是动态的，并使用 %{field} 包含事件的一部分。

示例

    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"
        }
      }
    }

如果事件具有字段 "somefield" == "hello"，则此过滤器成功后，如果存在，将添加字段 foo_hello，其值为上述值，并且 %{host} 部分将替换为事件中的该值。第二个示例还将添加一个硬编码字段。

`add_tag`

编辑

值类型为数组
默认值为 []

如果此过滤器成功，则向事件添加任意标签。标签可以是动态的，并使用 %{field} 语法包含事件的一部分。

示例

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

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

如果事件具有字段 "somefield" == "hello"，则此过滤器成功后，将添加标签 foo_hello（第二个示例当然会添加 taggedy_tag 标签）。

`enable_metric`

编辑

值类型为布尔值
默认值为 true

禁用或启用此特定插件实例的指标日志记录。默认情况下，我们会记录所有可以记录的指标，但是您可以禁用特定插件的指标收集。

`id`

编辑

值类型为字符串
此设置没有默认值。

向插件配置添加唯一的 ID。如果未指定 ID，Logstash 将生成一个。强烈建议您在配置中设置此 ID。当您有两个或多个相同类型的插件时，这尤其有用，例如，如果您有两个 sleep 过滤器。在这种情况下，添加命名 ID 将有助于使用监控 API 监控 Logstash。

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

id 字段中的变量替换仅支持环境变量，不支持使用密钥存储中的值。

`periodic_flush`

编辑

值类型为布尔值
默认值为 false

定期调用过滤器刷新方法。可选。

`remove_field`

编辑

值类型为数组
默认值为 []

如果此过滤器成功，则从此事件中删除任意字段。字段名称可以是动态的，并使用 %{field} 示例包含事件的一部分

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

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

如果事件具有字段 "somefield" == "hello"，则此过滤器成功后，如果存在，将删除名称为 foo_hello 的字段。第二个示例将删除另一个非动态字段。

`remove_tag`

编辑

值类型为数组
默认值为 []

如果此过滤器成功，则从事件中删除任意标签。标签可以是动态的，并使用 %{field} 语法包含事件的一部分。

示例

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

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

如果事件具有字段 "somefield" == "hello"，则此过滤器成功后，如果存在，将删除标签 foo_hello。第二个示例也将删除一个令人不快的、不需要的标签。

« Ruby 过滤器插件 Split 过滤器插件 »