[Doc] GeoIP database service #177

kaisecheng · 2021-02-19T20:33:03Z

This PR explains GeoIP database service auto-update feature

karenzone · 2021-03-09T17:05:58Z

Hi Kaise. You did a nice job describing the licensing changes and behaviors. Thank you.

I'm looking at the database option and considering how it impacts the database behavior. It's a bit confusing because we say there's no default setting, but yet we talk about default behavior.

I considered something like this:

  * Value type is <<path,path>>
  * There is no default value for this setting.
  * If not specified, the database defaults to the GeoLite2 City database that ships
  with Logstash.

Could we add a default setting that preserves the default behavior? I see it's expecting a path, so that might not work.

If there's not a more user-friendly solution, perhaps we could just delete the line that says, "There is no default value for this setting" and add the line "If not specified, the database defaults to the GeoLite2 City database that ships
with Logstash."

I have some other minor wording suggestions to share, too. But it seems to make sense to resolve this first. Please let me know what you think.

karenzone

I added some suggested text inline for consideration and discussion

karenzone · 2021-03-09T18:09:40Z

docs/index.asciidoc

+MaxMind changed from releasing the database under a CC license to a proprietary EULA,
+the EULA requires Logstash to update the MaxMind database for our users within 30 days of MaxMind updating their database.
+
+For Logstash default distribution user, the plugin manages database for you.
+With the default setting, an auto-update makes sure database run in the latest version.
+For any reason Logstash fails to download database for 30 days, Logstash will stop the plugin pipeline in order to be compliant.
+If user config `database` option to a path, the plugin does not check for database update, and thus user has to be compliant on their own.
+
+For Logstash open source user, the plugin use the Maxmind CC license database by default.


Suggested change

MaxMind changed from releasing the database under a CC license to a proprietary EULA,

the EULA requires Logstash to update the MaxMind database for our users within 30 days of MaxMind updating their database.

For Logstash default distribution user, the plugin manages database for you.

With the default setting, an auto-update makes sure database run in the latest version.

For any reason Logstash fails to download database for 30 days, Logstash will stop the plugin pipeline in order to be compliant.

If user config `database` option to a path, the plugin does not check for database update, and thus user has to be compliant on their own.

For Logstash open source user, the plugin use the Maxmind CC license database by default.

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.

Overall: There are some instances of "Maxmind" in some of the older sections. Will you please change them all to to "MaxMind" for accuracy?

kaisecheng · 2021-03-10T06:35:21Z

good catch on the default setting and default behavior. database is a path that varies on different systems, so you are right, there is no easy expression to show the default value. So, I took your suggestion.

kaisecheng · 2021-03-10T06:37:23Z

docs/index.asciidoc

-If not specified, this will default to the GeoLite2 City database that ships
-with Logstash.
+Database auto-update applies to default distribution. When `database` point to user's database path,
+auto-update will be disabled


Be more explicit here to emphasize no auto-update if database is set

…geoip into geoip_database_license_doc

karenzone · 2021-03-10T23:36:00Z

docs/index.asciidoc


-If not specified, this will default to the GeoLite2 City database that ships
-with Logstash.
+Database auto-update applies to default distribution. When `database` point to user's database path,


Suggested change

Database auto-update applies to default distribution. When `database` point to user's database path,

Database auto-update applies to default distribution. When `database` points to user's database path,

karenzone

Left some comments inline. Otherwise, LGTM!

karenzone · 2021-03-10T23:46:56Z

docs/index.asciidoc

-with Logstash.
+Database auto-update applies to default distribution. When `database` point to user's database path,
+auto-update will be disabled
+{logstash-ref}/plugins-filters-geoip.html#plugins-filters-geoip-database_license[see also database license]


Suggested change

{logstash-ref}/plugins-filters-geoip.html#plugins-filters-geoip-database_license[see also database license]

See

<<plugins-{type}s-{plugin}-database_license,Database License>> for more information.

karenzone · 2021-03-10T23:47:12Z

docs/index.asciidoc

-If not specified, this will default to the GeoLite2 City database that ships
-with Logstash.
+Database auto-update applies to default distribution. When `database` point to user's database path,
+auto-update will be disabled


Suggested change

auto-update will be disabled

auto-update will be disabled.

This reverts commit 88754f4. # Conflicts: # CHANGELOG.md # logstash-filter-geoip.gemspec

[Doc] GeoIP database service

bdeaae9

kaisecheng mentioned this pull request Feb 19, 2021

[META] GeoIP filter download service for MaxMind license change elastic/logstash#12560

Closed

18 tasks

kaisecheng added the docs label Feb 19, 2021

kaisecheng requested a review from karenzone March 4, 2021 15:34

karenzone reviewed Mar 9, 2021

View reviewed changes

update doc

849095a

kaisecheng commented Mar 10, 2021

View reviewed changes

kaisecheng requested a review from karenzone March 10, 2021 06:39

kaisecheng added 2 commits March 10, 2021 15:48

Merge branch 'master' of github.com:logstash-plugins/logstash-filter-…

fe2fac2

…geoip into geoip_database_license_doc

dump version

45053cc

karenzone reviewed Mar 10, 2021

View reviewed changes

karenzone approved these changes Mar 10, 2021

View reviewed changes

karenzone reviewed Mar 10, 2021

View reviewed changes

update doc

c46436e

kaisecheng merged commit 88754f4 into logstash-plugins:master Mar 11, 2021

kaisecheng added a commit to kaisecheng/logstash-filter-geoip that referenced this pull request May 14, 2021

Revert "[Doc] GeoIP database service (logstash-plugins#177)"

bee393e

This reverts commit 88754f4. # Conflicts: # CHANGELOG.md # logstash-filter-geoip.gemspec

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Doc] GeoIP database service #177

[Doc] GeoIP database service #177

kaisecheng commented Feb 19, 2021

karenzone commented Mar 9, 2021

karenzone left a comment

karenzone Mar 9, 2021

karenzone Mar 9, 2021

kaisecheng Mar 10, 2021

kaisecheng commented Mar 10, 2021

kaisecheng Mar 10, 2021

karenzone Mar 10, 2021

karenzone left a comment •

edited

Loading

karenzone Mar 10, 2021

karenzone Mar 10, 2021

-MaxMind changed from releasing the database under a CC license to a proprietary EULA,
-the EULA requires Logstash to update the MaxMind database for our users within 30 days of MaxMind updating their database.
-For Logstash default distribution user, the plugin manages database for you.
-With the default setting, an auto-update makes sure database run in the latest version.
-For any reason Logstash fails to download database for 30 days, Logstash will stop the plugin pipeline in order to be compliant.
-If user config `database` option to a path, the plugin does not check for database update, and thus user has to be compliant on their own.
-For Logstash open source user, the plugin use the Maxmind CC license database by default.
+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.

	Database auto-update applies to default distribution. When `database` point to user's database path,
	Database auto-update applies to default distribution. When `database` points to user's database path,

	{logstash-ref}/plugins-filters-geoip.html#plugins-filters-geoip-database_license[see also database license]
	See
	<<plugins-{type}s-{plugin}-database_license,Database License>> for more information.

[Doc] GeoIP database service #177

[Doc] GeoIP database service #177

Conversation

kaisecheng commented Feb 19, 2021

karenzone commented Mar 9, 2021

karenzone left a comment

Choose a reason for hiding this comment

karenzone Mar 9, 2021

Choose a reason for hiding this comment

karenzone Mar 9, 2021

Choose a reason for hiding this comment

kaisecheng Mar 10, 2021

Choose a reason for hiding this comment

kaisecheng commented Mar 10, 2021

kaisecheng Mar 10, 2021

Choose a reason for hiding this comment

karenzone Mar 10, 2021

Choose a reason for hiding this comment

karenzone left a comment • edited Loading

Choose a reason for hiding this comment

karenzone Mar 10, 2021

Choose a reason for hiding this comment

karenzone Mar 10, 2021

Choose a reason for hiding this comment

karenzone left a comment •

edited

Loading