-
Notifications
You must be signed in to change notification settings - Fork 80
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Doc] GeoIP database service #177
[Doc] GeoIP database service #177
Conversation
Hi Kaise. You did a nice job describing the licensing changes and behaviors. Thank you. I'm looking at the I considered something like this:
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 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added some suggested text inline for consideration and discussion
docs/index.asciidoc
Outdated
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall: There are some instances of "Maxmind" in some of the older sections. Will you please change them all to to "MaxMind" for accuracy?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👌
good catch on the default setting and default behavior. |
docs/index.asciidoc
Outdated
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Be more explicit here to emphasize no auto-update if database
is set
…geoip into geoip_database_license_doc
docs/index.asciidoc
Outdated
|
||
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, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left some comments inline. Otherwise, LGTM!
docs/index.asciidoc
Outdated
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] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
{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. |
docs/index.asciidoc
Outdated
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
auto-update will be disabled | |
auto-update will be disabled. |
This reverts commit 88754f4. # Conflicts: # CHANGELOG.md # logstash-filter-geoip.gemspec
This PR explains GeoIP database service auto-update feature
Related issues
elastic/logstash#12560