环境过滤器插件
编辑环境过滤器插件编辑
- 插件版本：v3.0.3
- 发布日期：2017-11-07
- 变更日志
有关其他版本，请参阅 版本化插件文档。
安装编辑
对于默认情况下未捆绑的插件，可以通过运行 bin/logstash-plugin install logstash-filter-environment 轻松安装。有关更多详细信息，请参阅 使用插件。
获取帮助编辑
有关插件的问题，请在 Discuss 论坛中发布主题。对于错误或功能请求，请在 Github 中打开问题。有关 Elastic 支持的插件列表，请参阅 Elastic 支持矩阵。
描述编辑
此过滤器将环境变量存储为 @metadata 字段中的子字段。然后，您可以在管道中的其他部分使用这些值。
添加环境变量就像这样简单：filter { environment { add_metadata_from_env ⇒ { "field_name" ⇒ "ENV_VAR_NAME" } } }
现在可以通过 @metadata 字段访问存储的环境变量
["@metadata"]["field_name"]
这将引用字段 field_name，在上面的示例中，它引用了 ENV_VAR_NAME 环境变量。
此插件的先前版本将环境变量作为字段放在事件的根级别。当前版本使用 @metadata 字段，如所述。您必须将旧版本中的 add_field_from_env 更改为新版本中的 add_metadata_from_env。
通用选项编辑
以下配置选项由所有过滤器插件支持
| 设置 | 输入类型 | 必需 |
|---|---|---|
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
||
否 |
add_field编辑
- 值类型为 哈希
- 默认值为
{}
如果此过滤器成功，则将任何任意字段添加到此事件。字段名称可以是动态的，并使用 %{field} 包含事件的一部分。
示例
filter {
environment {
add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
}
}
# You can also add multiple fields at once:
filter {
environment {
add_field => {
"foo_%{somefield}" => "Hello world, from %{host}"
"new_field" => "new_static_value"
}
}
}
如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将添加字段 foo_hello（如果存在），其值为以上值，并且 %{host} 部分将替换为事件中的该值。第二个示例还将添加一个硬编码字段。
add_tag编辑
- 值类型为 数组
- 默认值为
[]
如果此过滤器成功，则将任意标签添加到事件。标签可以是动态的，并使用 %{field} 语法包含事件的一部分。
示例
filter {
environment {
add_tag => [ "foo_%{somefield}" ]
}
}
# You can also add multiple tags at once:
filter {
environment {
add_tag => [ "foo_%{somefield}", "taggedy_tag"]
}
}
如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将添加标签 foo_hello（当然，第二个示例将添加 taggedy_tag 标签）。
id编辑
- 值类型为 字符串
- 此设置没有默认值。
在插件配置中添加一个唯一的 ID。如果没有指定 ID，Logstash 将生成一个。强烈建议在您的配置中设置此 ID。当您有两个或多个相同类型的插件时，这尤其有用，例如，如果您有两个环境过滤器。在这种情况下，添加命名 ID 将有助于在使用监控 API 时监控 Logstash。
filter {
environment {
id => "ABC"
}
}
id 字段中的变量替换仅支持环境变量，不支持使用来自秘密存储的值。
remove_field编辑
- 值类型为 数组
- 默认值为
[]
如果此过滤器成功，则从此事件中删除任意字段。字段名称可以是动态的，并使用 %{field} 示例包含事件的一部分
filter {
environment {
remove_field => [ "foo_%{somefield}" ]
}
}
# You can also remove multiple fields at once:
filter {
environment {
remove_field => [ "foo_%{somefield}", "my_extraneous_field" ]
}
}
如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将删除名为 foo_hello 的字段（如果存在）。第二个示例将删除一个额外的非动态字段。
remove_tag编辑
- 值类型为 数组
- 默认值为
[]
如果此过滤器成功，则从事件中删除任意标签。标签可以是动态的，并使用 %{field} 语法包含事件的一部分。
示例
filter {
environment {
remove_tag => [ "foo_%{somefield}" ]
}
}
# You can also remove multiple tags at once:
filter {
environment {
remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"]
}
}
如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将删除标签 foo_hello（如果存在）。第二个示例还将删除一个令人悲伤的、不想要的标签。