用户代理过滤器插件

控制此插件与 Elastic 通用模式 (ECS) 的兼容性。此设置的值会影响 target 的默认值。

UA 解析非常昂贵。此过滤器使用 LRU 缓存来利用用户代理通常在日志文件中彼此相邻且很少具有随机分布这一事实。设置的值越高，项目在缓存中的可能性就越大，此过滤器的运行速度就越快。但是，如果设置的值过高，则可能会使用比预期更多的内存。

尝试使用此选项的不同值，以找到最适合您的数据集的性能。

此值必须设置为 > 0 的值。实际上没有理由不希望这种行为，开销很小，速度提升很大。

重要的是要注意，此配置值是全局的。也就是说，用户代理过滤器的所有实例共享同一个缓存。最后一个声明的缓存大小将获胜。这样做的原因是，在管道中不同位置拥有多个缓存对不同实例没有好处，这只会增加缓存未命中的次数并浪费内存。

一个字符串，用于在所有提取的键之前添加。

如果未指定，则默认为与 logstash 一起提供的 regexes.yaml。否则，使用提供的 regexes.yaml 文件。

您可以在此处找到此文件的最新版本：https://github.com/ua-parser/uap-core/blob/master/regexes.yaml

包含用户代理字符串的字段。如果此字段是数组，则仅使用第一个值。

要将用户代理数据分配到的字段的名称。

如果未指定，用户代理数据将存储在事件的根目录中。

如果此过滤器成功，则将任何任意字段添加到此事件。字段名称可以是动态的，并使用 %{field} 包含事件的一部分。

示例

    filter {
      useragent {
        add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
      }
    }

    # You can also add multiple fields at once:
    filter {
      useragent {
        add_field => {
          "foo_%{somefield}" => "Hello world, from %{host}"
          "new_field" => "new_static_value"
        }
      }
    }

如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将添加字段 foo_hello（如果存在），其值为上述值，并且 %{host} 部分将替换为事件中的该值。第二个示例还将添加一个硬编码字段。

如果此过滤器成功，则将任意标签添加到事件。标签可以是动态的，并使用 %{field} 语法包含事件的一部分。

示例

    filter {
      useragent {
        add_tag => [ "foo_%{somefield}" ]
      }
    }

    # You can also add multiple tags at once:
    filter {
      useragent {
        add_tag => [ "foo_%{somefield}", "taggedy_tag"]
      }
    }

如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将添加标签 foo_hello（当然，第二个示例将添加一个 taggedy_tag 标签）。

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

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

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

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

如果此过滤器成功，则从该事件中删除任意字段。字段名称可以是动态的，并使用 %{field} 包含事件的一部分 例如

    filter {
      useragent {
        remove_field => [ "foo_%{somefield}" ]
      }
    }

    # You can also remove multiple fields at once:
    filter {
      useragent {
        remove_field => [ "foo_%{somefield}", "my_extraneous_field" ]
      }
    }

如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将删除名为 foo_hello 的字段（如果存在）。第二个示例将删除一个额外的非动态字段。

如果此过滤器成功，则从事件中删除任意标签。标签可以是动态的，并使用 %{field} 语法包含事件的一部分。

示例

    filter {
      useragent {
        remove_tag => [ "foo_%{somefield}" ]
      }
    }

    # You can also remove multiple tags at once:
    filter {
      useragent {
        remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"]
      }
    }

如果事件具有字段 "somefield" == "hello"，则此过滤器在成功时将删除标签 foo_hello（如果存在）。第二个示例还将删除一个令人沮丧的、不需要的标签。