logstash-filter-device_detection 1.0.0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ffe06b04a9293e5f53fbe1a527706d103e47506
+  data.tar.gz: c6684c978ba8b6e47d8e93074dbaf916f64cf702
+SHA512:
+  metadata.gz: 81479cfa879590787dec8b6e82431590be99705cad732a9f59a145e6aa96df66693a697569d8f08254fe39ac2544b5b1282ad2afdd29eb1c020d4a065fd61a60
+  data.tar.gz: 67b869e651ac768bb7c0a8c81c8eda82384413c3e582d8f0c492da0fb77f799a4b50131936b13aefa66e3a22147d6ea78a9ae1181a095ca7490632f0c24aaf6a

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 1.0.0
+  - Initial release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+

data/LICENSE

@@ -0,0 +1,11 @@
+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/NOTICE.TXT

@@ -0,0 +1,4 @@
+This product includes Device Detection data created by 51Degrees, available from
+<a href="https://51degrees.com/">https://51degrees.com/</a>.
+
+The Device Detection databases are distributed under the Mozilla Public License 2.

data/README.md

@@ -0,0 +1,88 @@
+# Logstash Plugin
+
+[![Build Status](https://travis-ci.org/lalex/logstash-filter-device_detection.svg?branch=master)](https://travis-ci.org/lalex/logstash-filter-device_detection)
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/logstash-plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+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:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/logstash-plugin install /your/local/plugin/logstash-filter-awesome.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.
+
+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_detection.rb

@@ -0,0 +1,100 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+require "logstash-filter-device_detection_jars.rb"
+
+# [NOTE]
+# --
+# This product includes Device Detection data created by 51Degrees, available from
+# https://51degrees.com/. This database is licensed under
+# http://www.mozilla.org/MPL/2.0/[Mozilla Public License 2].
+# --
+
+class LogStash::Filters::DeviceDetection < LogStash::Filters::Base
+
+  config_name "device_detection"
+
+  # The field containing the User-Agent header string.
+  config :source, :validate => :string, :default => 'user_agent'
+
+  # Specify the field into which Logstash should store the device data.
+  config :target, :validate => :string, :default => 'device_match'
+
+  # Path to 51Degrees Device Detection data file. Only BinaryV32 format is supported now.
+  #
+  # If not specified, this will default to the 51Degrees Device Detection database
+  # that ships with Logstash.
+  config :datafile, :validate => :path
+
+  # Cache size for Device Detection library.
+  #
+  # This MUST be set to a value > 0.
+  config :cache_size, :validate => :number, :default => 1000
+
+  # An array of device properties to be included in the event.
+  #
+  # For the full property dictionary refer to
+  # https://51degrees.com/resources/property-dictionary
+  config :properties, :validate => :array
+
+  public
+  def register
+
+    if @datafile.nil?
+      @datafile = ::Dir.glob(::File.expand_path("../../../vendor/", ::File.dirname(__FILE__))+"/51Degrees-LiteV3.2.dat").first
+
+      if @datafile.nil? || !::File.exists?(@datafile)
+        raise "You must specify 'datafile => ...' in your device_detection filter (currently is set to '#{@datafile}')"
+      end
+    end
+
+    if @properties.nil? || @properties.empty?
+      raise "An array of device properties must not be empty."
+    end
+
+    begin
+      dataset = Java::FiftyoneMobileDetectionFactories::StreamFactory.create(@datafile, false)
+      @provider = Java::FiftyoneMobileDetection::Provider.new(dataset, @cache_size)
+    rescue StandardError => e
+      @logger.error("Error while initializing device detection provider object", :exception => e)
+      return
+    end
+
+  end # def register
+
+  public
+  def filter(event)
+    begin
+
+      begin
+        match = @provider.match(event.get(@source))
+      rescue StandardError => e
+        @logger.error("Error while parsing user agent data", :exception => e, :field => @source, :event => event)
+        return
+      end
+
+      return unless match
+
+      apply_match(match, event)
+
+      #event.set(@target, match.getValues("IsMobile").toString())
+
+    rescue Exception=>e
+        @logger.error("Failed to detect device", :exception => e, :field => @source)
+    end
+
+    # filter_matched should go in the last line of our successful code
+    filter_matched(event)
+  end # def filter
+
+  def apply_match(match, event)
+    @properties.each do |property|
+      field = "[#{@target}][#{property}]"
+      value = match.getValues(property)
+      event.set(field, value.toString()) if value
+    end
+    true
+  end
+
+end # class LogStash::Filters::Browser

data/lib/logstash-filter-device_detection_jars.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+require 'logstash/environment'
+
+root_dir = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+LogStash::Environment.load_runtime_jars! File.join(root_dir, "vendor")

data/logstash-filter-device_detection.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+  s.name          = 'logstash-filter-device_detection'
+  s.version       = '1.0.0'
+  s.licenses      = ['Apache License (2.0)']
+  s.summary       = 'Use 51Degrees Device Detection library to parse User-Agent string'
+  s.authors       = ['lalex']
+  s.email         = 'github@lalex.nsk.ru'
+  s.platform      = "java"
+  s.require_paths = ['lib']
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','Gemfile','LICENSE','NOTICE.TXT']
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
+  s.add_development_dependency 'logstash-devutils'
+
+  # Jar dependencies
+  s.requirements << "jar 'com.51degrees:device-detection-core', '3.2.14.2'"
+  s.add_development_dependency 'jar-dependencies', '~> 0.3.2'
+end

data/spec/filters/device_detection_spec.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+require_relative '../spec_helper'
+require "logstash/filters/device_detection"
+
+DATAFILE = ::Dir.glob(::File.expand_path("../../vendor/", ::File.dirname(__FILE__))+"/51Degrees-LiteV3.2.dat").first
+
+describe LogStash::Filters::DeviceDetection do
+
+  describe "properties is not set" do
+    let(:config) do <<-CONFIG
+      filter {
+        device_detection {
+          #datafile => "#{DATAFILE}"
+          source => "user_agent"
+          target => "device_detection"
+        }
+      }
+    CONFIG
+    end
+
+    sample("user_agent" => "Mozilla/5.0 (Windows NT 6.3; WOW64; rv:41.0) Gecko/20100101 Firefox/41.0") do
+      expect { subject }.to raise_error(RuntimeError)
+    end
+
+  end
+
+  describe "empty properties" do
+    let(:config) do <<-CONFIG
+      filter {
+        device_detection {
+          #datafile => "#{DATAFILE}"
+          source => "user_agent"
+          target => "device_detection"
+          properties => []
+        }
+      }
+    CONFIG
+    end
+
+    sample("user_agent" => "Mozilla/5.0 (Windows NT 6.3; WOW64; rv:41.0) Gecko/20100101 Firefox/41.0") do
+      expect { subject }.to raise_error(RuntimeError)
+    end
+
+  end
+
+  describe "defaults" do
+    let(:config) do <<-CONFIG
+      filter {
+        device_detection {
+          #datafile => "#{DATAFILE}"
+          source => "user_agent"
+          target => "device_detection"
+          properties => ["BrowserName","BrowserVersion","IsMobile"]
+        }
+      }
+    CONFIG
+    end
+
+    sample("user_agent" => "Mozilla/5.0 (Windows NT 6.3; WOW64; rv:41.0) Gecko/20100101 Firefox/41.0") do
+      expect(subject.get('[device_detection][BrowserName]')).to eq('Firefox')
+      expect(subject.get('[device_detection][BrowserVersion]')).to eq('41.0')
+      expect(subject.get('[device_detection][IsMobile]')).to eq('False')
+    end
+
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-device_detection
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: java
+authors:
+- lalex
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  name: jar-dependencies
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+description:
+email: github@lalex.nsk.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/ch/qos/logback/logback-classic/1.1.8/logback-classic-1.1.8.jar
+- lib/ch/qos/logback/logback-core/1.1.8/logback-core-1.1.8.jar
+- lib/com/51degrees/device-detection-core/3.2.14.2/device-detection-core-3.2.14.2.jar
+- lib/logstash-filter-device_detection_jars.rb
+- lib/logstash/filters/device_detection.rb
+- lib/org/slf4j/slf4j-api/1.7.21/slf4j-api-1.7.21.jar
+- logstash-filter-device_detection.gemspec
+- spec/filters/device_detection_spec.rb
+- spec/spec_helper.rb
+- vendor/51Degrees-LiteV3.2.dat
+- vendor/jar-dependencies/runtime-jars/device-detection-core-3.2.14.2.jar
+- vendor/jar-dependencies/runtime-jars/logback-classic-1.1.8.jar
+- vendor/jar-dependencies/runtime-jars/logback-core-1.1.8.jar
+- vendor/jar-dependencies/runtime-jars/slf4j-api-1.7.21.jar
+homepage:
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: filter
+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:
+- jar 'com.51degrees:device-detection-core', '3.2.14.2'
+rubyforge_project:
+rubygems_version: 2.4.8
+signing_key:
+specification_version: 4
+summary: Use 51Degrees Device Detection library to parse User-Agent string
+test_files:
+- spec/filters/device_detection_spec.rb
+- spec/spec_helper.rb