logstash-filter-ip2location 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae61a9f5111858d201154f3657cb9ae277ac8586
+  data.tar.gz: df982bdc0edfc26f3f1b92296b734219cc77a365
+SHA512:
+  metadata.gz: 5de6323f8fbc2878ec1dd18ee0cd42749ba7e71bdab5339ca102b236d42e4568f0b69dbdd0ecc482508993925e91f714bfe9e2432bc6a55b32552cca941fd01a
+  data.tar.gz: 189cd4149dee2808c06d9a85ed0bc4ad9abd5060f90867fb0c0930594c34a9e93391ce21d873e58b6c989dcab1432439d851393b6b1ffcabb4680dc2d55e6599

data/Gemfile

@@ -0,0 +1,11 @@
+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/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2017 IP2Location.com
+
+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,28 @@
+# IP2Location Filter Plugin
+This is IP2Location Filter plugin for Logstash that enables the user to find the country, region or state, city, latitude and longitude, US ZIP code, time zone, Internet Service Provider (ISP) or company name, domain name, net speed, area code, weather station code, weather station name, mobile country code (MCC), mobile network code (MNC) and carrier brand, elevation, and usage type by IP address or hostname originates from.  The library reads the geo location information from **IP2Location BIN data** file.
+
+Supported IPv4 and IPv6 address.
+
+
+## Dependencies (IP2LOCATION BIN DATA FILE)
+This plugin requires IP2Location BIN data file to function. You may download the BIN data file at
+* IP2Location LITE BIN Data (Free): https://lite.ip2location.com
+* IP2Location Commercial BIN Data (Comprehensive): https://www.ip2location.com/software/java-component
+
+
+## IP2Location Filter Configuration
+|Setting|Input type|Required|
+|---|---|---|
+|source|string|Yes|
+|database|a valid filesystem path|No|
+|license|string|No|
+
+* **source** field is a required setting that containing the IP address or hostname to get the ip information.
+* **database** field is an optional setting that containing the path to the IP2Location BIN database file.
+* **license** field is an optional setting that containing the license key value to remove the random 5 second delay in demo version.
+
+
+## Support
+Email: support@ip2location.com
+
+URL: [https://www.ip2location.com](https://www.ip2location.com)

data/lib/logstash-filter-ip2location_jars.rb

@@ -0,0 +1,5 @@
+# AUTOGENERATED BY THE GRADLE SCRIPT. DO NOT EDIT.
+
+require 'jar_dependencies'
+require_jar('com.ip2location.ip2location', 'ip2location', '8.0.2')
+require_jar('org.logstash.filters', 'logstash-filter-ip2location', '1.0.0')

data/lib/logstash/filters/ip2location.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+
+require "logstash-filter-ip2location_jars"
+
+class LogStash::Filters::IP2Location < LogStash::Filters::Base
+  config_name "ip2location"
+
+  # The path to the IP2Location.BIN database file which Logstash should use.
+  # If not specified, this will default to the IP2LOCATION-LITE-DB3.IPV6.BIN database that embedded in the plugin.
+  config :database, :validate => :path
+
+  # The field containing the IP address.
+  # If this field is an array, only the first value will be used.
+  config :source, :validate => :string, :required => true
+
+  # The field used to define iplocation as target.
+  config :target, :validate => :string, :default => 'ip2location'
+
+  # The field containing the license key.
+  # If this field is provided, The random 5-second delay will be removed.
+  config :license, :validate => :string, :default => ''
+
+  public
+  def register
+    if @database.nil?
+      @database = ::Dir.glob(::File.join(::File.expand_path("../../../vendor/", ::File.dirname(__FILE__)),"IP2LOCATION-LITE-DB3.IPV6.BIN")).first
+
+      if @database.nil? || !File.exists?(@database)
+        raise "You must specify 'database => ...' in your ip2location filter (I looked for '#{@database}')"
+      end
+    end
+
+    @logger.info("Using ip2location database", :path => @database)
+    
+    @ip2locationfilter = org.logstash.filters.IP2LocationFilter.new(@source, @target, @database, @license)
+  end
+
+  public
+  def filter(event)
+    return unless filter?(event)
+    if @ip2locationfilter.handleEvent(event)
+      filter_matched(event)
+    else
+      tag_iplookup_unsuccessful(event)
+    end
+  end
+
+  def tag_iplookup_unsuccessful(event)
+    @logger.debug? && @logger.debug("IP #{event.get(@source)} was not found in the database", :event => event)
+  end
+
+end # class LogStash::Filters::IP2Location

data/logstash-filter-ip2location.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-filter-ip2location'
+  s.version         = '1.0.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "Logstash filter IP2Location"
+  s.description     = "IP2Location plugin for Logstash filter"
+  s.authors         = ["IP2Location"]
+  s.email           = 'support@ip2location.com'
+  s.homepage        = "https://www.ip2location.com"
+  s.require_paths   = ["lib", "vendor/jar-dependencies"]
+
+  # Files
+  s.files = Dir["lib/**/*",'spec/**/*',"vendor/**/*","vendor/jar-dependencies/**/*.jar","*.gemspec","*.md","Gemfile","LICENSE"]
+
+  # 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"
+end

data/spec/filters/ip2location_spec.rb

@@ -0,0 +1,32 @@
+# encoding: utf-8
+require_relative '../spec_helper'
+require "logstash/filters/ip2location"
+
+IP2LOCATIONDB = ::Dir.glob(::File.expand_path("../../vendor/", ::File.dirname(__FILE__))+"/IP2LOCATION-LITE-DB3.IPV6.BIN").first
+
+describe LogStash::Filters::IP2Location do
+
+  describe "normal test" do
+    config <<-CONFIG
+      filter {
+        ip2location {
+          source => "ip"
+          #database => "#{IP2LOCATIONDB}"
+        }
+      }
+    CONFIG
+
+    sample("ip" => "8.8.8.8") do
+      expect(subject.get("ip2location")).not_to be_empty
+      expect(subject.get("ip2location")["country_short"]).to eq("US")
+      end
+    end
+
+    sample("ip" => "2a01:04f8:0d16:26c2::") do
+      expect(subject.get("ip2location")).not_to be_empty
+      expect(subject.get("ip2location")["country_short"]).to eq("DE")
+      end
+    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,87 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-ip2location
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- IP2Location
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  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: IP2Location plugin for Logstash filter
+email: support@ip2location.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash-filter-ip2location_jars.rb
+- lib/logstash/filters/ip2location.rb
+- logstash-filter-ip2location.gemspec
+- spec/filters/ip2location_spec.rb
+- spec/spec_helper.rb
+- vendor/IP2LOCATION-LITE-DB3.IPV6.BIN
+- vendor/jar-dependencies/com/ip2location/ip2location/ip2location/8.0.2/ip2location-8.0.2.jar
+- vendor/jar-dependencies/org/logstash/filters/logstash-filter-ip2location/1.0.0/logstash-filter-ip2location-1.0.0.jar
+homepage: https://www.ip2location.com
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: filter
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Logstash filter IP2Location
+test_files:
+- spec/filters/ip2location_spec.rb
+- spec/spec_helper.rb