logstash-filter-ip2location 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfa0834d82fd5dd60221508d1ab23b574c1c9692
-  data.tar.gz: 765b7d1d1d2efa5babd36b2a427dc48ef24a384e
+  metadata.gz: e14af9fe1c77455ad3edbc6d0408f663b4f7db50
+  data.tar.gz: ee905119c82b65ed05f0c7ffdcf471ba41a53207
 SHA512:
-  metadata.gz: 34faab4251e46900097ca5c17dace085a46d6ff8c9a5230cc9713700ee06c042831ec27f7e424b4ccf11c921d5b143c6f364004bcdefe0b291fae926b2e81cf4
-  data.tar.gz: a65542b74c32436ef4166fb7c469f97f7606c0bf94fab6b32675cb004d4831a3401c633535d297b67dd8134e6b26ac6347f149e7203076e724d64d4bd89a7559
+  metadata.gz: 8169aea768367e1178a5edceb76501726deff71fd7466ebcb3959e6a721287cbb7f66443d66e390f29db221210cf5d2d693a999e520b29c2fe1f914e80a15e11
+  data.tar.gz: 5cdc1daf13e891c3d9fff485b0af278cb3ced3817227146836027bef563f2670cf416f6dc9271bdda4624b5ebec6f6e3e301a278f038728db3580d6499d77256

data/Gemfile

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

@@ -1,13 +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
+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

@@ -1,35 +1,89 @@
-# IP2Location Filter Plugin
-This is IP2Location filter plugin for Logstash that enables Logstash's users to add geolocation information such as country, region, city, latitude, longitude, ZIP code, time zone, Internet Service Provider (ISP), domain name, connection speed, IDD code, area code, weather station code, weather station name, mobile country code (MCC), mobile network code (MNC), mobile brand, elevation, and usage type by IP address. 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
-
-
-## Installation
-Install this plugin by the following code:
-```
-bin/logstash-plugin install logstash-filter-ip2location
-```
-
-
-## 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)
+# IP2Location Filter Plugin
+This is IP2Location filter plugin for Logstash that enables Logstash's users to add geolocation information such as country, region, city, latitude, longitude, ZIP code, time zone, Internet Service Provider (ISP), domain name, connection speed, IDD code, area code, weather station code, weather station name, mobile country code (MCC), mobile network code (MNC), mobile brand, elevation, and usage type by IP address. The library reads the geo location information from **IP2Location BIN data** file.
+
+Supported IPv4 and IPv6 address.
+
+For the methods to use IP2Location filter plugin with ELK (Elasticsearch, Logstash, and Kibana), please take a look on this [tutorial](https://www.ip2location.com/tutorials/how-to-use-ip2location-filter-plugin-with-elk).
+
+
+## Sample Output
+![Example of data](https://www.ip2location.com/images/tutorial/logstash-filter-ip2location-screenshot2.png)
+
+|Field|Description|
+|---|---|
+|ip2location.area_code|the varying length number assigned to geographic areas for call between cities|
+|ip2location.city|the city name|
+|ip2location.country_long|the country name based on ISO 3166|
+|ip2location.country_short|the two-character country code based on ISO 3166|
+|ip2location.domain|the Internet domain name associated to IP address range|
+|ip2location.elevation|the elevation|
+|ip2location.idd_code|the IDD prefix to call the city from another country|
+|ip2location.ip_address|the IP address|
+|ip2location.isp|the Internet Service Provider (ISP) name|
+|ip2location.latitude|the city latitude|
+|ip2location.longitude|the city longitude|
+|ip2location.mcc|the mobile country code|
+|ip2location.mnc|mobile network code|
+|ip2location.mobile_brand|the mobile brand|
+|ip2location.net_speed|the Internet Connection Speed (DIAL) DIAL-UP,(DSL) DSL/CABLE or(COMP) COMPANY|
+|ip2location.region|the region or state name|
+|ip2location.time_zone|the Time zone in UTC (Coordinated Universal Time)|
+|ip2location.usage_type|the usage type|
+|ip2location.weather_station_code|the special code to identify the nearest weather observation station|
+|ip2location.weather_station_name|the name of the nearest weather observation station|
+|ip2location.zip_code|the ZIP code|
+
+
+## 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 (Commercial): https://www.ip2location.com
+
+
+## Installation
+Install this plugin by the following code:
+```
+bin/logstash-plugin install logstash-filter-ip2location
+```
+
+
+## Config File Example
+```
+input {
+  beats {
+    port => "5043"
+  }
+}
+
+filter {
+  grok {
+    match => { "message" => "%{COMBINEDAPACHELOG}"}
+  }
+  ip2location {
+    source => "clientip"
+  }
+}
+
+
+output {
+  elasticsearch {
+    hosts => [ "localhost:9200" ]
+  }
+}
+```
+
+
+## IP2Location Filter Configuration
+|Setting|Input type|Required|
+|---|---|---|
+|source|string|Yes|
+|database|a valid filesystem path|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.
+
+
+## Support
+Email: support@ip2location.com
+
+URL: [https://www.ip2location.com](https://www.ip2location.com)

data/lib/logstash-filter-ip2location_jars.rb

@@ -1,3 +1,3 @@
-require 'jar_dependencies'
-require_jar('com.ip2location.ip2location', 'ip2location', '8.0.2')
-require_jar('org.logstash.filters', 'logstash-filter-ip2location', '1.0.1')
+require 'jar_dependencies'
+require_jar('com.ip2location.ip2location', 'ip2location', '8.0.3')
+require_jar('org.logstash.filters', 'logstash-filter-ip2location', '1.0.2')

data/lib/logstash/filters/ip2location.rb

@@ -1,54 +1,50 @@
-# 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
+# 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'
+
+  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)
+  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

@@ -1,25 +1,25 @@
-Gem::Specification.new do |s|
-
-  s.name            = 'logstash-filter-ip2location'
-  s.version         = '1.0.1'
-  s.licenses        = ['Apache License (2.0)']
-  s.summary         = "Logstash filter IP2Location"
-  s.description     = "IP2Location filter plugin for Logstash enables Logstash's users to add geolocation information such as country, state, city, latitude, longitude, ZIP code, time zone, ISP, domain name, connection speed, IDD code, area code, weather station code, weather station name, MNC, MCC, mobile brand, elevation and usage type by IP address."
-  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
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-filter-ip2location'
+  s.version         = '1.0.2'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "Logstash filter IP2Location"
+  s.description     = "IP2Location filter plugin for Logstash enables Logstash's users to add geolocation information such as country, state, city, latitude, longitude, ZIP code, time zone, ISP, domain name, connection speed, IDD code, area code, weather station code, weather station name, MNC, MCC, mobile brand, elevation and usage type by IP address."
+  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/spec_helper.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-ip2location
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - IP2Location
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-01 00:00:00.000000000 Z
+date: 2017-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core-plugin-api
@@ -57,8 +57,8 @@ files:
 - 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.1/logstash-filter-ip2location-1.0.1.jar
+- vendor/jar-dependencies/com/ip2location/ip2location/ip2location/8.0.3/ip2location-8.0.3.jar
+- vendor/jar-dependencies/org/logstash/filters/logstash-filter-ip2location/1.0.2/logstash-filter-ip2location-1.0.2.jar
 homepage: https://www.ip2location.com
 licenses:
 - Apache License (2.0)