logstash-filter-geoip 7.2.7-java → 7.2.11-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7eb0e71f8a7e34725b9ed42e5839ad7015fd53672802b01c92c5c33c3acb55ce
-  data.tar.gz: 71f871e60772fa2f21d5995ee93ac9b26d426463e4e87705e00028eb074bbe1a
+  metadata.gz: 4e1f0799be232e80ed3db8f0d31b4131c921d549183d2f47678af3fd9cdfd21f
+  data.tar.gz: e656dd5cd6440d13af48a7193f26962c4236267fcf2afd9bc0a9f4f8e8c5e3e5
 SHA512:
-  metadata.gz: 1e062cbeb38a866831d9dd9c359605d3f2b883819299bffbbb685af54fb9891f6ec3d4a81cebbad357a2a0c6cecffecdc2cf2284c00b8711c5dd6283c9620702
-  data.tar.gz: f83c4acfe3d702163d284cfae089d5deddcebe9754945dee22bf760e23d8b301f7dfcd2e4b98dfa509299f3f36993977cf94ee2d82df0fdf7fb9b05e3a5da7ed
+  metadata.gz: eadc947645031bd5539ac42e910da0c1230d2137936eec668f23da4e6de6e55b5ceaa2a6eb1cf0b7699a43d61c03c1e6df95b51681e61d3983471070d1cac9aa
+  data.tar.gz: 9a5ee36471512f5724ebc7013d3d21bce6d64db50ac6874f8c45d2e8a8facbad14a428e4ea2857cbeb20d438e363dbcdad79a6133b851c98c575a82da0e91a1f

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 7.2.11
+ - Improved compatibility with the Elastic Common Schema [#206](https://github.com/logstash-plugins/logstash-filter-geoip/pull/206)
+   - Added support for ECS's composite `region_iso_code` (`US-WA`), which _replaces_ the non-ECS `region_code` (`WA`) as a default field with City databases. To get the stand-alone `region_code` in ECS mode, you must include it in the `fields` directive. 
+   - [DOC] Improve ECS-related documentation
+
+## 7.2.10
+  - [DOC] Air-gapped environment requires both ASN and City databases [#204](https://github.com/logstash-plugins/logstash-filter-geoip/pull/204)
+
+## 7.2.9
+  - Fix: red CI in Logstash 8.0 [#201](https://github.com/logstash-plugins/logstash-filter-geoip/pull/201)
+  - Update Log4j dependency to 2.17.1
+
+## 7.2.8
+  - Update Log4j dependency to 2.17.0
+
 ## 7.2.7
   - Ensure java 8 compatibility [#197](https://github.com/logstash-plugins/logstash-filter-geoip/pull/197)
 

data/docs/index.asciidoc

@@ -86,10 +86,10 @@ a secure proxy. You can then specify the proxy endpoint URL in the
 If you work in air-gapped environment and can't update your databases from the Elastic endpoint,
 You can then download databases from MaxMind and bootstrap the service.
 
-. Download your `.mmdb` database files from the
+. Download both `GeoLite2-ASN.mmdb` and `GeoLite2-City.mmdb` database files from the
 http://dev.maxmind.com/geoip/geoip2/geolite2[MaxMind site].
 
-. Copy your database files to a single directory.
+. Copy both database files to a single directory.
 
 . https://www.elastic.co/downloads/elasticsearch[Download {es}].
 
@@ -169,14 +169,57 @@ Example response:
 }
 --------------------------------------------------
 
+[id="plugins-{type}s-{plugin}-field-mapping"]
+==== Field mapping
+
+When this plugin is run with <<plugins-{type}s-{plugin}-ecs_compatibility>> disabled, the MaxMind DB's fields are added directly to the <<plugins-{type}s-{plugin}-target>>.
+When ECS compatibility is enabled, the fields are structured to fit into an ECS shape.
+
+[cols="3,5,3"]
+|===========================
+| Database Field Name | ECS Field | Example
+
+| `ip`               | `[ip]`                     | `12.34.56.78`
+
+| `city_name`        | `[geo][city_name]`         | `Seattle`
+| `country_name`     | `[geo][country_name]`      | `United States`
+| `continent_code`   | `[geo][continent_code]`    | `NA`
+| `continent_name`   | `[geo][continent_name]`    | `North America`
+| `country_code2`    | `[geo][country_iso_code]`  | `US`
+| `country_code3`    | _N/A_                      | `US`
+
+                                                    _maintained for legacy
+                                                    support, but populated
+                                                    with 2-character country
+                                                    code_
+
+| `postal_code`      | `[geo][postal_code]`       | `98106`
+| `region_name`      | `[geo][region_name]`       | `Washington`
+| `region_code`      | `[geo][region_code]`       | `WA`
+| `region_iso_code`* | `[geo][region_iso_code]`   | `US-WA`
+| `timezone`         | `[geo][timezone]`          | `America/Los_Angeles`
+| `location`*        | `[geo][location]`          | `{"lat": 47.6062, "lon": -122.3321}"`
+| `latitude`         | `[geo][location][lat]`     | `47.6062`
+| `longitude`        | `[geo][location][lon]`     | `-122.3321`
+
+| `domain`           | `[domain]`                 | `example.com`
+
+| `asn`              | `[as][number]`             | `98765`
+| `as_org`           | `[as][organization][name]` | `Elastic, NV`
+
+| `isp`              | `[mmdb][isp]`              | `InterLink Supra LLC`
+| `dma_code`         | `[mmdb][dma_code]`         | `819`
+| `organization`     | `[mmdb][organization]`     | `Elastic, NV`
+|===========================
+
+NOTE: `*` indicates a composite field, which is only populated if GeoIP lookup result contains all components.
+
 ==== Details
 
-A `[geoip][location]` field is created if
-the GeoIP lookup returns a latitude and longitude. The field is stored in
-http://geojson.org/geojson-spec.html[GeoJSON] format. Additionally,
-the default Elasticsearch template provided with the
-{logstash-ref}/plugins-outputs-elasticsearch.html[elasticsearch output] maps
-the `[geoip][location]` field to an {ref}/geo-point.html[Elasticsearch Geo_point datatype].
+When using a City database, the enrichment is aborted if no latitude/longitude pair is available.
+
+The `location` field combines the latitude and longitude into a structure called https://datatracker.ietf.org/doc/html/rfc7946[GeoJSON].
+When you are using a default <<plugins-{type}s-{plugin}-target>>, the templates provided by the {logstash-ref}/plugins-outputs-elasticsearch.html[elasticsearch output] map the field to an {ref}/geo-point.html[Elasticsearch Geo_point datatype].
 
 As this field is a `geo_point` _and_ it is still valid GeoJSON, you get
 the awesomeness of Elasticsearch's geospatial query, facet and filter functions
@@ -242,16 +285,16 @@ number of cache misses and waste memory.
 ===== `database`
 
   * Value type is <<path,path>>
-  * If not specified, the database defaults to the GeoLite2 City database that ships with Logstash.
+  * If not specified, the database defaults to the `GeoLite2 City` database that ships with Logstash.
 
-The path to MaxMind's database file that Logstash should use. The default database is GeoLite2-City.
-GeoLite2-City, GeoLite2-Country, GeoLite2-ASN are the free databases from MaxMind that are supported.
-GeoIP2-City, GeoIP2-ISP, GeoIP2-Country are the commercial databases from MaxMind that are supported.
+The path to MaxMind's database file that Logstash should use.
+The default database is `GeoLite2-City`.
+This plugin supports several free databases (`GeoLite2-City`, `GeoLite2-Country`, `GeoLite2-ASN`)
+and a selection of commercially-licensed databases (`GeoIP2-City`, `GeoIP2-ISP`, `GeoIP2-Country`).
 
-Database auto-update applies to default distribution. When `database` points to user's database path,
-auto-update will be disabled.
-See
-<<plugins-{type}s-{plugin}-database_license,Database License>> for more information.
+Database auto-update applies to the default distribution.
+When `database` points to user's database path, auto-update is disabled.
+See <<plugins-{type}s-{plugin}-database_license,Database License>> for more information.
 
 [id="plugins-{type}s-{plugin}-default_database_type"]
 ===== `default_database_type`
@@ -270,13 +313,10 @@ This plugin now includes both the GeoLite2-City and GeoLite2-ASN databases.  If
 
 An array of geoip fields to be included in the event.
 
-Possible fields depend on the database type. By default, all geoip fields
-are included in the event.
+Possible fields depend on the database type.
+By default, all geoip fields from the relevant database are included in the event.
 
-For the built-in GeoLite2 City database, the following are available:
-`city_name`, `continent_code`, `country_code2`, `country_code3`, `country_name`,
-`dma_code`, `ip`, `latitude`, `location`, `longitude`, `postal_code`, `region_code`,
-`region_name` and `timezone`.
+For a complete list of available fields and how they map to an event's structure, see <<plugins-{type}s-{plugin}-field-mapping,field mapping>>.
 
 [id="plugins-{type}s-{plugin}-ecs_compatibility"]
 ===== `ecs_compatibility`
@@ -284,7 +324,7 @@ For the built-in GeoLite2 City database, the following are available:
 * Value type is <<string,string>>
 * Supported values are:
 ** `disabled`: unstructured geo data added at root level
-** `v1`, `v8`: uses fields that are compatible with Elastic Common Schema (for example, `[client][geo][country_name]`)
+** `v1`, `v8`: use fields that are compatible with Elastic Common Schema. Example: `[client][geo][country_name]`. See <<plugins-{type}s-{plugin}-field-mapping,field mapping>> for more info. 
 * Default value depends on which version of Logstash is running:
 ** When Logstash provides a `pipeline.ecs_compatibility` setting, its value is used as the default
 ** Otherwise, the default value is `disabled`.

data/logstash-filter-geoip.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-geoip'
-  s.version         = '7.2.7'
+  s.version         = '7.2.11'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Adds geographical information about an IP address"
   s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"

data/spec/filters/geoip_ecs_spec.rb

@@ -27,6 +27,10 @@ describe LogStash::Filters::GeoIP do
         end
 
         context "with city database" do
+          # example.com, has been static for 10+ years
+          # and has city-level details
+          let(:ip) { "93.184.216.34" }
+
           let(:options) { common_options }
 
           it "should return geo in target" do
@@ -36,19 +40,26 @@ describe LogStash::Filters::GeoIP do
             expect( event.get ecs_select[disabled: "[#{target}][country_code2]", v1: "[#{target}][geo][country_iso_code]"] ).to eq 'US'
             expect( event.get ecs_select[disabled: "[#{target}][country_name]", v1: "[#{target}][geo][country_name]"] ).to eq 'United States'
             expect( event.get ecs_select[disabled: "[#{target}][continent_code]", v1: "[#{target}][geo][continent_code]"] ).to eq 'NA'
-            expect( event.get ecs_select[disabled: "[#{target}][location][lat]", v1: "[#{target}][geo][location][lat]"] ).to eq 37.751
-            expect( event.get ecs_select[disabled: "[#{target}][location][lon]", v1: "[#{target}][geo][location][lon]"] ).to eq -97.822
+            expect( event.get ecs_select[disabled: "[#{target}][location][lat]", v1: "[#{target}][geo][location][lat]"] ).to eq 42.1596
+            expect( event.get ecs_select[disabled: "[#{target}][location][lon]", v1: "[#{target}][geo][location][lon]"] ).to eq -70.8217
+            expect( event.get ecs_select[disabled: "[#{target}][city_name]", v1: "[#{target}][geo][city_name]"] ).to eq 'Norwell'
+            expect( event.get ecs_select[disabled: "[#{target}][dma_code]", v1: "[#{target}][mmdb][dma_code]"] ).to eq 506
+            expect( event.get ecs_select[disabled: "[#{target}][region_name]", v1: "[#{target}][geo][region_name]"] ).to eq 'Massachusetts'
 
             if ecs_select.active_mode == :disabled
               expect( event.get "[#{target}][country_code3]" ).to eq 'US'
+              expect( event.get "[#{target}][region_code]" ).to eq 'MA'
+              expect( event.get "[#{target}][region_iso_code]" ).to be_nil
             else
               expect( event.get "[#{target}][geo][country_code3]" ).to be_nil
               expect( event.get "[#{target}][country_code3]" ).to be_nil
+              expect( event.get "[#{target}][geo][region_iso_code]" ).to eq 'US-MA'
+              expect( event.get "[#{target}][region_code]" ).to be_nil
             end
+            puts event.to_hash.inspect
           end
         end
 
-
         context "with ASN database" do
           let(:options) { common_options.merge({"database" => ASNDB}) }
 
@@ -59,27 +70,96 @@ describe LogStash::Filters::GeoIP do
             expect( event.get ecs_select[disabled: "[#{target}][asn]", v1: "[#{target}][as][number]"] ).to eq 15169
             expect( event.get ecs_select[disabled: "[#{target}][as_org]", v1: "[#{target}][as][organization][name]"] ).to eq "Google LLC"
           end
+
+          context "with customize fields" do
+            let(:fields) { ["AUTONOMOUS_SYSTEM_NUMBER"] }
+            let(:options) { common_options.merge({"database" => ASNDB, "fields" => fields}) }
+
+            it "should give asn field" do
+              plugin.filter(event)
+
+              expect( event.get ecs_select[disabled: "[#{target}][ip]", v1: "[#{target}][ip]"] ).to be_nil
+              expect( event.get ecs_select[disabled: "[#{target}][as_org]", v1: "[#{target}][as][organization][name]"] ).to be_nil
+
+              expect( event.get ecs_select[disabled: "[#{target}][asn]", v1: "[#{target}][as][number]"] ).to eq 15169
+            end
+          end
         end
 
         context "with customize fields" do
-          let(:fields) { ["continent_name", "timezone"] }
-          let(:options) { common_options.merge({"fields" => fields}) }
+          context "continent_name and timezone" do
+            let(:fields) { ["continent_name", "timezone"] }
+            let(:options) { common_options.merge({"fields" => fields}) }
 
-          it "should return fields" do
-            plugin.filter(event)
+            it "should return fields in UTF8" do
+              plugin.filter(event)
+
+              expect( event.get ecs_select[disabled: "[#{target}][ip]", v1: "[#{target}][ip]"] ).to be_nil
+              expect( event.get ecs_select[disabled: "[#{target}][country_code2]", v1: "[#{target}][geo][country_iso_code]"] ).to be_nil
+              expect( event.get ecs_select[disabled: "[#{target}][country_name]", v1: "[#{target}][geo][country_name]"] ).to be_nil
+              expect( event.get ecs_select[disabled: "[#{target}][continent_code]", v1: "[#{target}][geo][continent_code]"] ).to be_nil
+              expect( event.get ecs_select[disabled: "[#{target}][location][lat]", v1: "[#{target}][geo][location][lat]"] ).to be_nil
+              expect( event.get ecs_select[disabled: "[#{target}][location][lon]", v1: "[#{target}][geo][location][lon]"] ).to be_nil
+
+              continent_name = event.get ecs_select[disabled: "[#{target}][continent_name]", v1: "[#{target}][geo][continent_name]"]
+              timezone = event.get ecs_select[disabled: "[#{target}][timezone]", v1: "[#{target}][geo][timezone]"]
+              expect( continent_name ).to eq "North America"
+              expect( timezone ).to eq "America/Chicago"
+              expect( continent_name.encoding ).to eq Encoding::UTF_8
+              expect( timezone.encoding ).to eq Encoding::UTF_8
+            end
+          end
+
+          context "location" do
+            shared_examples "provide location, lat and lon" do
+              it "should return location, lat and lon" do
+                plugin.filter(event)
+
+                expect( event.get ecs_select[disabled: "[#{target}][ip]", v1: "[#{target}][ip]"] ).to be_nil
+                expect( event.get ecs_select[disabled: "[#{target}][country_code2]", v1: "[#{target}][geo][country_iso_code]"] ).to be_nil
+                expect( event.get ecs_select[disabled: "[#{target}][country_name]", v1: "[#{target}][geo][country_name]"] ).to be_nil
+                expect( event.get ecs_select[disabled: "[#{target}][continent_code]", v1: "[#{target}][geo][continent_code]"] ).to be_nil
+                expect( event.get ecs_select[disabled: "[#{target}][continent_name]", v1: "[#{target}][geo][continent_name]"] ).to be_nil
+                expect( event.get ecs_select[disabled: "[#{target}][timezone]", v1: "[#{target}][geo][timezone]"] ).to be_nil
+
+                expect( event.get ecs_select[disabled: "[#{target}][location][lat]", v1: "[#{target}][geo][location][lat]"] ).not_to be_nil
+                expect( event.get ecs_select[disabled: "[#{target}][location][lon]", v1: "[#{target}][geo][location][lon]"] ).not_to be_nil
+              end
+            end
 
-            expect( event.get ecs_select[disabled: "[#{target}][ip]", v1: "[#{target}][ip]"] ).to be_nil
-            expect( event.get ecs_select[disabled: "[#{target}][country_code2]", v1: "[#{target}][geo][country_iso_code]"] ).to be_nil
-            expect( event.get ecs_select[disabled: "[#{target}][country_name]", v1: "[#{target}][geo][country_name]"] ).to be_nil
-            expect( event.get ecs_select[disabled: "[#{target}][continent_code]", v1: "[#{target}][geo][continent_code]"] ).to be_nil
-            expect( event.get ecs_select[disabled: "[#{target}][location][lat]", v1: "[#{target}][geo][location][lat]"] ).to be_nil
-            expect( event.get ecs_select[disabled: "[#{target}][location][lon]", v1: "[#{target}][geo][location][lon]"] ).to be_nil
+            context "location and longitude" do
+              let(:fields) { ["location", "longitude"] }
+              let(:options) { common_options.merge({"fields" => fields}) }
+              it_behaves_like "provide location, lat and lon"
+            end
 
-            expect( event.get ecs_select[disabled: "[#{target}][continent_name]", v1: "[#{target}][geo][continent_name]"] ).to eq "North America"
-            expect( event.get ecs_select[disabled: "[#{target}][timezone]", v1: "[#{target}][geo][timezone]"] ).to eq "America/Chicago"
+            context "location and latitude" do
+              let(:fields) { ["location", "latitude"] }
+              let(:options) { common_options.merge({"fields" => fields}) }
+              it_behaves_like "provide location, lat and lon"
+            end
           end
-        end
 
+          context "continent_code and IP is IPv6 format" do
+            let(:ip) { "2607:f0d0:1002:51::4" }
+            let(:fields) { ["continent_code", "ip"] }
+            let(:options) { common_options.merge({"fields" => fields}) }
+
+            it "should return fields" do
+              plugin.filter(event)
+
+              expect( event.get ecs_select[disabled: "[#{target}][country_code2]", v1: "[#{target}][geo][country_iso_code]"] ).to be_nil
+              expect( event.get ecs_select[disabled: "[#{target}][country_name]", v1: "[#{target}][geo][country_name]"] ).to be_nil
+              expect( event.get ecs_select[disabled: "[#{target}][continent_name]", v1: "[#{target}][geo][continent_name]"] ).to be_nil
+              expect( event.get ecs_select[disabled: "[#{target}][location][lat]", v1: "[#{target}][geo][location][lat]"] ).to be_nil
+              expect( event.get ecs_select[disabled: "[#{target}][location][lon]", v1: "[#{target}][geo][location][lon]"] ).to be_nil
+              expect( event.get ecs_select[disabled: "[#{target}][timezone]", v1: "[#{target}][geo][timezone]"] ).to be_nil
+
+              expect( event.get ecs_select[disabled: "[#{target}][ip]", v1: "[#{target}][ip]"] ).to eq("2607:f0d0:1002:51:0:0:0:4")
+              expect( event.get ecs_select[disabled: "[#{target}][continent_code]", v1: "[#{target}][geo][continent_code]"] ).to eq("NA")
+            end
+          end
+        end
       end
     end
 

data/spec/filters/geoip_offline_spec.rb

@@ -6,78 +6,33 @@ require "logstash/filters/geoip"
 CITYDB = ::Dir.glob(::File.expand_path(::File.join("..", "..", "..", "vendor", "GeoLite2-City.mmdb"), __FILE__)).first
 ASNDB = ::Dir.glob(::File.expand_path(::File.join("..", "..", "..", "vendor", "GeoLite2-ASN.mmdb"), __FILE__)).first
 
-describe LogStash::Filters::GeoIP do
-  describe "defaults" do
-    config <<-CONFIG
-      filter {
-        geoip {
-          source => "ip"
-          database => "#{CITYDB}"
-        }
-      }
-    CONFIG
-
-    sample("ip" => "8.8.8.8") do
-      insist { subject }.include?("geoip")
-
-      expected_fields = %w(ip country_code2 country_code3 country_name
-                           continent_code latitude longitude location)
-      expected_fields.each do |f|
-        insist { subject.get("geoip") }.include?(f)
-      end
-    end
 
-    sample("ip" => "127.0.0.1") do
-      # assume geoip fails on localhost lookups
-      expect(subject.get("geoip")).to eq({})
+describe LogStash::Filters::GeoIP do
+  shared_examples "invalid empty IP" do
+    it "should not give target field" do
+      expect(event.get(target)).to be_nil
+      expect(event.get("tags")).to include("_geoip_lookup_failure")
     end
   end
 
-  describe "normal operations" do
-    config <<-CONFIG
-      filter {
-        geoip {
-          source => "ip"
-          database => "#{CITYDB}"
-          target => src_ip
-          add_tag => "done"
-        }
-      }
-    CONFIG
-
-    context "when specifying the target" do
-
-      sample("ip" => "8.8.8.8") do
-        expect(subject).to include("src_ip")
-
-        expected_fields = %w(ip country_code2 country_code3 country_name
-                             continent_code latitude longitude location)
-        expected_fields.each do |f|
-          expect(subject.get("src_ip")).to include(f)
-        end
-      end
-
-      sample("ip" => "127.0.0.1") do
-        # assume geoip fails on localhost lookups
-        expect(subject.get("src_ip")).to eq({})
-      end
-    end
-
-    context "when specifying add_tag" do
-      sample("ip" => "8.8.8.8") do
-        expect(subject.get("tags")).to include("done")
-      end
+  shared_examples "invalid string IP" do
+    it "should give empty hash in target field" do
+      expect(event.get(target)).to eq({})
+      expect(event.get("tags")).to include("_geoip_lookup_failure")
     end
   end
 
-  describe "source is derived from target" do
-    subject(:event) { LogStash::Event.new("target" => { "ip" => "173.9.34.107" } ) }
+  let(:target) { "server" }
+
+  describe "invalid IP" do
+    let(:ip) { "173.9.34.107" }
+    let(:event) { LogStash::Event.new("client" => { "ip" => ip } ) }
     let(:plugin) {
       LogStash::Filters::GeoIP.new(
-        "source" => "[target][ip]",
-        "target" => "target",
-        "fields" => [ "city_name", "region_name" ],
-        "add_tag" => "done", "database" => CITYDB
+        "source" => "[client][ip]",
+        "target" => target,
+        "fields" => %w[country_name continent_code],
+        "database" => CITYDB
       )
     }
 
@@ -86,200 +41,71 @@ describe LogStash::Filters::GeoIP do
       plugin.filter(event)
     end
 
-    context "when source field 'ip' is a subfield of 'target'" do
-
-      it "should preserve value in [target][ip]" do
-        expect(event.get("[target][ip]")).to eq("173.9.34.107")
+    context "when ip is 127.0.0.1" do
+      let(:ip) { "127.0.0.1" }
+      it "should give empty hash" do
+        expect(event.get(target)).to eq({})
       end
-
-      it "should set other subfields of 'target' properly" do
-        expect(event.get("target").to_hash.keys.sort).to eq(["city_name", "ip", "region_name"])
-        expect(event.get("[target][city_name]")).to eq("Malden")
-        expect(event.get("[target][region_name]")).to eq("Massachusetts")
-      end
-
     end
 
-  end
-
-  describe "correct encodings with default db" do
-    config <<-CONFIG
-      filter {
-        geoip {
-          source => "ip"
-          database => "#{CITYDB}"
-        }
-      }
-    CONFIG
-    expected_fields = %w(ip country_code2 country_code3 country_name
-                           continent_code region_name city_name postal_code
-                           dma_code timezone)
-
-    sample("ip" => "1.1.1.1") do
-      checked = 0
-      expected_fields.each do |f|
-        next unless subject.get("geoip")[f]
-        checked += 1
-        insist { subject.get("geoip")[f].encoding } == Encoding::UTF_8
-      end
-      insist { checked } > 0
+    context "when ip is empty string" do
+      let(:ip) { "" }
+      it_behaves_like "invalid empty IP"
     end
 
-    sample("ip" => "189.2.0.0") do
-      checked = 0
-      expected_fields.each do |f|
-        next unless subject.get("geoip")[f]
-        checked += 1
-        insist { subject.get("geoip")[f].encoding } == Encoding::UTF_8
-      end
-      insist { checked } > 0
+    context "when ip is space" do
+      let(:ip) { "      " }
+      it_behaves_like "invalid empty IP"
     end
 
-  end
-
-  describe "location field" do
-    shared_examples_for "an event with a [geoip][location] field" do
-      subject(:event) { LogStash::Event.new("message" => "8.8.8.8") }
-      let(:plugin) { LogStash::Filters::GeoIP.new("source" => "message", "fields" => fields, "database" => CITYDB) }
-
-      before do
-        plugin.register
-        plugin.filter(event)
-      end
-
-      it "should have a location field" do
-        expect(event.get("[geoip][location]")).not_to(be_nil)
-      end
+    context "when ip is dash" do
+      let(:ip) { "-" }
+      it_behaves_like "invalid string IP"
     end
 
-    context "when latitude field is excluded" do
-      let(:fields) { ["country_name", "location", "longitude"] }
-      it_behaves_like "an event with a [geoip][location] field"
+    context "when ip is N/A" do
+      let(:ip) { "N/A" }
+      it_behaves_like "invalid string IP"
     end
 
-    context "when longitude field is excluded" do
-      let(:fields) { ["country_name", "location", "latitude"] }
-      it_behaves_like "an event with a [geoip][location] field"
+    context "when ip is two ip comma separated" do
+      let(:ip) { "123.45.67.89,61.160.232.222" }
+      it_behaves_like "invalid string IP"
     end
 
-    context "when both latitude and longitude field are excluded" do
-      let(:fields) { ["country_name", "location"] }
-      it_behaves_like "an event with a [geoip][location] field"
+    context "when ip is not found in the DB" do
+      let(:ip) { "0.0.0.0" }
+      it_behaves_like "invalid string IP"
     end
-  end
-
-  describe "an invalid IP" do
-    config <<-CONFIG
-          filter {
-            geoip {
-              source => "ip"
-              database => "#{CITYDB}"
-            }
-          }
-        CONFIG
-    describe "should not raise an error" do
-      sample("ip" => "-") do
-        expect{ subject }.to_not raise_error
-      end
 
-      sample("ip" => "~") do
-        expect{ subject }.to_not raise_error
-      end
-
-      sample("ip" => "") do
-        expect{ subject }.to_not raise_error
-      end
-
-      sample("ip" => "      ") do
-        expect{ subject }.to_not raise_error
-      end
+    context "when ip is IPv6 format for localhost" do
+      let(:ip) { "::1" }
+      it_behaves_like "invalid string IP"
     end
+  end
 
-    describe "empty database path" do
-      let(:plugin) { LogStash::Filters::GeoIP.new("source" => "message") }
-      let(:event) { LogStash::Event.new("message" => "8.8.8.8") }
-
-      context "when database manager give nil database path" do
-        it "should tag expired database" do
-          expect(plugin).to receive(:select_database_path).and_return(nil)
-
-          plugin.register
-          plugin.filter(event)
-
-          expect(event.get("tags")).to include("_geoip_expired_database")
-        end
-      end
-    end
+  describe "database path is empty" do
+    let(:plugin) { LogStash::Filters::GeoIP.new("source" => "message", "target" => target) }
+    let(:event) { LogStash::Event.new("message" => "8.8.8.8") }
 
-    describe "filter method outcomes" do
-      let(:plugin) { LogStash::Filters::GeoIP.new("source" => "message", "add_tag" => "done", "database" => CITYDB) }
-      let(:event) { LogStash::Event.new("message" => ipstring) }
+    context "when database manager give nil database path" do
+      it "should tag expired database" do
+        expect(plugin).to receive(:select_database_path).and_return(nil)
 
-      before do
         plugin.register
         plugin.filter(event)
-      end
-
-      context "when the bad IP is N/A" do
-        # regression test for issue https://github.com/logstash-plugins/logstash-filter-geoip/issues/50
-        let(:ipstring) { "N/A" }
-
-        it "should set the target field to an empty hash" do
-          expect(event.get("geoip")).to eq({})
-        end
-
-        it "should add failure tags" do
-          expect(event.get("tags")).to include("_geoip_lookup_failure")
-        end
-      end
-
-      context "when the bad IP is two ip comma separated" do
-        # regression test for issue https://github.com/logstash-plugins/logstash-filter-geoip/issues/51
-        let(:ipstring) { "123.45.67.89,61.160.232.222" }
 
-        it "should set the target field to an empty hash" do
-          expect(event.get("geoip")).to eq({})
-        end
+        expect(event.get("tags")).to include("_geoip_expired_database")
       end
-
-      context "when a IP is not found in the DB" do
-        let(:ipstring) { "0.0.0.0" }
-
-        it "should set the target field to an empty hash" do
-          expect(event.get("geoip")).to eq({})
-          expect(event.get("tags")).to include("_geoip_lookup_failure")
-        end
-      end
-
-      context "when IP is IPv6 format for localhost" do
-        let(:ipstring) { "::1" }
-
-        it "should set the target field to an empty hash" do
-          expect(event.get("geoip")).to eq({})
-        end
-      end
-
-      context "when IP is valid IPv6 format" do
-        let(:ipstring) { "2607:f0d0:1002:51::4" }
-
-        it "should set the target fields properly" do
-          expect(event.get("geoip")).not_to be_empty
-          expect(event.get("geoip")["ip"]).to eq("2607:f0d0:1002:51:0:0:0:4")
-          expect(event.get("geoip").to_hash.keys.sort).to eq(
-              ["continent_code", "country_code2", "country_code3", "country_name", "ip", "latitude", "location", "longitude", "timezone"]
-                                                          )
-        end
-      end
-
     end
-
   end
 
-  describe "an invalid database" do
+  describe "database path is an invalid database file" do
     config <<-CONFIG
           filter {
             geoip {
               source => "ip"
+              target => "geo"
               database => "./Gemfile"
             }
           }
@@ -292,40 +118,4 @@ describe LogStash::Filters::GeoIP do
     end
   end
 
-  describe "GeoIP2-ASN database" do
-    config <<-CONFIG
-      filter {
-        geoip {
-          source => "ip"
-          database => "#{ASNDB}"
-          default_database_type => "ASN"
-        }
-      }
-    CONFIG
-
-    sample("ip" => "8.8.8.8") do
-      expect(subject.get("geoip")).not_to be_empty
-      expect(subject.get("geoip")["asn"]).to eq(15169)
-      expect(subject.get("geoip")["as_org"]).to eq("Google LLC")
-    end
-  end
-
-  describe "GeoIP2-ASN database with fields" do
-    config <<-CONFIG
-      filter {
-        geoip {
-          source => "ip"
-          database => "#{ASNDB}"
-          default_database_type => "ASN"
-          fields => [ "AUTONOMOUS_SYSTEM_NUMBER" ]
-        }
-      }
-    CONFIG
-
-    sample("ip" => "8.8.8.8") do
-      expect(subject.get("geoip")).not_to be_empty
-      expect(subject.get("geoip")["asn"]).to eq(15169)
-    end
-  end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-geoip
 version: !ruby/object:Gem::Version
-  version: 7.2.7
+  version: 7.2.11
 platform: java
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-13 00:00:00.000000000 Z
+date: 2022-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement