logstash-filter-device_detector 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4654c9ab2e2eb6e23f7166c5ad18eeb9af885cc33a9556a2541bb82578e9ba6
-  data.tar.gz: 26199a2e87a7557932ecc837d13a6c063ca770cd4b2e6e0ea28be38701383ecd
+  metadata.gz: 8adf455a3814dc53d3fe7bbd018431feda8b9d3a11de34cbc0ace45c3c5e15de
+  data.tar.gz: db940ad23ff6e4af90abb03e48bb1ebc5c70885a70a93b75ff7085f65866f2f4
 SHA512:
-  metadata.gz: f2301841fd07ee8c4b49d229d00ce49fdd66e505d6f2a0d9ed1125ae1410d50b885478da5e5a528b08fed655a1bdee0d8eb9dad984f7a73a202d4c292f8002c4
-  data.tar.gz: 53c9c88a4adfee4cd0cb24fa8a3a82b37977074bfb84dd186ba74aa40f0b7dc3e9d6715bc8ea555ef5d8b7ffb6b0b2ed191d9df675d59b2268087afd6f4da6dd
+  metadata.gz: ec7c2f8289ddd07244c2eea8d5c779c9d66b33c7a7d64cf812afc71c4bf3a2fbe3e17ab4e7a64332b5f26d056a13b5cf7316e6920495b9d13d7a93a047de04f9
+  data.tar.gz: 21a7836272fb2e90f78ddfd994070bbeb2a4e5eed40c006c01dff06978b624ece5db156e8b861c732bff1397a732791303c8752de7be279095f2bb4ee3050205

data/CHANGELOG.md

@@ -1,2 +1,6 @@
 ## 0.1.0
   - Plugin created with the logstash plugin generator
+## 0.1.1
+  - 增加httpAgentJson输出
+## 0.1.2
+  - 处理在高版本logstash报Detected ambiguous Field Reference问题

data/README.md

@@ -9,8 +9,10 @@
 ### 1. 插件开发环境和测试
 
 #### Code
+
 - 首先，您需要安装了Bundler gem的JRuby。
 - 执行下面的命令安装依赖
+
 ```sh
 bundle install
 ```
@@ -33,19 +35,26 @@ bundle exec rspec
 
 ### 2. 在logstash中运行未发布的插件
 
+以下方式2选一即可
+
 #### 2.1 直接在logstash使用克隆下来的插件代码
 
 进入logstash安装目录，一般是`/usr/share/logstash`
 
 - 编辑 `Gemfile` ，添加本地插件路径，如下所示:
+
 ```ruby
 gem "logstash-filter-device_detector", :path => "/path/to/logstash-filter-device-detector"
 ```
+
 - 安装插件
+
 ```sh
 bin/logstash-plugin install --no-verify
 ```
+
 - 运行logstash测试此插件
+
 ```sh
 cd /etc/logstash/conf.d
 vim test.conf
@@ -64,28 +73,28 @@ output {
 # 运行logstash
 /usr/share/logstash/bin/logstash -f test.conf
 ```
-然后在屏幕输入useragent就可以看到效果了。
 
-#### 2.2 在logstash使用gem安装插件
+然后在屏幕输入useragent就可以看到效果了。
 
-You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+#### 2.2 在logstash安装构建好的gem插件
 
 - 构建gem
+
 ```sh
 gem build logstash-filter-device-detector.gemspec
 ```
+
 - 进入logstash安装目录，安装gem插件
+
 ```sh
-bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.gem
+bin/logstash-plugin install /path/to/logstash-filter-device_detector-0.1.1.gem
 ```
-- Start Logstash and proceed to test the plugin
 
-## Contributing
+## 安装在线插件
 
-All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+```sh
+bin/logstash-plugin install logstash-filter-device_detector
+```
 
-Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
 
-It is more important to the community that you are able to contribute.
 
-For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/filters/device_detector.rb

@@ -53,11 +53,16 @@ class LogStash::Filters::DeviceDetector < LogStash::Filters::Base
       mozilla = false
       model = true
       platform = "Other"
-      os = "Other"
+      os_full = "Other"
       engine = ""
       engine_version = ""
       browser = ""
       browser_version = ""
