Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[DOC] Add documentation for database downloader setting #210

Merged
merged 5 commits into from
Feb 7, 2023
Merged

[DOC] Add documentation for database downloader setting #210

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ef3cf5a
Added disable the auto-update feature section
edmocosta Dec 23, 2022
f893aec
Update changelog and bump version
edmocosta Dec 27, 2022
006196a
Changes to reflect the new behavior
edmocosta Jan 5, 2023
6df3326
Addressing PR suggestions
edmocosta Jan 19, 2023
2f8e518
Apply suggestions from code review
edmocosta Jan 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
## 7.2.13
- [DOC] Add documentation for database auto-update configuration [#210](https://github.com/logstash-plugins/logstash-filter-geoip/pull/210)

## 7.2.12
- [DOC] Add `http_proxy` environment variable for GeoIP service endpoint. The feature is included in 8.1.0, and was back-ported to 7.17.2 [#207](https://github.com/logstash-plugins/logstash-filter-geoip/pull/207)

Expand Down
16 changes: 9 additions & 7 deletions docs/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,9 @@ within 30 days of a database update.

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
the updates on your own, becoming also responsible for maintaining compliance. The behavior is controlled by the `database` setting.
edmocosta marked this conversation as resolved.
Show resolved Hide resolved
When you use the default `database` setting, and the auto-update feature is enabled, Logstash ensures that the plugin is
edmocosta marked this conversation as resolved.
Show resolved Hide resolved
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.
Expand All @@ -59,11 +58,8 @@ database by default.
==== Database Auto-update

This plugin bundles Creative Commons (CC) license databases.
Logstash checks for database updates every day. It downloads the latest and can replace the old database
By default, Logstash checks for database updates every day and upgrades from the CC database licence to the EULA version automatically. It downloads the latest version and replaces old databases
edmocosta marked this conversation as resolved.
Show resolved Hide resolved
while the plugin is running.
After Logstash downloads EULA license databases, it will not fallback to CC license databases.

NOTE: If the database has never been updated successfully, as in air-gapped environments, Logstash can use CC license databases indefinitely.

After Logstash has switched to a EULA licensed database, the geoip filter will
stop enriching events in order to maintain compliance if Logstash fails to
Expand All @@ -72,6 +68,12 @@ Events will be tagged with `_geoip_expired_database` tag to facilitate the handl

TIP: When possible, allow Logstash to access the internet to download databases so that they are always up-to-date.

**Disable the auto-update feature**

If you work in air-gapped environment and want to disable the database auto-update feature, set the `xpack.geoip.downloader.enabled` value to `false` in `logstash.yml`.

When disabled, Logstash uses the Creative Commons (CC) license databases indefinitely, and any previously downloaded version of the EULA databases will be deleted.
edmocosta marked this conversation as resolved.
Show resolved Hide resolved

[id="plugins-{type}s-{plugin}-manage_update"]
==== Manage your own database updates

Expand Down
2 changes: 1 addition & 1 deletion logstash-filter-geoip.gemspec
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Gem::Specification.new do |s|

s.name = 'logstash-filter-geoip'
s.version = '7.2.12'
s.version = '7.2.13'
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"
Expand Down