Skip to content

Commit

Permalink
[DOC] Add documentation for database downloader setting (#210)
Browse files Browse the repository at this point in the history
This commit added the documentation for the `xpack.geoip.downloader.enabled setting`, implemented on the Logstash issue elastic/logstash#14823.
  • Loading branch information
edmocosta authored Feb 7, 2023
1 parent 59a233f commit fc2df01
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 6 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
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
17 changes: 12 additions & 5 deletions docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ 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
database updates on your own. The behavior is controlled by the `database` setting and by the auto-update feature.
When you use the default `database` setting and the auto-update feature is enabled, Logstash ensures that the plugin is
using the latest version of the database.
Otherwise, you are responsible for maintaining compliance.

Expand All @@ -59,19 +59,26 @@ 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
If the auto-update feature is enabled in `logstash.yml`(as it is by default), Logstash checks for database updates every day. It downloads the latest and can replace the old database
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.
NOTE: If the auto-update feature is disabled or 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
check for database updates for 30 days.
Events will be tagged with `_geoip_expired_database` tag to facilitate the handling of this situation.

NOTE: If the auto-update feature is enabled, Logstash upgrades from the CC database license to the EULA version on the first download.

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 the auto-update feature is disabled, Logstash uses the Creative Commons (CC) license databases indefinitely, and any previously downloaded version of the EULA databases will be deleted.

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

Expand Down
2 changes: 1 addition & 1 deletion logstash-filter-geoip.gemspec
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

0 comments on commit fc2df01

Please sign in to comment.