logstash-filter-ip2proxy 2.2.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87fcbfb8ff8f30359feb847bf515396a8c5438af7a311396cb6dbc9b77bc474f
-  data.tar.gz: 15e4d42c56188f815de061d6cd7994ae0b6066dfa2243aa25aa70f58f6d787d6
+  metadata.gz: 481763ee546214cc2d2085deb0fd817309bc135fbbc37f5db35cd490b45ce387
+  data.tar.gz: 932e39ad6bac7204f978c4762552adfec12d84a0fe0596af10ea5543f0359382
 SHA512:
-  metadata.gz: 16b35d7dbd60b07518e8452584bba4925ab7596ce27a5203129ad31a045d5b43d15444da6f5d938bc7b761a2b9222c27e2e3420b4f112ff1ed120b27139033a5
-  data.tar.gz: 84d7b726a22040872e078a8b358bef9193d88f24f2e9541ef17e2e010e89d8e58138c2069a24b8d57552a7203455ba8e1b4cbc49b8e5564e4662150903e739f3
+  metadata.gz: 34827f591d9df130d9c548b48dfd15e0bf0b00035ed5f477b29c7632dd5f5ba2c7a3472684c2077ff73a8eede04acff9f0470e468054699d2cdafdda3225d7d5
+  data.tar.gz: 1e4cdebc1c1ea291abde014c010e8e26d6d873984f8e51bd3b4c98db0698230d571984b0b0724908f4bc32680a9688c0200ce98e5eaec8a91f24d45bccc14e20

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2021 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

@@ -3,6 +3,8 @@ This is IP2Proxy filter plugin for Logstash that enables Logstash's users to rev
 
 For the methods to use IP2Proxy filter plugin with Elastic Stack (Elasticsearch, Filebeat, Logstash, and Kibana), please take a look on this [tutorial](https://blog.ip2location.com/knowledge-base/how-to-use-ip2proxy-filter-plugin-with-elastic-stack).
 
+*Note: This plugin works in Logstash 7 and Logstash 8.*
+
 
 ## Dependencies (IP2PROXY BIN DATA FILE)
 This plugin requires IP2Proxy BIN data file to function. You may download the BIN data file at
@@ -47,9 +49,15 @@ 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 IP2Proxy 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

data/lib/logstash/filters/ip2proxy.rb

@@ -8,7 +8,7 @@ class LogStash::Filters::IP2Proxy < LogStash::Filters::Base
   config_name "ip2proxy"
 
   # The path to the IP2Proxy.BIN database file which Logstash should use.
-  # If not specified, this will default to the IP2PROXY-LITE-PX4.BIN database that embedded in the plugin.
+  # If not specified, this will default to the IP2PROXY-LITE-PX1.BIN database that embedded in the plugin.
   config :database, :validate => :path
 
   # The field containing the IP address.
@@ -18,6 +18,15 @@ class LogStash::Filters::IP2Proxy < LogStash::Filters::Base
   # The field used to define iplocation as target.
   config :target, :validate => :string, :default => 'ip2proxy'
 
+  # 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
 
@@ -32,8 +41,8 @@ class LogStash::Filters::IP2Proxy < LogStash::Filters::Base
     end
 
     @logger.info("Using ip2proxy database", :path => @database)
-    
-    @ip2proxyfilter = org.logstash.filters.IP2ProxyFilter.new(@source, @target, @database)
+
+    @ip2proxyfilter = org.logstash.filters.IP2ProxyFilter.new(@source, @target, @database, @use_memory_mapped, @hide_unsupported_fields)
   end
 
   public
@@ -41,11 +50,19 @@ class LogStash::Filters::IP2Proxy < LogStash::Filters::Base
     ip = event.get(@source)
 
     return unless filter?(event)
-    if value = Cache.find(event, ip, @ip2proxyfilter, @cache_size).get('ip2proxy')
-      event.set('ip2proxy', value)
-      filter_matched(event)
+    if @use_cache
+      if value = Cache.find(event, ip, @ip2proxyfilter, @cache_size).get('ip2proxy')
+        event.set('ip2proxy', value)
+        filter_matched(event)
+      else
+        tag_iplookup_unsuccessful(event)
+      end
     else
-      tag_iplookup_unsuccessful(event)
+      if @ip2proxyfilter.handleEvent(event)
+        filter_matched(event)
+      else
+        tag_iplookup_unsuccessful(event)
+      end
     end
   end
 

data/lib/logstash-filter-ip2proxy_jars.rb

@@ -1,3 +1,3 @@
 require 'jar_dependencies'
-require_jar('com.ip2proxy.ip2proxy', 'ip2proxy', '3.1.0')
-require_jar('org.logstash.filters', 'logstash-filter-ip2proxy', '2.2.0')
+require_jar('com.ip2proxy.ip2proxy', 'ip2proxy', '3.4.0')
+require_jar('org.logstash.filters', 'logstash-filter-ip2proxy', '2.3.1')

data/logstash-filter-ip2proxy.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-ip2proxy'
-  s.version         = '2.2.0'
+  s.version         = '2.3.1'
   s.licenses        = ['Apache-2.0']
   s.summary         = "Logstash filter IP2Proxy"
   s.description     = "IP2Proxy filter plugin for Logstash enables Logstash's users to reverse search of IP address to detect VPN servers, open proxies, web proxies, Tor exit nodes, search engine robots, data center ranges and residential proxies using IP2Proxy BIN database."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-ip2proxy
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.1
 platform: ruby
 authors:
 - IP2Location
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-07 00:00:00.000000000 Z
+date: 2022-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-core-plugin-api
@@ -56,15 +56,15 @@ files:
 - spec/filters/ip2proxy_spec.rb
 - spec/spec_helper.rb
 - vendor/IP2PROXY-LITE-PX1.BIN
-- vendor/jar-dependencies/com/ip2proxy/ip2proxy/ip2proxy/3.1.0/ip2proxy-3.1.0.jar
-- vendor/jar-dependencies/org/logstash/filters/logstash-filter-ip2proxy/2.2.0/logstash-filter-ip2proxy-2.2.0.jar
+- vendor/jar-dependencies/com/ip2proxy/ip2proxy/ip2proxy/3.4.0/ip2proxy-3.4.0.jar
+- vendor/jar-dependencies/org/logstash/filters/logstash-filter-ip2proxy/2.3.1/logstash-filter-ip2proxy-2.3.1.jar
 homepage: https://www.ip2location.com
 licenses:
 - Apache-2.0
 metadata:
   logstash_plugin: 'true'
   logstash_group: filter
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -80,9 +80,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 IP2Proxy
 test_files: