日期过滤器插件

编辑
  • 插件版本:v3.1.15
  • 发布日期:2022-06-29
  • 更新日志

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

获取帮助

编辑

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

描述

编辑

日期过滤器用于解析字段中的日期,然后将该日期或时间戳用作事件的 Logstash 时间戳。

例如,Syslog 事件通常具有如下时间戳

    "Apr 17 09:32:01"

您将使用日期格式 MMM dd HH:mm:ss 来解析此时间戳。

日期过滤器对于排序事件和回填旧数据尤其重要。如果事件中的日期不正确,那么稍后搜索它们时可能会按错误的顺序排序。

在没有此过滤器的情况下,如果事件中尚未设置时间戳,则 Logstash 将基于第一次看到事件的时间(在输入时)选择时间戳。例如,对于文件输入,时间戳设置为每次读取的时间。

日期过滤器配置选项

编辑

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

设置 输入类型 必需

locale

字符串

match

数组

tag_on_failure

数组

target

字符串

timezone

字符串

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

 

locale

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

指定用于日期解析的区域设置,使用 IETF-BCP47 或 POSIX 语言标签。简单的例子是 BCP47 的 en, en-US 或 POSIX 的 en_US

区域设置主要需要设置为解析月份名称(带有 MMM 的模式)和工作日名称(带有 EEE 的模式)。

如果未指定,将使用平台默认值,但对于非英语平台默认值,也将使用英语解析器作为回退机制。

match

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

一个数组,第一个是字段名称,后面是格式模式,[ 字段, 格式... ]

如果您的时间字段有多种可能的格式,您可以这样做

    match => [ "logdate", "MMM dd yyyy HH:mm:ss",
              "MMM  d yyyy HH:mm:ss", "ISO8601" ]

上述配置将匹配 Syslog (rfc3164) 或 iso8601 时间戳。

有一些特殊的例外情况。以下格式文字可以帮助您节省时间并确保日期解析的正确性。

  • ISO8601 - 应该解析任何有效的 ISO8601 时间戳,例如 2011-04-19T03:44:01.103Z
  • UNIX - 将解析表示自 epoch 以来的 Unix 时间(以秒为单位)的浮点数或整数值,例如 1326149001.132 以及 1326149001
  • UNIX_MS - 将解析表示自 epoch 以来的 Unix 时间(以毫秒为单位)的 整数值,例如 1366125117000
  • TAI64N - 将解析 tai64n 时间值

例如,如果您的字段 logdate 的值类似于 Aug 13 2010 00:03:44,您将使用此配置

    filter {
      date {
        match => [ "logdate", "MMM dd yyyy HH:mm:ss" ]
      }
    }

如果您的字段嵌套在结构中,您可以使用嵌套语法 [foo][bar] 来匹配其值。有关更多信息,请参阅字段引用

关于语法的更多细节

用于解析日期和时间文本的语法使用字母来指示时间值的类型(月、分钟等),并重复字母来指示该值的形式(2 位数月份、完整月份名称等)。

以下是您可以用来解析日期和时间的语法

y

yyyy
完整年份数字。示例:2015
yy
两位数年份。示例:15 表示 2015 年。

M

一年中的月份

M
最小数字月份。示例:1 表示一月,12 表示十二月。
MM
两位数月份。如果需要,则用零填充。示例:01 表示一月,12 表示十二月
MMM
缩写月份文本。示例:Jan 表示一月。注意:使用的语言取决于您的区域设置。请参阅 locale 设置,了解如何更改语言。
MMMM
完整的月份文本,示例:January。注意:使用的语言取决于您的区域设置。

d

一个月中的某天

d
最小数字日期。示例:1 表示该月的 1 号。
dd
两位数日期,如果需要,则用零填充。示例:01 表示该月的 1 号。

H

一天中的小时(24 小时制)

H
最小数字小时。示例:0 表示午夜。
HH
两位数小时,如果需要,则用零填充。示例:00 表示午夜。

m

一小时的分钟数(每小时 60 分钟)

m
最小数字分钟。示例:0
mm
两位数分钟,如果需要,则用零填充。示例:00

s

一分钟的秒数(每分钟 60 秒)

s
最小数字秒数。示例:0
ss
两位数秒数,如果需要,则用零填充。示例:00

S

秒的小数部分 最大精度为毫秒 (SSS)。超出此范围,则追加零。

S
十分之一秒。示例:对于子秒值 012,值为 0
SS
百分之一秒。示例:对于子秒值 01,值为 01
SSS
千分之一秒。示例:对于子秒值 012,值为 012

Z

时区偏移量或标识

Z
时区偏移量,结构为 HHmm(与 Zulu/UTC 的小时和分钟偏移量)。示例:-0700
ZZ
时区偏移量,结构为 HH:mm(小时和分钟偏移量之间有冒号)。示例:-07:00
ZZZ
时区标识。示例:America/Los_Angeles。注意:有效 ID 列在 Joda.org 可用时区页面上。

z

时区名称。时区名称(z)无法解析。

w

一年中的星期

w
最小数字星期。示例:1
ww
两位数星期,如果需要,则用零填充。示例:01

D

一年中的某天

e

星期几(数字)

E

星期几(文本)

E, EE, EEE
星期几的缩写。示例:MonTueWedThuFriSatSun。注意:实际语言取决于您的区域设置。
EEEE
星期几的完整文本。示例:MondayTuesday、…​ 注意:实际语言取决于您的区域设置。

对于非格式化语法,您需要在值周围加上单引号字符。例如,如果您要解析 ISO8601 时间 “2015-01-01T01:12:23”,那么 “T” 不是有效的时间格式,您想说 “字面上,一个 T”,您的格式将是:”yyyy-MM-dd’T’HH:mm:ss”

关于其他不太常见的日期单位(如时代 (G)、世纪 (C)、上午/下午 (a) 和更多单位),您可以在 joda-time 文档上了解。

tag_on_failure

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

当没有成功匹配时,将值附加到 tags 字段

target

编辑
  • 值类型为 字符串
  • 默认值为 "@timestamp"

将匹配的时间戳存储到给定的目标字段中。如果未提供,则默认更新事件的 @timestamp 字段。

timezone

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

指定用于日期解析的时区规范 ID。有效 ID 列在 Joda.org 可用时区页面上。如果无法从值中提取时区,并且不是平台默认值,则此选项很有用。如果未指定,则将使用平台默认值。规范 ID 很好,因为它会为您处理夏令时。例如,America/Los_AngelesEurope/Paris 是有效的 ID。此字段可以是动态的,并使用 %{field} 语法包含事件的部分内容

通用选项

编辑

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

add_field

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

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

示例

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

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

add_tag

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

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

示例

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

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

enable_metric

编辑

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

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

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

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

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

periodic_flush

编辑

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

remove_field

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

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

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

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

remove_tag

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

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

示例

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

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