Useragent 过滤器插件

控制此插件与Elastic Common Schema (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。强烈建议您在配置中设置此 ID。当您有两个或多个相同类型的插件时，这尤其有用，例如，如果您有 2 个 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。第二个示例还将删除一个令人不快的、不需要的标签。