Useragent 过滤器插件

编辑
  • 插件版本:v3.3.5
  • 发布日期:2023-09-19
  • 更改日志

对于其他版本,请参阅 版本化插件文档

获取帮助

编辑

如有关于插件的问题,请在 Discuss 论坛中发起主题讨论。对于错误或功能请求,请在 Github 中提交问题。有关 Elastic 支持的插件列表,请参阅 Elastic 支持矩阵

描述

编辑

基于 BrowserScope 数据将用户代理字符串解析为结构化数据

UserAgent 过滤器,添加有关用户代理的信息,例如名称、版本、操作系统和设备。

该插件附带了从 ua-parser 提供的 regexes.yaml 数据库,并采用 Apache 2.0 许可证。有关 ua-parser 的更多详细信息,请参阅 https://github.com/ua-parser/uap-core/

与 Elastic Common Schema (ECS) 的兼容性

编辑

此插件可用于将用户代理 (UA) 解析为 符合 Elastic Common Schema 的字段。以下是 ECS 兼容模式 如何影响输出。

ECS 已禁用 ECS v1、v8 描述 注释

[name]

[user_agent][name]

检测到的 UA 名称

[version]*

[user_agent][version]

检测到的 UA 版本

仅在 ECS 模式下可用

[major]

[@metadata][filter][user_agent][version][major]

UA 主版本

仅在 ECS 模式下作为元数据

[minor]

[@metadata][filter][user_agent][version][minor]

UA 次版本

仅在 ECS 模式下作为元数据

[patch]

[@metadata][filter][user_agent][version][patch]

UA 修订版本

仅在 ECS 模式下作为元数据

[os_name]

[user_agent][os][name]

检测到的操作系统名称

[os_version]*

[user_agent][os][version]

检测到的 OS 版本

仅在 ECS 模式下可用

[os_major]

[@metadata][filter][user_agent][os][version][major]

OS 主版本

仅在 ECS 模式下作为元数据

[os_minor]

[@metadata][filter][user_agent][os][version][minor]

OS 次版本

仅在 ECS 模式下作为元数据

[os_patch]

[@metadata][filter][user_agent][os][version][patch]

OS 修订版本

仅在 ECS 模式下作为元数据

[os_full]

[user_agent][os][full]

完整操作系统名称

[device]

[user_agent][device][name]

设备名称

[version][os_version] 字段是在 Logstash 7.14 中添加的,在早期版本中默认不可用。

示例

    filter {
      useragent {
        source => 'message'
      }
    }

假设事件的 message 字段设置为:Mozilla/5.0 (Macintosh; Intel Mac OS X 10.11; rv:45.0) Gecko/20100101 Firefox/45.0,会生成以下字段

    {
        "name"=>"Firefox",
        "version"=>"45.0", # since plugin version 3.3.0
        "major"=>"45",
        "minor"=>"0",
        "os_name"=>"Mac OS X",
        "os_version"=>"10.11", # since plugin version 3.3.0
        "os_full"=>"Mac OS X 10.11",
        "os_major"=>"10",
        "os_minor"=>"11",
        "device"=>"Mac"
    }

并且在启用 ECS 的情况下

    {
        "user_agent"=>{
            "name"=>"Firefox",
            "version"=>"45.0",
            "os"=>{
                "name"=>"Mac OS X",
                "version"=>"10.11",
                "full"=>"Mac OS X 10.11"
            },
            "device"=>{"name"=>"Mac"},
        }
    }

Useragent 过滤器配置选项

编辑

此插件支持以下配置选项以及稍后描述的 通用选项

另请参阅 通用选项,了解所有过滤器插件支持的选项列表。

 

ecs_compatibility

编辑
  • 值类型为 字符串
  • 支持的值为

    • disabled:不使用与 ECS 兼容的字段名称(字段可能设置在事件的根目录中)
    • v1v8:使用与 Elastic Common Schema 兼容的字段(例如,[user_agent][version]
  • 默认值取决于正在运行的 Logstash 版本

    • 当 Logstash 提供 pipeline.ecs_compatibility 设置时,其值将用作默认值
    • 否则,默认值为 disabled

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

lru_cache_size

编辑
  • 值类型为 数字
  • 默认值为 100000

UA 解析令人惊讶地代价高昂。此过滤器使用 LRU 缓存来利用用户代理通常在日志文件中彼此相邻并且很少具有随机分布这一事实。设置的值越高,项目更有可能在缓存中,并且此过滤器运行的速度越快。但是,如果将此值设置得太高,则可能会使用比所需更多的内存。

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

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

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

prefix

编辑

要添加到所有提取键之前的一个字符串

regexes

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

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

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

source

编辑
  • 这是一个必填设置。
  • 值类型为 字符串
  • 此设置没有默认值。

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

target

编辑
  • 值类型为 字符串
  • 默认值取决于 ecs_compatibility 是否启用

    • ECS 兼容性已禁用:此设置没有默认值
    • ECS 兼容性已启用:"user_agent"

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

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

通用选项

编辑

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

add_field

编辑
  • 值类型为 哈希
  • 默认值为 {}

如果此过滤器成功,则将任何任意字段添加到此事件。字段名称可以是动态的,并包含使用 %{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} 部分替换为事件中的该值。第二个示例还将添加一个硬编码字段。

add_tag

编辑
  • 值类型为 数组
  • 默认值为 []

如果此过滤器成功,则将任意标签添加到事件。标签可以是动态的,并包含使用 %{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 标签)。

enable_metric

编辑

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

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

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

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

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

periodic_flush

编辑

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

remove_field

编辑
  • 值类型为 数组
  • 默认值为 []

如果此过滤器成功,则从此事件中删除任意字段。字段名称可以是动态的,并包含使用 %{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 的字段(如果存在)。第二个示例将删除另一个非动态字段。

remove_tag

编辑
  • 值类型为 数组
  • 默认值为 []

如果此过滤器成功,则从事件中删除任意标签。标签可以是动态的,并包含使用 %{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(如果存在)。第二个示例也将移除一个令人不快的、不需要的标签。