Sleep 过滤器插件

编辑

对于其他版本,请参阅版本化插件文档

获取帮助

编辑

有关插件的问题,请在Discuss论坛中开启一个主题。对于错误或功能请求,请在Github中开启一个 issue。有关 Elastic 支持的插件列表,请查阅Elastic 支持矩阵

描述

编辑

休眠给定的时间量。这将导致 logstash 暂停给定的时间量。这对于速率限制等非常有用。

Sleep 过滤器配置选项

编辑

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

设置 输入类型 必需

every

字符串

replay

布尔值

time

字符串

另请参阅常用选项,其中列出了所有过滤器插件支持的选项。

 

every

编辑

每 N 个事件休眠一次。在重放模式下,此选项将被忽略。

示例

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

replay

编辑

启用重放模式。

重放模式尝试根据每个事件中的时间戳休眠。

休眠的时间量是通过从当前事件的时间戳中减去上一个事件的时间戳来计算的。这有助于您以与原始时间线相同的方式重放事件。

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

例如

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

以上设置将以比原始时间速度快 2 倍的方式进行休眠,从而执行重放。

time

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

每个事件休眠的时间长度,以秒为单位。

这可以是一个数字(例如,0.5),也可以是一个字符串(例如,%{foo})。第二种形式(带有字段值的字符串)在您希望使用事件的某个属性来指示休眠时间量时非常有用。

示例

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

常用选项

编辑

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

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

编辑

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

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

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

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

id字段中的变量替换仅支持环境变量,不支持使用来自秘密存储的值。

periodic_flush

编辑

以固定的时间间隔调用过滤器刷新方法。可选。

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(如果存在)。第二个示例也会删除一个令人沮丧的、不需要的标签。