logstash-filter-ip2location 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4bb20dd4cbf1bc67c3d2b830dae8ea2b177f02f2de8b791a32518976a1ca1ef
-  data.tar.gz: 2f8d442c7fd1a9ce015787ba0007461bbeb111d23e31c97b21d7d081d81e3955
+  metadata.gz: 6fb5dfb5ad31e4cea95d7279c2ed8c2ef8c8dca01b930aa359bf0f6e12d33350
+  data.tar.gz: 369974ed9ef54551651e242c9f12c7743dc4830795a2bb51256d20f241af1ada
 SHA512:
-  metadata.gz: 07a89765b87e4118af8c712ccdc1f059a1264620969750acbe538581431f4603870693ec13326290c387223a2f578beab248f63e3eaedffb12363268340ff509
-  data.tar.gz: 37e61c13642940521c6ecb3d0bcd38ece0fc7316012e7f44d6df2c3958ae37b25c5411903a16c958f8d626e2961dd76b8ffb920d5b6878e67f2dda96fdc4fa06
+  metadata.gz: 24fb83c8fd03b6eadc27e7d98e70b2c77c986d1761370f8795b8d31c1d913b35f61d79b9f9bbfe68e25b55ba8052615e6dc35989d91ffaf382fe3cc6127aab34
+  data.tar.gz: 4ec49c950dc0f02d634b93b5750c00f0990b192f9956aecdf3679308b8b122a15e97fb731a17f6c7794b2038d23670f614c713cb7feb270edb6ec0d415bc07a7

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,4 +1,4 @@
-Copyright (c) 2023 IP2Location.com
+Copyright (c) 2024 IP2Location.com
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/README.md

@@ -1,5 +1,5 @@
 # IP2Location Filter Plugin
-This is IP2Location filter plugin for Logstash that enables Logstash's users to add geolocation information such as country, region, district, 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, usage type, address type, IAB category and ASN by IP address. The library reads the geo location information from **IP2Location BIN data** file.
+This is IP2Location filter plugin for Logstash that enables Logstash's users to add geolocation information such as country, region, district, 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, usage type, address type, IAB category and ASN by IP address. The library reads the geolocation information from **IP2Location BIN data** file and **IP2Location.io** data.
 
 Supported IPv4 and IPv6 address.
 
@@ -13,6 +13,9 @@ This plugin requires IP2Location BIN data file to function. You may download the
 * IP2Location LITE BIN Data (Free): https://lite.ip2location.com
 * IP2Location Commercial BIN Data (Commercial): https://www.ip2location.com
 
+## Dependencies (IP2LOCATION.IO DATA)
+This plugin requires API key to function. You may sign up for a free API key at https://www.ip2location.io/pricing.
+
 
 ## Installation
 Install this plugin by the following code:
@@ -38,7 +41,6 @@ filter {
   }
 }
 
-
 output {
   elasticsearch {
     hosts => [ "localhost:9200" ]
@@ -46,7 +48,6 @@ output {
 }
 ```
 
-
 ## Config File Example 2
 ```
 input {
@@ -68,6 +69,32 @@ filter {
   }
 }
 
+output {
+  elasticsearch {
+    hosts => [ "localhost:9200" ]
+  }
+}
+```
+
+## Config File Example 3 using IP2Location.io
+```
+input {
+  beats {
+    port => "5043"
+  }
+}
+
+filter {
+  grok {
+    match => { "message" => "%{COMBINEDAPACHELOG}"}
+  }
+  ip2location {
+    source => "[source][address]"
+    lookup_type => "ws"
+    api_key => "YOUR_API_KEY"
+  }
+}
+
 
 output {
   elasticsearch {
@@ -84,12 +111,16 @@ output {
 |database|a valid filesystem path|No|
 |use_memory_mapped|boolean|No|
 |use_cache|boolean|No|
+|lookup_type|string|No|
+|api_key|string|No|
 |hide_unsupported_fields|boolean|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.
 * **use_memory_mapped** field is an optional setting that used to allow user to enable the use of memory mapped file. Default value is false.
 * **use_cache** field is an optional setting that used to allow user to enable the use of cache. Default value is true.
+* **lookup_type** field is an optional setting that used to allow user to decide the lookup method either using IP2Location BIN database file(db) or IP2Location.io data(ws). Default value is db.
+* **api_key** field is an optional setting that used to allow user to set the API Key of the IP2Location.io lookup.
 * **hide_unsupported_fields** field is an optional setting that used to allow user to hide unsupported fields. Default value is false.
 
 

data/lib/logstash/filters/ip2location.rb

@@ -18,7 +18,7 @@ class LogStash::Filters::IP2Location < LogStash::Filters::Base
   # 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.
+  # The field used to define ip2location as target.
   config :target, :validate => :string, :default => 'ip2location'
 
   # The field used to allow user to enable the use of cache.
@@ -30,22 +30,34 @@ class LogStash::Filters::IP2Location < LogStash::Filters::Base
   # The field used to allow user to hide unsupported fields.
   config :hide_unsupported_fields, :validate => :boolean, :default => false
 
+  # The field used to define lookup type.
+  config :lookup_type, :validate => :string, :default => 'db'
+
+  # The field used to define the apikey of IP2location.io.
+  config :api_key, :validate => :string, :default => ''
+
   # The field used to define the size of the cache. It is not required and the default value is 10 000 
   config :cache_size, :validate => :number, :required => false, :default => 10_000
 
   public
   def register
-    if @database.nil?
-      @database = ::Dir.glob(::File.join(::File.expand_path("../../../vendor/", ::File.dirname(__FILE__)),"IP2LOCATION-LITE-DB1.IPV6.BIN")).first
-
-      if @database.nil? || !File.exists?(@database)
-        raise "You must specify 'database => ...' in your ip2location filter (I looked for '#{@database}')"
+    if @lookup_type == "ws"
+      @logger.info("Using IP2Location.io API")
+      if @api_key == ""
+        raise "An IP2Location.io API key is required. You may sign up for a free API key at https://www.ip2location.io/pricing."
+      end
+    else
+      if @database.nil?
+        @database = ::Dir.glob(::File.join(::File.expand_path("../../../vendor/", ::File.dirname(__FILE__)),"IP2LOCATION-LITE-DB1.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)
     end
 
-    @logger.info("Using ip2location database", :path => @database)
-
-    @ip2locationfilter = org.logstash.filters.IP2LocationFilter.new(@source, @target, @database, @use_memory_mapped, @hide_unsupported_fields)
+    @ip2locationfilter = org.logstash.filters.IP2LocationFilter.new(@source, @target, @database, @use_memory_mapped, @hide_unsupported_fields, @lookup_type, @api_key)
   end
 
   public
@@ -53,18 +65,26 @@ class LogStash::Filters::IP2Location < LogStash::Filters::Base
     ip = event.get(@source)
 
     return unless filter?(event)
-    if @use_cache
-      if value = IP2LocationCache.find(event, ip, @ip2locationfilter, @cache_size).get('ip2location')
-        event.set('ip2location', value)
+    if @lookup_type == "ws"
+      if @ip2locationfilter.handleEvent(event)
         filter_matched(event)
       else
         tag_iplookup_unsuccessful(event)
       end
     else
-      if @ip2locationfilter.handleEvent(event)
-        filter_matched(event)
+      if @use_cache
+        if value = IP2LocationCache.find(event, ip, @ip2locationfilter, @cache_size).get('ip2location')
+          event.set('ip2location', value)
+          filter_matched(event)
+        else
+          tag_iplookup_unsuccessful(event)
+        end
       else
-        tag_iplookup_unsuccessful(event)
+        if @ip2locationfilter.handleEvent(event)
+          filter_matched(event)
+        else
+          tag_iplookup_unsuccessful(event)
+        end
       end
     end
   end

data/lib/logstash-filter-ip2location_jars.rb

@@ -1,3 +1,4 @@
 require 'jar_dependencies'
 require_jar('com.ip2location.ip2location', 'ip2location', '8.11.0')
-require_jar('org.logstash.filters', 'logstash-filter-ip2location', '2.4.0')
+require_jar('com.google.gson', 'gson', '2.11.0')
+require_jar('org.logstash.filters', 'logstash-filter-ip2location', '2.5.0')

data/logstash-filter-ip2location.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-ip2location'
-  s.version         = '2.4.0'
+  s.version         = '2.5.0'
   s.licenses        = ['Apache-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, district, 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, usage type, address type, IAB category and ASN by IP address."

data/spec/filters/ip2location_spec.rb

@@ -1,32 +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-DB1.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
-
+# encoding: utf-8
+require_relative '../spec_helper'
+require "logstash/filters/ip2location"
+
+IP2LOCATIONDB = ::Dir.glob(::File.expand_path("../../vendor/", ::File.dirname(__FILE__))+"/IP2LOCATION-LITE-DB1.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

@@ -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: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - IP2Location
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-12 00:00:00.000000000 Z
+date: 2024-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core-plugin-api
@@ -57,8 +57,9 @@ files:
 - spec/filters/ip2location_spec.rb
 - spec/spec_helper.rb
 - vendor/IP2LOCATION-LITE-DB1.IPV6.BIN
+- vendor/jar-dependencies/com/google/gson/gson/2.11.0/gson-2.11.0.jar
 - vendor/jar-dependencies/com/ip2location/ip2location/ip2location/8.11.0/ip2location-8.11.0.jar
-- vendor/jar-dependencies/org/logstash/filters/logstash-filter-ip2location/2.4.0/logstash-filter-ip2location-2.4.0.jar
+- vendor/jar-dependencies/org/logstash/filters/logstash-filter-ip2location/2.5.0/logstash-filter-ip2location-2.5.0.jar
 homepage: https://www.ip2location.com
 licenses:
 - Apache-2.0
@@ -81,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: Logstash filter IP2Location