Syslog_pri 过滤器插件
编辑Syslog_pri 过滤器插件编辑
- 插件版本: v3.2.1
- 发布日期: 2024-01-17
- 变更日志
有关其他版本，请参阅 版本化插件文档.
获取帮助编辑
如果您对插件有任何疑问，请在 Discuss 论坛中发布主题。对于错误或功能请求，请在 Github 中创建问题。有关 Elastic 支持的插件列表，请参阅 Elastic 支持矩阵.
描述编辑
用于 Logstash 的过滤器插件，用于解析 Syslog (RFC3164) 消息开头的 PRI 字段。如果未设置优先级，则默认为 13（根据 RFC）。
此过滤器基于与 Logstash 一起提供的原始 syslog.rb 代码。
Syslog_pri 过滤器配置选项编辑
此插件支持以下配置选项，以及稍后描述的 通用选项。
| 设置 | 输入类型 | 必需 |
|---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
另请参阅 通用选项，了解所有过滤器插件支持的选项列表。
ecs_compatibility编辑
- 值类型为 字符串
-
支持的值为
-
disabled: 不使用与 ECS 兼容的字段名称（例如，对于 syslog 严重性，使用syslog_severity_code） -
v1,v8: 使用与 Elastic Common Schema 兼容的字段（例如，[log][syslog][severity][code]）
-
-
默认值取决于运行的 Logstash 版本
- 当 Logstash 提供
pipeline.ecs_compatibility设置时，其值用作默认值 - 否则，默认值为
disabled。
- 当 Logstash 提供
控制此插件与 Elastic Common Schema (ECS) 的兼容性。此设置的值会影响 syslog_pri_field_name 的默认值。
facility_labels编辑
- 值类型为 数组
- 默认值为
["kernel", "user-level", "mail", "daemon", "security/authorization", "syslogd", "line printer", "network news", "uucp", "clock", "security/authorization", "ftp", "ntp", "log audit", "log alert", "clock", "local0", "local1", "local2", "local3", "local4", "local5", "local6", "local7"]
设施级别的标签。这来自 RFC3164。如果提供了无法识别的设施代码，并且 use_labels 为 true，则事件将标记为 _syslogpriparsefailure。
severity_labels编辑
- 值类型为 数组
- 默认值为
["emergency", "alert", "critical", "error", "warning", "notice", "informational", "debug"]
严重性级别的标签。这来自 RFC3164。
syslog_pri_field_name编辑
- 值类型为 字符串
-
默认值取决于是否启用了
ecs_compatibility- 禁用 ECS 兼容性:
"syslog_pri" - 启用 ECS 兼容性:
"[log][syslog][priority]"
- 禁用 ECS 兼容性:
传递提取的 Syslog 消息 PRI 部分的字段的名称
通用选项编辑
以下配置选项由所有过滤器插件支持
| 设置 | 输入类型 | 必需 |
|---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
add_field编辑
- 值类型为 哈希
- 默认值为
{}
如果此过滤器成功，则将任何任意字段添加到此事件。字段名称可以是动态的，并使用 %{field} 包含事件的一部分。
示例
filter {
syslog_pri {
add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
}
}
# You can also add multiple fields at once:
filter {
syslog_pri {
add_field => {
"foo_%{somefield}" => "Hello world, from %{host}"
"new_field" => "new_static_value"
}
}
}
如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将添加字段 foo_hello（如果存在），其值为上述值，并且 %{host} 部分将替换为事件中的该值。第二个示例还将添加一个硬编码字段。
add_tag编辑
- 值类型为 数组
- 默认值为
[]
如果此过滤器成功，则将任意标签添加到事件。标签可以是动态的，并使用 %{field} 语法包含事件的一部分。
示例
filter {
syslog_pri {
add_tag => [ "foo_%{somefield}" ]
}
}
# You can also add multiple tags at once:
filter {
syslog_pri {
add_tag => [ "foo_%{somefield}", "taggedy_tag"]
}
}
如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将添加标签 foo_hello（当然，第二个示例将添加一个 taggedy_tag 标签）。
id编辑
- 值类型为 字符串
- 此设置没有默认值。
在插件配置中添加一个唯一的 ID。如果未指定 ID，Logstash 将生成一个 ID。强烈建议您在配置中设置此 ID。当您有两个或多个相同类型的插件时，这尤其有用，例如，如果您有两个 syslog_pri 过滤器。在这种情况下，添加一个命名 ID 将有助于在使用监控 API 时监控 Logstash。
filter {
syslog_pri {
id => "ABC"
}
}
id 字段中的变量替换仅支持环境变量，不支持使用来自密钥存储的值。
remove_field编辑
- 值类型为 数组
- 默认值为
[]
如果此过滤器成功，则从此事件中删除任意字段。字段名称可以是动态的，并使用 %{field} 示例包含事件的一部分
filter {
syslog_pri {
remove_field => [ "foo_%{somefield}" ]
}
}
# You can also remove multiple fields at once:
filter {
syslog_pri {
remove_field => [ "foo_%{somefield}", "my_extraneous_field" ]
}
}
如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将删除名为 foo_hello 的字段（如果存在）。第二个示例将删除一个额外的非动态字段。
remove_tag编辑
- 值类型为 数组
- 默认值为
[]
如果此过滤器成功，则从事件中删除任意标签。标签可以是动态的，并使用 %{field} 语法包含事件的一部分。
示例
filter {
syslog_pri {
remove_tag => [ "foo_%{somefield}" ]
}
}
# You can also remove multiple tags at once:
filter {
syslog_pri {
remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"]
}
}
如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将删除标签 foo_hello（如果存在）。第二个示例还将删除一个令人沮丧的、不需要的标签。