年龄过滤器插件

编辑
  • 插件版本: v1.0.3
  • 发布日期: 2021-10-29
  • 更新日志

有关其他版本,请参阅版本化插件文档

安装

编辑

对于默认未捆绑的插件,可以通过运行 bin/logstash-plugin install logstash-filter-age 轻松安装。 有关更多详细信息,请参阅使用插件

获取帮助

编辑

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

描述

编辑

一个用于计算事件年龄的简单过滤器。

此过滤器通过从当前时间戳中减去事件时间戳来计算事件的年龄。 您可以将此插件与drop过滤器插件一起使用,以删除早于某个阈值的 Logstash 事件。

filter {
  age {}
  if [@metadata][age] > 86400 {
    drop {}
  }
}

年龄过滤器配置选项

编辑

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

设置 输入类型 必需

target

字符串

另请参阅通用选项,了解所有过滤器插件支持的选项列表。

 

target

编辑
  • 值类型为字符串
  • 默认值为"[@metadata][age]"

定义事件年龄的目标字段,以秒为单位。

通用选项

编辑

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

add_field

编辑
  • 值类型为哈希
  • 默认值为{}

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

示例

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

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

add_tag

编辑
  • 值类型为数组
  • 默认值为[]

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

示例

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

如果事件的字段为 "somefield" == "hello",则此过滤器在成功时,将添加标签 foo_hello (并且第二个示例当然会添加 taggedy_tag 标签)。

enable_metric

编辑

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

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

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

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

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

periodic_flush

编辑

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

remove_field

编辑
  • 值类型为数组
  • 默认值为[]

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

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

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

remove_tag

编辑
  • 值类型为数组
  • 默认值为[]

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

示例

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

如果事件的字段为 "somefield" == "hello",则此过滤器在成功时,如果存在,将删除标签 foo_hello。 第二个示例也将删除一个悲伤的、不需要的标签。