logstash-filter-ip2location 2.1.4 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6092b06bf0222a42d8d7d0f69fc5c993d32445a05788b01641c2ecfdf91d4a4d
-  data.tar.gz: 1c3ff2276bfd7bb9e7b8e10be986b4a83c2ede01292a9283ee76ee985e7977ca
+  metadata.gz: 5917b2904fe12390b69978d2975726352f40a0aea4ed70649caf4856da37616c
+  data.tar.gz: '086d0597aaaf1bfd9506a3167776c7fc5645cf018de52a25fb68dcd5b7b49249'
 SHA512:
-  metadata.gz: 548f85a563528773b819bd4d12bdb5fcea378dc9368bd67a3f93e1589cc0b46c4721b07a40120a042936a13732ab2c8e4ba8087c1abeabafb2eab62480f64f8e
-  data.tar.gz: 02cb99e4f03d015ce8c6706af01cedd4c3ba651f5e37e28548891f3214347e2fc1d95137256ee895ca6e82a36a24935d0d7f01942759991fcd6371c8799b836a
+  metadata.gz: 9651d9ebc865ae6afbd0741796e03a34fc7b1f2b38ada5dd3b4a1bfd8d3d72fd54ccd8a3319346a88916eb988a48afbd916527afe54afa170d943ea47b51848d
+  data.tar.gz: 3175868e1538e7135a256896ec0050555d922993dba58f80dde856a3c5badd58a00771339585917c43d227ad1c721c1fef5b1307eead32f6b7ae23dc6da9a71e

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2019 IP2Location.com
+Copyright (c) 2022 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,10 +1,12 @@
 # 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.
+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, usage type, address type and category 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 Elastic Stack (Elasticsearch, Filebeat, Logstash, and Kibana), please take a look on this [tutorial](https://www.ip2location.com/tutorials/how-to-use-ip2location-filter-plugin-with-elastic-stack).
 
+*Note: This plugin works in Logstash 7 and Logstash 8.*
+
 
 ## Dependencies (IP2LOCATION BIN DATA FILE)
 This plugin requires IP2Location BIN data file to function. You may download the BIN data file at
@@ -81,16 +83,22 @@ output {
 |source|string|Yes|
 |database|a valid filesystem path|No|
 |use_memory_mapped|boolean|No|
+|use_cache|boolean|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.
+* **hide_unsupported_fields** field is an optional setting that used to allow user to hide unsupported fields. Default value is false.
 
 
 ## Sample Output
 |Field|Description|
 |---|---|
+|ip2location.address_type|the IP address type (A-Anycast, B-Broadcast, M-Multicast & U-Unicast) of IP address or domain name|
 |ip2location.area_code|the varying length number assigned to geographic areas for call between cities|
+|ip2location.category|the IAB content taxonomy category of IP address or domain name|
 |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|
@@ -113,8 +121,6 @@ output {
 |ip2location.weather_station_name|the name of the nearest weather observation station|
 |ip2location.zip_code|the ZIP code|
 
-![Example of data](https://www.ip2location.com/assets/img/logstash-filter-ip2location-screenshot2.png)
-
 
 ## Support
 Email: support@ip2location.com

data/lib/logstash/filters/ip2location.rb

@@ -21,9 +21,15 @@ class LogStash::Filters::IP2Location < LogStash::Filters::Base
   # The field used to define iplocation as target.
   config :target, :validate => :string, :default => 'ip2location'
 
+  # The field used to allow user to enable the use of cache.
+  config :use_cache, :validate => :boolean, :default => true
+
   # The field used to allow user to enable the use of memory mapped file.
   config :use_memory_mapped, :validate => :boolean, :default => false
 
+  # The field used to allow user to hide unsupported fields.
+  config :hide_unsupported_fields, :validate => :boolean, :default => false
+
   # 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
 
@@ -39,7 +45,7 @@ class LogStash::Filters::IP2Location < LogStash::Filters::Base
 
     @logger.info("Using ip2location database", :path => @database)
 
-    @ip2locationfilter = org.logstash.filters.IP2LocationFilter.new(@source, @target, @database, @use_memory_mapped)
+    @ip2locationfilter = org.logstash.filters.IP2LocationFilter.new(@source, @target, @database, @use_memory_mapped, @hide_unsupported_fields)
   end
 
   public
@@ -47,11 +53,19 @@ class LogStash::Filters::IP2Location < LogStash::Filters::Base
     ip = event.get(@source)
 
     return unless filter?(event)
-    if value = Cache.find(event, ip, @ip2locationfilter, @cache_size).get('ip2location')
-      event.set('ip2location', value)
-      filter_matched(event)
+    if @use_cache
+      if value = Cache.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
 

data/lib/logstash-filter-ip2location_jars.rb

@@ -1,3 +1,3 @@
 require 'jar_dependencies'
-require_jar('com.ip2location.ip2location', 'ip2location', '8.3.0')
-require_jar('org.logstash.filters', 'logstash-filter-ip2location', '2.1.4')
+require_jar('com.ip2location.ip2location', 'ip2location', '8.9.1')
+require_jar('org.logstash.filters', 'logstash-filter-ip2location', '2.3.1')

data/logstash-filter-ip2location.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-ip2location'
-  s.version         = '2.1.4'
+  s.version         = '2.3.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."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-ip2location
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.3.1
 platform: ruby
 authors:
 - IP2Location
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-04 00:00:00.000000000 Z
+date: 2022-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core-plugin-api
@@ -57,15 +57,15 @@ files:
 - spec/filters/ip2location_spec.rb
 - spec/spec_helper.rb
 - vendor/IP2LOCATION-LITE-DB1.IPV6.BIN
-- vendor/jar-dependencies/com/ip2location/ip2location/ip2location/8.3.0/ip2location-8.3.0.jar
-- vendor/jar-dependencies/org/logstash/filters/logstash-filter-ip2location/2.1.4/logstash-filter-ip2location-2.1.4.jar
+- vendor/jar-dependencies/com/ip2location/ip2location/ip2location/8.9.1/ip2location-8.9.1.jar
+- vendor/jar-dependencies/org/logstash/filters/logstash-filter-ip2location/2.3.1/logstash-filter-ip2location-2.3.1.jar
 homepage: https://www.ip2location.com
 licenses:
 - Apache License (2.0)
 metadata:
   logstash_plugin: 'true'
   logstash_group: filter
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -81,9 +81,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: Logstash filter IP2Location
 test_files: