logstash-filter-wurfl_device_detection 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 569f2d8ec0d6977801ef612c6576f8f9c5cffbb7e9af3ac790234c3ec67a4d27
+  data.tar.gz: f3550677c5062c336553b2e82923d81b3d7c9d71aaf46aaba5d3d2f1ad1e5e41
+SHA512:
+  metadata.gz: 186f32f8eb0e9e6f4242d0920c374c3d51079788fabc6b3acce0b072e1aa7459aa8eb00d01bb4c8ae18909af607935e2c7de22b2b8f147dcd23327ac9a2a256f
+  data.tar.gz: 639d317c5b54920adf4cefea58276c78e861481ef81264e1544bba9b53c51c7f270ce3b09c16129bf2405f2ae6d44275829d1658a0b570f435cf3fce6a964ebb

data/Gemfile

@@ -0,0 +1,12 @@
+# AUTOGENERATED BY THE GRADLE SCRIPT. EDITS WILL BE OVERWRITTEN.
+source 'https://rubygems.org'
+
+gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/README.md

@@ -0,0 +1,119 @@
+### WURFL Logstash plugin
+
+This project contains a java plugin for Logstash that enriches a stream of data with device detection data obtained via WURFL Microservice.
+
+This plugin requires Java 8+, Gradle 5.x or above and has been tested with Logstash 8.0.0 and 7.6.x
+
+## Compile the project
+
+From the root of the project do ` ./gradlew gem`
+A file `logstash-filter-logstash_filter_wurfl_device_detection-x.y.z.gem`, where x.y.z version number
+is the one defined in the `VERSION` file.
+
+## Install the plugin on logstash
+
+  From the logstash installation `bin` directory execute
+  `./logstash-plugin install --local <plugin_project_home>/logstash-filter-logstash_filter_wurfl_device_detection-x.y.z.gem`
+  
+  Please note that this plugin requires a `stdin` plugin as specified in the sample configuration file
+  `wurfl_filter.conf`; also note that the aforementioned file is a sample: you will want to create your own
+  production configuration file.
+  
+  ## Sample Logstash execution with WURFL device detection plugin - user-agent list file example
+  Scenario: we have a file with a list of user-agent strings. We want to output some device detection data for each input user-agent.
+  We can execute logstash sending the user-agent to its standard input via pipe, like this:
+  
+  `head -n <number of user-agents to send> <path_to_user_agent_list> | ./logstash -f <path_to_configuration>.conf>`
+  
+  In case you use the sample configuration in the file wurfl_filter.conf, you'll get an output like this:
+  
+  ```
+{
+    "@timestamp" => 2020-03-10T15:50:19.917Z,
+      "message" => "Mozilla/5.0 (Linux; Android 5.1; DL718M Build/LMY47I) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.93 Safari/537.36",
+      "@version" => "1",
+      "host" => "my-laptop",
+      "wurfl" => {
+        "form_factor" => "Tablet",
+         "brand_name" => "Digiland",
+         "wurfl_id" => "digiland_dl718m_ver1",
+         "model_name" => "DL718M"
+    }
+```
+
+### Example configuration 1 - Input file with a list of user-agent strings
+
+```
+input {
+  stdin { }
+}
+filter {
+  logstash_filter_wurfl_device_detection {
+    cache_size => 300000
+    inject_wurfl_id => true
+    inject_wurfl_info => false
+    inject_wurfl_api_version => false
+    static_capabilities => ["model_name", "brand_name"]
+    virtual_capabilities => ["form_factor"]
+    scheme => "http"
+    host => "localhost"
+    port => "8080"
+  }
+}
+output {
+  stdout { codec => rubydebug }
+}
+```
+
+## Sample Logstash execution with WURFL device detection plugin - header map received from HTTP input
+Scenario: we configure logstash to receive HTTP request info which we want to enrich with WURFL data.
+We execute logstash:
+
+`./logstash -f <path_to_configuration>.conf>`
+
+The input configuration for this file is defined in http input configuration, ie: 
+```
+input {
+  http {
+    host => "0.0.0.0"
+    port => "19080"
+  }
+}
+filter {
+  logstash_filter_wurfl_device_detection {
+    source => "headers"
+    cache_size => 300000
+    inject_wurfl_id => true
+    inject_wurfl_info => false
+    inject_wurfl_api_version => false
+    scheme => "http"
+    host => "localhost"
+    port => "8080"
+  }
+}
+output {
+  stdout { codec => rubydebug }
+}
+```
+
+The http input plugin receives an http request to the specified host and port, with a payload map that contains the HTTP headers
+to be analyzed by the WURFL plugin.
+Note that the `source` name is `headers`. Also note that you can configure the logstash input as you want,
+but if you want the WURFL plugin to work with headers, you must configure it so that it uses an header map.
+
+- `stdin` and `stdout` define which input and output plugin will be used: in the first scenario we use the standard input, in the second scenario
+ we use the HTTP input plugin, while in both scenarios we use the ruby debug console as output.
+- `cache_size` (integer) is the size of the WURFL Microservice client cache. Defaults to 100000
+- `inject_wurfl_id` defines whether `wurfl_id` will be added to enriched output (defaults to true)
+- `inject_wurfl_info` defines whether `wurfl_info` will be added to enriched output (defaults to false)
+- `inject_wurfl_api_version` defines whether `wurfl_api_version` will be added to enriched output (defaults to false)
+- `static_capabilities` defines the list of static capabilities that you want to add to the enriched output (defaults to all)
+- `virtual_capabilities` defines the list of virtual capabilities that you want to add to the enriched output (defaults to all)
+- `scheme` defines the connection scheme to use to connect to WURFL Microservice server (currently only HTTP is supported)
+- `host` host/ip address of the WURFL Microservice server (defaults to localhost)
+- `port` port of the WURFL Microservice server (defaults to 80)
+
+
+  
+    
+   

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/docs/index.asciidoc

@@ -0,0 +1,130 @@
+:plugin: logstash_filter_wurfl_device_detection
+:type: filter
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}s-{plugin}"]
+
+=== WURFL device detection filter plugin
+
+=== Description
+
+The WURFL device detection filter adds information about a device's capabilities, using WURFL Microservice client.
+
+[id="plugins-{type}s-{plugin}-options"]
+==== WURFL device detection Filter Configuration Options
+
+This plugin supports the following configuration options.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-cache_size>> |<<number,number>>|No
+| <<plugins-{type}s-{plugin}-inject_wurfl_id>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-inject_wurfl_info>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-inject_wurfl_api_version>> |<<boolean,boolean>>|No
+| <<plugins-{type}s-{plugin}-source>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-static_capabilities>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-virtual_capabilities>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-scheme>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-host>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-port>> |<<array,array>>|No
+
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+filter plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-cache_size"]
+===== `cache_size`
+
+* Value type is <<number,number>>
+* Default value is `100000`
+
+The size of WURFL Microservice client cache. If cache size is <= 0, default value will be used.
+
+[id="plugins-{type}s-{plugin}-inject_wurfl_id"]
+===== `inject_wurfl_id`
+
+* Value type is <<boolean,boolean>>
+* Default value is `false`
+
+Defines whether `wurfl_id` string will be added to enriched output.
+
+[id="plugins-{type}s-{plugin}-inject_wurfl_info"]
+===== `inject_wurfl_info`
+
+* Value type is <<boolean,boolean>>
+* Default value is `false`
+
+Defines whether `wurfl_info` string will be added to enriched output.
+
+[id="plugins-{type}s-{plugin}-inject_wurfl_api_version"]
+===== `inject_wurfl_api_version`
+
+* Value type is <<boolean,boolean>>
+* Default value is `false`
+
+Defines whether `wurfl_api_version` will be added to enriched output.
+
+[id="plugins-{type}s-{plugin}-source"]
+===== `source`
+
+* Value type is <<string,string>>
+* Default value is empty list
+
+The field used by the filter plugin to get data for device detection. If input data is made of simple user-agents sent one by one,
+you can use the default value `"message"`, if the the input data is made of all HTTP headers, the source value must be `"headers"`.
+
+[id="plugins-{type}s-{plugin}-static_capabilities"]
+===== `static_capabilities`
+
+* Value type is <<array,array>>
+* Default value is empty array which means *detect all static capabilities*
+
+A list of WURFL static capabilities that must be detected in order to be added to the output. Default value is empty array,
+which means *detect all capabilities*.
+
+[id="plugins-{type}s-{plugin}-virtual_capabilities"]
+===== `virtual_capabilities`
+
+* Value type is <<array,array>>
+* Default value is empty array which means *detect all virtual capabilities*
+
+A list of WURFL virtual capabilities that must be detected in order to be added to the output.
+
+[id="plugins-{type}s-{plugin}-scheme"]
+===== `scheme`
+
+* Value type is <<string,string>>
+* Default value is `"http"`
+
+Scheme used to connect to your WURFL Microservice server instance
+
+[id="plugins-{type}s-{plugin}-host"]
+===== `host`
+
+* Value type is <<string,string>>
+* Default value is `"localhost"`
+
+Host or IP address used to connect to your WURFL Microservice server instance
+
+[id="plugins-{type}s-{plugin}-port"]
+===== `port`
+
+* Value type is <<string,string>>
+* Default value is `"80"`
+
+Port used to connect to your WURFL Microservice server instance
+

