fluent-plugin-ua-parser 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 337a460e83df30aaf3e1723b70fabbd0d82514af
-  data.tar.gz: cf9823914d9dacfdd9eebbfcc3b0472030a30fe5
+  metadata.gz: 798fd3a07e20680afeb795bce63afd87c1d0ea50
+  data.tar.gz: a254e9205acd22070d3ddbd8cfeab569dd0afaf0
 SHA512:
-  metadata.gz: bb1f8302dd21aeaa8faa549eff52b89c85b9f5099819bf4a73feb9866f379994f8fa4b42ce933f297180c9d599591f4004bd3ec8b01f763930f87d2ee005d6a6
-  data.tar.gz: 7a50a8fd7e997da3c1002893f72efe90d11ccb6278c449bf47b7e99453529b77337b3c504ee8f4652958f3af4f33fd718766025a62efb9f7daf88afa73e4b435
+  metadata.gz: ef90a396baadafd69ca1e5743980b8e5b5c0a99ba0b296dab16d0e90b1052a68dcce69cb4ec2fa968ef7a7fbe5d59d380f6e223d7510e005e9108b06dcbd6e2f
+  data.tar.gz: f2a5211d157b3f754d64e3ffaa8f1f62a0c95ad8620a77c6185ec5e7e310e0da9e99e9685f61a95981e45c57bb7255b0b77842db6d003832e98e7b6ae6ceb079

data/README.md

@@ -112,6 +112,38 @@ access.apache: {
 }
 ```
 
+### Example 3:
+
+```xml
+<filter access.apache.**>
+  @type ua_parser
+  key_name ua_string
+  flatten
+</filter>
+```
+
+Assuming following inputs are coming:
+
+```json
+access.apache: {
+  "ua_string":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_1) AppleWebKit/601.2.7 (KHTML, like Gecko) Version/9.0.1 Safari/601.2.7"
+}
+```
+
+then output bocomes as belows:
+
+```json
+access.apache: {
+  "ua_string":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_1) AppleWebKit/601.2.7 (KHTML, like Gecko) Version/9.0.1 Safari/601.2.7",
+  "ua_browser_family":"Safari",
+  "ua_browser_version":"9.0.1",
+  "ua_browser_major_version":9,
+  "ua_os_family":"Mac OS X",
+  "ua_os_version":"10.11.1",
+  "ua_os_major_version":10,
+  "ua_device":"Other"
+}
+```
 
 
 ## Parameters
@@ -132,10 +164,13 @@ access.apache: {
     Patterns file(regexes.yaml) path.
     Get from [uap-core](https://github.com/ua-parser/uap-core)
 
+- flatten *bool*
+    join hashed data by '_'. default false.
+
 
 ## TODO
 
-* flatten option (join hashed data by '_')
+* patches welcome!
 
 
 ## Contributing

data/fluent-plugin-ua-parser.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-ua-parser"
-  spec.version       = "0.2.2"
+  spec.version       = "0.3.0"
   spec.authors       = ["Yuri Umezaki"]
   spec.email         = ["bungoume@gmail.com"]
   spec.homepage      = "https://github.com/bungoume/fluent-plugin-ua-parser"

data/lib/fluent/plugin/filter_ua_parser.rb

@@ -13,7 +13,7 @@ module Fluent
     config_param :key_name, :string, :default => 'user_agent'
     config_param :delete_key, :bool, :default => false
     config_param :out_key, :string, :default => 'ua'
-    # config_param :flatten, :bool :default => false
+    config_param :flatten, :bool, :default => false
     config_param :patterns_path, :string, :default => nil
 
     def configure(conf)
@@ -32,7 +32,11 @@ module Fluent
       record.delete(@key_name) if @delete_key
       unless ua_string.nil?
         user_agent_detail = @ua_cache.getset(ua_string) { get_ua_detail(ua_string) }
-        record[@out_key] = user_agent_detail
+        if flatten
+          record.merge! hash_flatten(user_agent_detail, [@out_key])
+        else
+          record[@out_key] = user_agent_detail
+        end
       end
       record
     end
@@ -52,5 +56,19 @@ module Fluent
       data['device'] = ua.device.to_s
       data
     end
+
+    def hash_flatten(a, keys=[])
+      ret = {}
+      a.each{|k,v|
+        ks = keys + [k]
+        if v.class == Hash
+          ret.merge!(hash_flatten(v, ks))
+        else
+          ret.merge!({ks.join('_')=> v})
+        end
+      }
+      ret
+    end
+
   end if defined?(Filter) # Support only >= v0.12
 end

data/test/plugin/test_filter_ua_parser.rb

@@ -41,4 +41,26 @@ class UaParserFilterTest < Test::Unit::TestCase
     assert_equal 'Other', ua_object['device']
   end
 
+  def test_emit_flatten
+    d1 =     d1 = create_driver(%[
+      type ua_parser
+      flatten
+    ], 'test')
+    ua = 'Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.71 Safari/537.36'
+
+    d1.run do
+      d1.emit({'user_agent' => ua})
+    end
+    emits = d1.emits
+    assert_equal 1, emits.length
+    assert_equal 'test', emits[0][0] # tag
+    ua_object = emits[0][2]
+    assert_equal 'Chrome', ua_object['ua_browser_family']
+    assert_equal 46, ua_object['ua_browser_major_version']
+    assert_equal '46.0.2490', ua_object['ua_browser_version']
+    assert_equal 'Windows 7', ua_object['ua_os_family']
+    assert_equal '', ua_object['ua_os_version']
+    assert_equal 'Other', ua_object['ua_device']
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-ua-parser
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Yuri Umezaki