geoipedit

The GeoIP filter adds information about the geographical location of IP addresses, based on data from the Maxmind GeoLite2 City Database.

A [geoip][location] field is created if the GeoIP lookup returns a latitude and longitude. The field is stored in GeoJSON format. Additionally, the default Elasticsearch template provided with the elasticsearch output maps the [geoip][location] field to an Elasticsearch geo_point.

As this field is a geo_point and it is still valid GeoJSON, you get the awesomeness of Elasticsearch’s geospatial query, facet and filter functions and the flexibility of having GeoJSON for all other applications (like Kibana’s map visualization).

Note: This product includes GeoLite2 data created by MaxMind, available from http://www.maxmind.com. This database is licensed under Creative Commons Attribution-ShareAlike 4.0 International License

 

Synopsisedit

This plugin supports the following configuration options:

Required configuration options:

geoip {
    source => ...
}

Available configuration options:

Setting Input typeRequiredDefault value

add_field

hash

No

{}

add_tag

array

No

[]

database

a valid filesystem path

No

fields

array

No

lru_cache_size

number

No

1000

periodic_flush

boolean

No

false

remove_field

array

No

[]

remove_tag

array

No

[]

source

string

Yes

target

string

No

"geoip"

Detailsedit

 

add_fieldedit

  • Value type is hash
  • Default value is {}

If this filter is successful, add any arbitrary fields to this event. Field names can be dynamic and include parts of the event using the %{field}.

Example:

filter {
  geoip {
    add_field => { "foo_%{somefield}" => "Hello world, from %{host}" }
  }
}
# You can also add multiple fields at once:
filter {
  geoip {
    add_field => {
      "foo_%{somefield}" => "Hello world, from %{host}"
      "new_field" => "new_static_value"
    }
  }
}

If the event has field "somefield" == "hello" this filter, on success, would add field foo_hello if it is present, with the value above and the %{host} piece replaced with that value from the event. The second example would also add a hardcoded field.

add_tagedit

  • Value type is array
  • Default value is []

If this filter is successful, add arbitrary tags to the event. Tags can be dynamic and include parts of the event using the %{field} syntax.

Example:

filter {
  geoip {
    add_tag => [ "foo_%{somefield}" ]
  }
}
# You can also add multiple tags at once:
filter {
  geoip {
    add_tag => [ "foo_%{somefield}", "taggedy_tag"]
  }
}

If the event has field "somefield" == "hello" this filter, on success, would add a tag foo_hello (and the second example would of course add a taggedy_tag tag).

databaseedit

  • Value type is path
  • There is no default value for this setting.

Map of lookup caches, keyed by geoip_type The path to the GeoIP database file which Logstash should use. Country, City, ASN, ISP and organization databases are supported.

If not specified, this will default to the GeoLite2 City database that ships with Logstash. Up-to-date databases can be downloaded from here: http://dev.maxmind.com/geoip/geoip2/geolite2/

fieldsedit

  • Value type is array
  • There is no default value for this setting.

An array of geoip fields to be included in the event.

Possible fields depend on the database type. By default, all geoip fields are included in the event.

For the built-in GeoLite2 City database, the following are available: city_name, continent_code, country_code2, country_code3, country_name, dma_code, ip, latitude, longitude, postal_code, region_name and timezone.

lru_cache_sizeedit

  • Value type is number
  • Default value is 1000

GeoIP lookup is surprisingly expensive. This filter uses an LRU cache to take advantage of the fact that IPs agents are often found adjacent to one another in log files and rarely have a random distribution. The higher you set this the more likely an item is to be in the cache and the faster this filter will run. However, if you set this too high you can use more memory than desired.

Experiment with different values for this option to find the best performance for your dataset.

This MUST be set to a value > 0. There is really no reason to not want this behavior, the overhead is minimal and the speed gains are large.

It is important to note that this config value is global to the geoip_type. That is to say all instances of the geoip filter of the same geoip_type share the same cache. The last declared cache size will win. The reason for this is that there would be no benefit to having multiple caches for different instances at different points in the pipeline, that would just increase the number of cache misses and waste memory.

periodic_flushedit

  • Value type is boolean
  • Default value is false

Call the filter flush method at regular interval. Optional.

remove_fieldedit

  • Value type is array
  • Default value is []

If this filter is successful, remove arbitrary fields from this event. Example:

filter {
  geoip {
    remove_field => [ "foo_%{somefield}" ]
  }
}
# You can also remove multiple fields at once:
filter {
  geoip {
    remove_field => [ "foo_%{somefield}", "my_extraneous_field" ]
  }
}

If the event has field "somefield" == "hello" this filter, on success, would remove the field with name foo_hello if it is present. The second example would remove an additional, non-dynamic field.

remove_tagedit

  • Value type is array
  • Default value is []

If this filter is successful, remove arbitrary tags from the event. Tags can be dynamic and include parts of the event using the %{field} syntax.

Example:

filter {
  geoip {
    remove_tag => [ "foo_%{somefield}" ]
  }
}
# You can also remove multiple tags at once:
filter {
  geoip {
    remove_tag => [ "foo_%{somefield}", "sad_unwanted_tag"]
  }
}

If the event has field "somefield" == "hello" this filter, on success, would remove the tag foo_hello if it is present. The second example would remove a sad, unwanted tag as well.

sourceedit

  • This is a required setting.
  • Value type is string
  • There is no default value for this setting.

The field containing the IP address or hostname to map via geoip. If this field is an array, only the first value will be used.

targetedit

  • Value type is string
  • Default value is "geoip"

Specify the field into which Logstash should store the geoip data. This can be useful, for example, if you have src_ip and dst_ip fields and would like the GeoIP information of both IPs.

If you save the data to a target field other than geoip and want to use the geo_point related functions in Elasticsearch, you need to alter the template provided with the Elasticsearch output and configure the output to use the new template.

Even if you don’t use the geo_point mapping, the [target][location] field is still valid GeoJSON.