data/lib/logstash-filter-wurfl_device_detection_jars.rb

@@ -0,0 +1,5 @@
+# AUTOGENERATED BY THE GRADLE SCRIPT. EDITS WILL BE OVERWRITTEN.
+# encoding: utf-8
+
+require 'jar_dependencies'
+require_jar('com.scientiamobile.logstash', 'logstash-filter-wurfl_device_detection', '0.3.0')

data/lib/logstash/filters/wurfl_device_detection.rb

@@ -0,0 +1,12 @@
+# AUTOGENERATED BY THE GRADLE SCRIPT. EDITS WILL BE OVERWRITTEN.
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+require "logstash-filter-wurfl_device_detection_jars"
+require "java"
+
+class LogStash::Filters::WurflDeviceDetection < LogStash::Filters::Base
+  config_name "wurfl_device_detection"
+
+  def self.javaClass() Java::com.scientiamobile.logstash.WurflDeviceDetection.java_class; end
+end

data/logstash-filter-wurfl_device_detection.gemspec

@@ -0,0 +1,22 @@
+# AUTOGENERATED BY THE GRADLE SCRIPT. EDITS WILL BE OVERWRITTEN.
+Gem::Specification.new do |s|
+  s.name            = 'logstash-filter-wurfl_device_detection'
+  s.version         = ::File.read('VERSION').split('\n').first
+  s.licenses        = ['Apache-2.0']
+  s.summary         = 'Filter that augments stream with WURFL device detection data'
+  s.description     = 'This gem is a Logstash plugin that augments stream with WURFL device detection data and is required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program'
+  s.authors         = ['Elasticsearch']
+  s.email           = ['info@elastic.co']
+  s.homepage        = 'http://www.elastic.co/guide/en/logstash/current/index.html'
+  s.require_paths = ['lib', 'vendor/jar-dependencies']
+
+  s.files = Dir["lib/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { 'logstash_plugin' => 'true', 'logstash_group' => 'filter', 'java_plugin' => 'true'}
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
+  s.add_runtime_dependency 'jar-dependencies'
+  s.add_development_dependency 'logstash-devutils'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-wurfl_device_detection
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Elasticsearch
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  name: logstash-core-plugin-api
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: jar-dependencies
+  type: :runtime
+  prerelease: false
+  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'
+  name: logstash-devutils
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a Logstash plugin that augments stream with WURFL device
+  detection data and is required to be installed on top of the Logstash core pipeline
+  using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone
+  program
+email:
+- info@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- VERSION
+- docs/index.asciidoc
+- lib/logstash-filter-wurfl_device_detection_jars.rb
+- lib/logstash/filters/wurfl_device_detection.rb
+- logstash-filter-wurfl_device_detection.gemspec
+- vendor/jar-dependencies/com/scientiamobile/logstash/logstash-filter-wurfl_device_detection/0.3.0/logstash-filter-wurfl_device_detection-0.3.0.jar
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: filter
+  java_plugin: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+- vendor/jar-dependencies
+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: []
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
+summary: Filter that augments stream with WURFL device detection data
+test_files: []