日期过滤器插件
编辑日期过滤器插件编辑
- 插件版本:v3.1.15
- 发布日期:2022-06-29
- 变更日志
有关其他版本,请参阅 版本化插件文档.
获取帮助编辑
如果您对插件有任何疑问,请在 Discuss 论坛中发布主题。对于错误或功能请求,请在 Github 中打开问题。有关 Elastic 支持的插件列表,请参阅 Elastic 支持矩阵.
描述编辑
日期过滤器用于从字段中解析日期,然后使用该日期或时间戳作为事件的 logstash 时间戳。
例如,syslog 事件通常具有如下时间戳
"Apr 17 09:32:01"
您将使用日期格式 MMM dd HH:mm:ss
来解析此日期。
日期过滤器对于对事件进行排序以及回填旧数据特别重要。如果您没有正确获取事件中的日期,那么以后搜索它们可能会导致排序错误。
在没有此过滤器的情况下,logstash 将根据第一次看到事件的时间(在输入时)选择时间戳,如果事件中尚未设置时间戳。例如,使用文件输入,时间戳将设置为每次读取的时间。
日期过滤器配置选项编辑
此插件支持以下配置选项以及后面描述的 通用选项。
另请参阅 通用选项,了解所有过滤器插件支持的选项列表。
locale
编辑
- 值类型为 字符串
- 此设置没有默认值。
使用 IETF-BCP47 或 POSIX 语言标签指定用于日期解析的区域设置。简单的示例是 en
、en-US
(用于 BCP47)或 en_US
(用于 POSIX)。
区域设置主要用于解析月份名称(带有 MMM
的模式)和星期几名称(带有 EEE
的模式)。
如果未指定,将使用平台默认值,但对于非英语平台默认值,还将使用英语解析器作为后备机制。
match
编辑
- 值类型为 数组
- 默认值为
[]
一个包含字段名称和格式模式的数组,[ field, formats... ]
如果您的时间字段有多种可能的格式,您可以执行以下操作
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
- 将解析 浮点数或整数 值,表示自纪元以来的 Unix 时间(以秒为单位),例如 1326149001.132 以及 1326149001 -
UNIX_MS
- 将解析 整数 值,表示自纪元以来的 Unix 时间(以毫秒为单位),例如 1366125117000 -
TAI64N
- 将解析 tai64n 时间值
例如,如果您的字段 logdate
的值为 Aug 13 2010 00:03:44
,您将使用以下配置
filter { date { match => [ "logdate", "MMM dd yyyy HH:mm:ss" ] } }
如果您的字段嵌套在您的结构中,您可以使用嵌套语法 [foo][bar]
来匹配其值。有关更多信息,请参阅 字段引用
有关语法的更多详细信息
用于解析日期和时间文本的语法使用字母来指示时间值类型(月份、分钟等),并重复字母来指示该值的格式(两位数月份、完整月份名称等)。
以下是可以用来解析日期和时间的内容
y |
年份
|
M |
一年中的月份
|
d |
一个月中的日期
|
H |
一天中的小时数(24 小时制)
|
m |
一小时中的分钟数(每小时 60 分钟)
|
s |
一分钟中的秒数(每分钟 60 秒)
|
S |
秒的几分之一 最大精度为毫秒 (
|
Z |
时区偏移量或标识
|
z |
时区名称。 无法解析时区名称 (z)。 |
w |
一年中的星期数
|
D |
一年中的日期 |
e |
一周中的日期(数字) |
E |
一周中的日期(文本)
|
对于非格式化语法,您需要将单引号字符放在值周围。例如,如果您正在解析 ISO8601 时间,"2015-01-01T01:12:23" 中的这个小 "T" 不是有效的日期格式,并且您想说 "字面上的 T",您的格式将是: "yyyy-MM-dd’T’HH:mm:ss"
有关其他不太常见的日期单位,例如纪元 (G)、世纪 (C)、上午/下午 (a) 等等,请参阅 joda-time 文档。
timezone
编辑
- 值类型为 字符串
- 此设置没有默认值。
指定用于日期解析的时区规范 ID。有效 ID 列在 Joda.org 可用时区页面 上。如果无法从值中提取时区,并且不是平台默认值,这将很有用。如果未指定,将使用平台默认值。规范 ID 很好,因为它会为您处理夏令时。例如,America/Los_Angeles
或 Europe/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
edit
- 值类型为 数组
- 默认值为
[]
如果此过滤器成功,则将任意标签添加到事件中。标签可以是动态的,并使用 %{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
标签)。
id
edit
- 值类型为 字符串
- 此设置没有默认值。
向插件配置添加一个唯一的 ID
。如果没有指定 ID,Logstash 将生成一个。强烈建议在您的配置中设置此 ID。当您有两个或多个相同类型的插件时,这尤其有用,例如,如果您有两个日期过滤器。在这种情况下,添加一个命名 ID 将有助于在使用监控 API 时监控 Logstash。
filter { date { id => "ABC" } }
id
字段中的变量替换仅支持环境变量,不支持使用来自密钥存储的值。
remove_field
edit
- 值类型为 数组
- 默认值为
[]
如果此过滤器成功,则从此事件中删除任意字段。字段名称可以是动态的,并使用 %{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
edit
- 值类型为 数组
- 默认值为
[]
如果此过滤器成功,则从事件中删除任意标签。标签可以是动态的,并使用 %{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
(如果存在)。第二个示例还将删除一个令人不快的标签。