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.

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

Deprecate GeoIP support #1601

Merged
merged 1 commit into from
May 10, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions CHANGELOG.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ https://github.com/elastic/beats/compare/v5.0.0-alpha2...master[Check the HEAD d

*Affecting all Beats*

- The support for doing GeoIP lookups is deprecated and will be removed in version 6.0. {pull}1601[1601]

*Packetbeat*

*Topbeat*
Expand Down
7 changes: 0 additions & 7 deletions filebeat/filebeat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -417,13 +417,6 @@ output:
# default is the number of logical CPUs available in the system.
#max_procs:

# Configure local GeoIP database support.
# If no paths are not configured geoip is disabled.
#geoip:
#paths:
# - "/usr/share/GeoIP/GeoLiteCity.dat"
# - "/usr/local/var/GeoIP/GeoLiteCity.dat"


############################# Logging #########################################

Expand Down
3 changes: 2 additions & 1 deletion libbeat/common/geolite.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,10 @@ func LoadGeoIPData(config Geoip) *libgeo.GeoIP {
geoipPaths = *config.Paths
}
if len(geoipPaths) == 0 {
logp.Info("GeoIP disabled: No paths were set under shipper.geoip.paths")
// disabled
return nil
} else {
logp.Warn("GeoIP lookup support is deprecated and will be removed in version 6.0.")
}

// look for the first existing path
Expand Down
23 changes: 15 additions & 8 deletions libbeat/docs/shipperconfig.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,6 @@ refresh_topology_freq: 10
# refresh_topology_freq. The default is 15 seconds.
topology_expire: 15
# Configure local GeoIP database support.
# If no paths are not configured geoip is disabled.
#geoip:
#paths:
# - "/usr/share/GeoIP/GeoLiteCity.dat"
# - "/usr/local/var/GeoIP/GeoLiteCity.dat"
------------------------------------------------------------------------------

==== Top Level Options
Expand Down Expand Up @@ -192,14 +185,28 @@ default is the number of logical CPUs available in the system.

===== geoip.paths

This configuration option is currently used by Packetbeat only.
deprecated[5.0.0, Please use the https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest-geoip.html[Geoip processor in Ingest Node] or the https://www.elastic.co/guide/en/logstash/current/plugins-filters-geoip.html[Logstash GeoIP filter] instead]

This configuration option is currently used by Packetbeat only and it will be removed in version 6.0.

The paths to search for GeoIP databases. The Beat loads the first installed GeoIP database
that if finds. Then, for each transaction, the Beat exports the GeoIP location of the client.

The recommended values for geoip.paths are `/usr/share/GeoIP/GeoLiteCity.dat`
and `/usr/local/var/GeoIP/GeoLiteCity.dat`.

Example:

[source,yaml]
------------------------------------------------------------------------------
# Configure local GeoIP database support.
# If no paths are not configured geoip is disabled.
geoip:
paths:
- "/usr/share/GeoIP/GeoLiteCity.dat"
- "/usr/local/var/GeoIP/GeoLiteCity.dat"
------------------------------------------------------------------------------

*Important*: For GeoIP support to function correctly, the
https://dev.maxmind.com/geoip/legacy/geolite/[GeoLite City database] is required.

Expand Down
7 changes: 0 additions & 7 deletions libbeat/etc/libbeat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -224,13 +224,6 @@ output:
# default is the number of logical CPUs available in the system.
#max_procs:

# Configure local GeoIP database support.
# If no paths are not configured geoip is disabled.
#geoip:
#paths:
# - "/usr/share/GeoIP/GeoLiteCity.dat"
# - "/usr/local/var/GeoIP/GeoLiteCity.dat"


############################# Logging #########################################

Expand Down
7 changes: 0 additions & 7 deletions metricbeat/metricbeat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -308,13 +308,6 @@ output:
# default is the number of logical CPUs available in the system.
#max_procs:

# Configure local GeoIP database support.
# If no paths are not configured geoip is disabled.
#geoip:
#paths:
# - "/usr/share/GeoIP/GeoLiteCity.dat"
# - "/usr/local/var/GeoIP/GeoLiteCity.dat"


############################# Logging #########################################

Expand Down
7 changes: 0 additions & 7 deletions packetbeat/packetbeat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -401,13 +401,6 @@ output:
# default is the number of logical CPUs available in the system.
#max_procs:

# Configure local GeoIP database support.
# If no paths are not configured geoip is disabled.
#geoip:
#paths:
# - "/usr/share/GeoIP/GeoLiteCity.dat"
# - "/usr/local/var/GeoIP/GeoLiteCity.dat"


############################# Logging #########################################

Expand Down
7 changes: 0 additions & 7 deletions topbeat/topbeat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -250,13 +250,6 @@ output:
# default is the number of logical CPUs available in the system.
#max_procs:

# Configure local GeoIP database support.
# If no paths are not configured geoip is disabled.
#geoip:
#paths:
# - "/usr/share/GeoIP/GeoLiteCity.dat"
# - "/usr/local/var/GeoIP/GeoLiteCity.dat"


############################# Logging #########################################

Expand Down
7 changes: 0 additions & 7 deletions winlogbeat/winlogbeat.yml
Original file line number Diff line number Diff line change
Expand Up @@ -252,13 +252,6 @@ output:
# default is the number of logical CPUs available in the system.
#max_procs:

# Configure local GeoIP database support.
# If no paths are not configured geoip is disabled.
#geoip:
#paths:
# - "/usr/share/GeoIP/GeoLiteCity.dat"
# - "/usr/local/var/GeoIP/GeoLiteCity.dat"


############################# Logging #########################################

Expand Down