Skip to content

Commit fc2df01

Browse files
authored
[DOC] Add documentation for database downloader setting (#210)
This commit added the documentation for the `xpack.geoip.downloader.enabled setting`, implemented on the Logstash issue elastic/logstash#14823.
1 parent 59a233f commit fc2df01

File tree

3 files changed

+16
-6
lines changed

3 files changed

+16
-6
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
## 7.2.13
2+
- [DOC] Add documentation for database auto-update configuration [#210](https://github.com/logstash-plugins/logstash-filter-geoip/pull/210)
3+
14
## 7.2.12
25
- [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)
36

docs/index.asciidoc

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ within 30 days of a database update.
4747

4848
The GeoIP filter plugin can manage the database for users running the Logstash default
4949
distribution, or you can manage
50-
database updates on your own. The behavior is controlled by the `database` setting.
51-
When you use the default `database` setting, the auto-update feature ensures that the plugin is
50+
database updates on your own. The behavior is controlled by the `database` setting and by the auto-update feature.
51+
When you use the default `database` setting and the auto-update feature is enabled, Logstash ensures that the plugin is
5252
using the latest version of the database.
5353
Otherwise, you are responsible for maintaining compliance.
5454

@@ -59,19 +59,26 @@ database by default.
5959
==== Database Auto-update
6060

6161
This plugin bundles Creative Commons (CC) license databases.
62-
Logstash checks for database updates every day. It downloads the latest and can replace the old database
62+
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
6363
while the plugin is running.
64-
After Logstash downloads EULA license databases, it will not fallback to CC license databases.
6564

66-
NOTE: If the database has never been updated successfully, as in air-gapped environments, Logstash can use CC license databases indefinitely.
65+
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.
6766

6867
After Logstash has switched to a EULA licensed database, the geoip filter will
6968
stop enriching events in order to maintain compliance if Logstash fails to
7069
check for database updates for 30 days.
7170
Events will be tagged with `_geoip_expired_database` tag to facilitate the handling of this situation.
7271

72+
NOTE: If the auto-update feature is enabled, Logstash upgrades from the CC database license to the EULA version on the first download.
73+
7374
TIP: When possible, allow Logstash to access the internet to download databases so that they are always up-to-date.
7475

76+
**Disable the auto-update feature**
77+
78+
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`.
79+
80+
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.
81+
7582
[id="plugins-{type}s-{plugin}-manage_update"]
7683
==== Manage your own database updates
7784

logstash-filter-geoip.gemspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Gem::Specification.new do |s|
22

33
s.name = 'logstash-filter-geoip'
4-
s.version = '7.2.12'
4+
s.version = '7.2.13'
55
s.licenses = ['Apache License (2.0)']
66
s.summary = "Adds geographical information about an IP address"
77
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"

0 commit comments

Comments
 (0)