« Elasticsearch 过滤器插件 Extractnumbers 过滤器插件 »

› ›

环境过滤器插件

编辑

环境过滤器插件

编辑

插件版本：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_metadata_from_env`	哈希表	否

另请参见常用选项，了解所有过滤器插件支持的选项列表。

`add_metadata_from_env`

编辑

值类型为哈希表
默认值为 {}

指定字段名称和环境变量名称的哈希表，以及您要导入到 Logstash 中的值。例如

add_metadata_from_env => { "field_name" => "ENV_VAR_NAME" }

或

add_metadata_from_env => {
  "field1" => "ENV1"
  "field2" => "ENV2"
  # "field_n" => "ENV_n"
}

常用选项

编辑

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

设置	输入类型	必需
`add_field`	哈希表	否
`add_tag`	数组	否
`enable_metric`	布尔值	否
`id`	字符串	否
`periodic_flush`	布尔值	否
`remove_field`	数组	否
`remove_tag`	数组	否

`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 标签）。

`enable_metric`

编辑

值类型为布尔值
默认值为 true

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

`id`

编辑

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

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

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

id 字段中的变量替换仅支持环境变量，不支持使用密钥存储中的值。

`periodic_flush`

编辑

值类型为布尔值
默认值为 false

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

`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。第二个示例还将删除一个不需要的标签。

« Elasticsearch 过滤器插件 Extractnumbers 过滤器插件 »