日期过滤器插件
编辑日期过滤器插件
编辑- 插件版本: 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
编辑- 值类型为数组
- 默认值为
[]
如果此过滤器成功,则向事件添加任意标签。标签可以是动态的,并包含使用%{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
编辑- 值类型为字符串
- 此设置没有默认值。
向插件配置添加唯一的ID
。如果未指定ID,Logstash将生成一个。强烈建议在您的配置中设置此ID。当您有两个或多个相同类型的插件时,这尤其有用,例如,如果您有两个日期过滤器。在这种情况下,添加命名ID将有助于使用监控 API 监控 Logstash。
filter { date { id => "ABC" } }
id
字段中的变量替换仅支持环境变量,不支持使用密钥存储中的值。
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
。第二个示例也将删除一个令人悲伤的、不需要的标签。