fluent-plugin-ua-parser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ade12c40a9becdda4333372790d707e6559b402
+  data.tar.gz: 55d66ce3151f81be45f11edde0fb1d1100a7ea3a
+SHA512:
+  metadata.gz: 669ae328afaaf26086697a0e452a92cc0fb424076ce87a73586933d8561c3dd6a3f72088e7300dad45d3046d625beb7b7962168e4200ebb63ca2dbab99ad66da
+  data.tar.gz: 742ec9cd4b44faef6658a40a0bae195f7bd3e5f281c741901252a4399ae747a7a60f8664eec6199178f630b393cc4b703b438f00936f116414e34d647f229bc3

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-ignore-filter.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2015 Yuri UMEZAKI
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,153 @@
+# Fluent-plugin-ua-parser
+
+[Fluentd](http://fluentd.org) filter plugin to parse user-agent.
+
+
+## Installation
+
+```bash
+# for fluentd
+$ gem install fluent-plugin-ua-parser
+
+# for td-agent2
+$ sudo td-agent-gem install fluent-plugin-ua-parser
+```
+
+
+## Usage
+
+### Example 1:
+
+```xml
+<filter access.nginx.**>
+  @type ua_parser
+</filter>
+```
+
+Assuming following inputs are coming:
+
+```
+access.nginx: {
+  "remote_addr":"10.20.30.40",
+  "scheme":"http", "method":"GET", "host":"example.com",
+  "path":"/", "query":"-", "req_bytes":200, "referer":"-",
+  "user_agent":"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.71 Safari/537.36",
+  "status":200, "res_bytes":800, "res_body_bytes":600, "taken_time":0.001
+}
+```
+
+then output bocomes as belows:
+
+```
+access.nginx: {
+  "remote_addr":"10.20.30.40",
+  "scheme":"http", "method":"GET", "host":"example.com",
+  "path":"/", "query":"-", "req_bytes":200, "referer":"-",
+  "user_agent":"Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/46.0.2490.71 Safari/537.36",
+  "ua":{
+    "browser":{
+      "family":"Chrome",
+      "version":"46.0.2490",
+      "major_version":46
+    },
+    "os":{
+      "family":"Windows 7",
+      "version":""
+    },
+    "device":"Other"
+  },
+  "status":200, "res_bytes":800, "res_body_bytes":600, "taken_time":0.001
+}
+```
+
+### Example 2:
+
+```xml
+<filter access.apache.**>
+  @type ua_parser
+  key_name ua_string
+  delete_key yes
+  out_prefix ua
+  patterns_path /etc/td-agent/data/regexes.yaml
+</filter>
+```
+
+Assuming following inputs are coming:
+
+```
+access.nginx: {
+  "remote_addr":"10.20.30.40",
+  "scheme":"http", "method":"GET", "host":"example.com",
+  "path":"/", "query":"-", "req_bytes":200, "referer":"-",
+  "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",
+  "status":200, "res_bytes":800, "res_body_bytes":600, "taken_time":0.001
+}
+```
+
+then output bocomes as belows:
+
+```
+access.nginx: {
+  "remote_addr":"10.20.30.40",
+  "scheme":"http", "method":"GET", "host":"example.com",
+  "path":"/", "query":"-", "req_bytes":200, "referer":"-",
+  "ua":{
+    "browser":{
+      "family":"Safari",
+      "version":"9.0.1",
+      "major_version":9
+    },
+    "os":{
+      "family":"Mac OS X",
+      "version":"10.11.1",
+      "major_version":10
+    },
+    "device":"Other"
+  },
+  "status":200, "res_bytes":800, "res_body_bytes":600, "taken_time":0.001
+}
+```
+
+
+
+## Parameters
+- key_name *field_key*
+
+    Target key name. default user_agent.
+
+- delete_key *bool*
+
+    Delete input key. default false.
+
+- out_prefix *string*
+
+    Output prefix key name. default ua.
+
+- patterns_path *file_path*
+
+    Patterns file(regexes.yaml) path.
+    Get from [uap-core](https://github.com/ua-parser/uap-core)
+
+
+## TODO
+
+* patches welcome!
+
+
+## Contributing
+
+1. Fork it ( https://github.com/bungoume/fluent-plugin-ua-parser/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+
+## Copyright
+
+Copyright (c) 2015 Yuri Umezaki
+
+
+## License
+
+Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/fluent-plugin-ua-parser.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-ua-parser"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Yuri Umezaki"]
+  spec.email         = ["bungoume@gmail.com"]
+  spec.homepage      = "https://github.com/bungoume/fluent-plugin-ua-parser"
+  spec.summary       = "Fluentd filter plugin to parse user-agent"
+  spec.description   = spec.summary
+  spec.license       = "APLv2"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "fluentd", ">= 0.12"
+  spec.add_runtime_dependency "user_agent_parser", ">= 2.2.0"
+  spec.add_runtime_dependency "lru_redux", ">= 1.0.0"
+  spec.add_development_dependency "rake"
+end

data/lib/fluent/plugin/filter_ua_parser.rb

@@ -0,0 +1,56 @@
+require 'user_agent_parser'
+require 'lru_redux'
+
+module Fluent
+  class UaParserFilter < Filter
+    Plugin.register_filter('ua_parser', self)
+
+    def initialize
+      @ua_cache = LruRedux::Cache.new(8000)
+      super
+    end
+
+    config_param :key_name, :string, :default => 'user_agent'
+    config_param :delete_key, :bool, :default => false
+    config_param :out_prefix, :string, :default => 'ua'
+    # config_param :flatten, :bool :default => false
+    config_param :patterns_path, :string, :default => nil
+
+    def configure(conf)
+      super
+      begin
+        @parser = UserAgentParser::Parser.new(patterns_path: @patterns_path)
+      rescue => e
+        @parser = UserAgentParser::Parser.new
+        log.warn "Failed to configure parser. Use default pattern.", :error_class => e.class, :error => e.message
+        log.warn_backtrace
+      end
+    end
+
+    def filter(tag, time, record)
+      ua_string = record[@key_name]
+      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
+      end
+      record
+    end
+
+    private
+
+    def get_ua_detail(ua_string)
+      ua = @parser.parse(ua_string)
+      data = {"browser"=>{}, "os"=>{}, "device"=>"", "string"=>ua_string}
+      return data if ua.nil?
+      data['browser']['family'] = ua.family
+      data['browser']['version'] = ua.version.to_s
+      data['browser']['major_version'] = ua.version.major.to_i unless ua.version.nil?
+      data['os']['family'] = ua.os.family
+      data['os']['version'] = ua.os.version.to_s
+      data['os']['major_version'] = ua.os.version.major.to_i unless ua.os.version.nil?
+      data['device'] = ua.device.to_s
+      data
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-ua-parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yuri Umezaki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: user_agent_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: lru_redux
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fluentd filter plugin to parse user-agent
+email:
+- bungoume@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-ua-parser.gemspec
+- lib/fluent/plugin/filter_ua_parser.rb
+homepage: https://github.com/bungoume/fluent-plugin-ua-parser
+licenses:
+- APLv2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Fluentd filter plugin to parse user-agent
+test_files: []