diff --git a/CHANGELOG.md b/CHANGELOG.md index 1101cc8..d032a1f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,6 @@ +## 7.0.1 + - [DOC] Add documentation for MaxMind database license change [#177](https://github.com/logstash-plugins/logstash-filter-geoip/pull/177) + ## 7.0.0 - Changed the plugin to use EULA GeoIP2 Database with auto-update [#176](https://github.com/logstash-plugins/logstash-filter-geoip/pull/176) Available in Logstash 7.13+ Elastic license @@ -39,11 +42,11 @@ - Add default_database_type configuration option to allow selection between the GeoLite2-City and GeoLote2-ASN databases. ## 4.2.0 - - Add support for GeoLite2-ASN database from Maxmind for ASN data. + - Add support for GeoLite2-ASN database from MaxMind for ASN data. - Update Java dependencies to 2.9.0 to support the new ASN database. ## 4.1.1 - - Add support for commercial databases from Maxmind. + - Add support for commercial databases from MaxMind. - Add ASN data support via GeoIP2-ISP database. ## 4.1.0 diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 1f17ec2..5152c8d 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -21,22 +21,41 @@ include::{include_path}/plugin_header.asciidoc[] ==== Description The GeoIP filter adds information about the geographical location of IP addresses, -based on data from the Maxmind GeoLite2 databases. +based on data from the MaxMind GeoLite2 databases. ==== Supported Databases -This plugin is bundled with https://dev.maxmind.com/geoip/geoip2/geolite2[GeoLite2] City database out of the box. From Maxmind's description -- +This plugin is bundled with https://dev.maxmind.com/geoip/geoip2/geolite2[GeoLite2] City database out of the box. From MaxMind's description -- "GeoLite2 databases are free IP geolocation databases comparable to, but less accurate than, MaxMind’s GeoIP2 databases". Please see GeoIP Lite2 license for more details. -https://www.maxmind.com/en/geoip2-databases[Commercial databases] from Maxmind are also supported in this plugin. +https://www.maxmind.com/en/geoip2-databases[Commercial databases] from MaxMind are also supported in this plugin. If you need to use databases other than the bundled GeoLite2 City, you can download them directly -from Maxmind's website and use the `database` option to specify their location. The GeoLite2 databases +from MaxMind's website and use the `database` option to specify their location. The GeoLite2 databases can be https://dev.maxmind.com/geoip/geoip2/geolite2[downloaded from here]. If you would like to get Autonomous System Number(ASN) information, you can use the GeoLite2-ASN database. +[id="plugins-{type}s-{plugin}-database_license"] +==== Database License + +https://www.maxmind.com[MaxMind] changed from releasing the GeoIP database under +a Creative Commons (CC) license to a proprietary end-user license agreement +(EULA). The MaxMind EULA requires Logstash to update the MaxMind database +within 30 days of a database update. If Logstash fails to download the database +for 30 days, it will stop the pipeline in order to maintain compliance. + +The GeoIP filter plugin can manage the database for users running the Logstash default +distribution, or you can manage +database updates on your own. The behavior is controlled by the `database` setting. +When you use the default `database` setting, the auto-update feature ensures that the plugin is +using the latest version of the database. +Otherwise, you are responsible for maintaining compliance. + +The Logstash open source distribution uses the MaxMind Creative Commons license +database by default. + ==== Details A `[geoip][location]` field is created if @@ -109,14 +128,16 @@ number of cache misses and waste memory. ===== `database` * Value type is <> - * There is no default value for this setting. + * 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. +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. -If not specified, this will default to the GeoLite2 City database that ships -with Logstash. +Database auto-update applies to default distribution. When `database` points to user's database path, +auto-update will be disabled. +See +<> for more information. [id="plugins-{type}s-{plugin}-default_database_type"] ===== `default_database_type` diff --git a/lib/logstash/filters/geoip.rb b/lib/logstash/filters/geoip.rb index 2b32e69..5c67379 100644 --- a/lib/logstash/filters/geoip.rb +++ b/lib/logstash/filters/geoip.rb @@ -5,7 +5,7 @@ # The GeoIP filter adds information about the geographical location of IP addresses, -# based on data from the Maxmind GeoLite2 database. +# based on data from the MaxMind GeoLite2 database. # # A `[geoip][location]` field is created if # the GeoIP lookup returns a latitude and longitude. The field is stored in diff --git a/logstash-filter-geoip.gemspec b/logstash-filter-geoip.gemspec index 7e131cb..1440347 100644 --- a/logstash-filter-geoip.gemspec +++ b/logstash-filter-geoip.gemspec @@ -1,7 +1,7 @@ Gem::Specification.new do |s| s.name = 'logstash-filter-geoip' - s.version = '7.0.0' + s.version = '7.0.1' 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"