+      browser_full = ""
+      os_name = ""
+      os_version = ""
+      device_name = ""
+      device_brand = ""
 
       if data.device_type =~ /phone/
         is_mobile = true
@@ -70,18 +75,43 @@ class LogStash::Filters::DeviceDetector < LogStash::Filters::Base
       if data.device_type
         platform = data.device_type
       end
-      if data.os_full_version
-        os = "#{data.os_name} #{data.os_full_version}"
+      if data.device_brand
+        device_brand = data.device_brand
       end
-      if data.name
-        browser = data.name
-        if data.name =~ /irefox/
-          mozilla = true
+      if data.device_name
+        device_name = data.device_name
+      end
+      if data.os_name && data.os_full_version
+        os_name = data.os_name
+        os_version = data.os_full_version
+        os_full = "#{os_name} #{os_version}"
+      else
+        if data.os_name
+          os_name = data.os_name
+          os_full = os_name
+        end
+        if data.os_full_version
+          os_version = data.os_full_version
         end
       end
-      if data.full_version
+
+      if data.name && data.full_version
+        browser = data.name
         browser_version = data.full_version
+        browser_full = "#{browser},#{browser_version}"
+      else
+        if data.name
+          browser = data.name
+          browser_full = browser
+        end
+        if data.full_version
+          browser_version = data.full_version
+        end
+      end
+      if browser =~ /firefox/i
+        mozilla = true
       end
+
       # 构造输出哈希表
       output = {
         "isMobile" => is_mobile,
@@ -89,25 +119,35 @@ class LogStash::Filters::DeviceDetector < LogStash::Filters::Base
         "mozilla" => mozilla,
         "model" => model,
         "platform" => platform,
-        "os" => os,
+        "os" => os_full,
         "engine" => engine,
         "engineVersion" => engine_version,
         "browser" => browser,
         "browserVersion" => browser_version
       }
+      target_hash = {
+        "browser" => {
+          "name" => browser,
+          "version" =>browser_version
+        },
+        "os" => {
+          "name" => os_name,
+          "version" => os_version
+        },
+        "device" => {
+          "name" => device_name,
+          "brand" => device_brand,
+          "type" => platform
+        }
+      }
+      if is_bot
+        target_hash['bot_name'] = spider
+      end
       event.set("httpUserAgentJson", output.to_json)
-      event.set("os", os)
-      event.set("browser", "#{browser},#{browser_version}")
+      event.set("os", os_full)
+      event.set("browser", browser_full)
       event.set("spider", spider)
-      event.set("#{@target}[browser][name]", data.name) if data.name
-      event.set("#{@target}[browser][version]", data.full_version) if data.full_version
-      event.set("#{@target}[os][name]", data.os_name) if data.os_name
-      event.set("#{@target}[os][version]", data.os_full_version) if data.os_full_version
-      event.set("#{@target}[device][name]", data.device_name) if data.device_name
-      event.set("#{@target}[device][brand]", data.device_brand) if data.device_brand
-      event.set("#{@target}[device][type]", data.device_type) if data.device_type
-      event.set("#{@target}[bot][name]", data.bot_name) if data.bot_name
-      event.set("#{@target}[bot][name]", data.bot_name) if data.bot_name
+      event.set("#{@target}", target_hash)
     rescue StandardError => e
       @logger.error("Uknown error while setting device data", :exception => e, :field => @source, :event => event)
       return

data/logstash-filter-device-detector.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name          = 'logstash-filter-device_detector'
-  s.version       = '0.1.1'
+  s.version       = '0.1.2'
   s.licenses      = ['Apache-2.0']
   s.summary       = '使用device_detector解析useragent的logstash-filter插件.'
   s.description   = 'Detects a vast amount of different devices automaticly based on regex rules.'

data/spec/filters/device_detector_spec.rb

@@ -7,8 +7,8 @@ describe LogStash::Filters::DeviceDetector do
     let(:config) do <<-CONFIG
       filter {
         device_detector {
-          source => "useragent"
-          target => "device_detector"
+          source => "http_user_agent"
+          target => "ua"
         }
       }
     CONFIG

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-device_detector
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Dukang