Geoip filter pluginedit

  • Plugin version: v7.2.3
  • Released on: 2021-09-29
  • Changelog

For other versions, see the Versioned plugin docs.

Getting Helpedit

For questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.

Descriptionedit

The GeoIP filter adds information about the geographical location of IP addresses, based on data from the MaxMind GeoLite2 databases.

Supported Databasesedit

This plugin is bundled with GeoLite2 City database out of the box. From MaxMind’s description — "GeoLite2 databases are free IP geolocation databases comparable to, but less accurate than, MaxMind’s GeoIP2 databases". Please see GeoIP Lite2 license for more details.

Commercial databases from MaxMind are also supported in this plugin.

If you need to use databases other than the bundled GeoLite2 City, you can download them directly from MaxMind’s website and use the database option to specify their location. The GeoLite2 databases can be downloaded from here.

If you would like to get Autonomous System Number(ASN) information, you can use the GeoLite2-ASN database.

Database Licenseedit

MaxMind changed from releasing the GeoIP database under a Creative Commons (CC) license to a proprietary end-user license agreement (EULA). The MaxMind EULA requires Logstash to update the MaxMind database 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 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.

Database Auto-updateedit

This plugin bundles Creative Commons (CC) license databases. In air-gapped environments, Logstash can use CC license databases indefinitely. 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.

If Logstash fails to download the database for 30 days, the geoip filter will stop enriching events in order to maintain compliance. Events will be tagged with _geoip_expired_database tag to facilitate the handling of this situation.

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

Manage your own database updatesedit

Use a proxy endpoint

If you can’t connect directly to the Elastic GeoIP endpoint, consider setting up a secure proxy. You can then specify the proxy endpoint URL in the xpack.geoip.download.endpoint setting in logstash.yml file.

Use a custom endpoint

If you work in air-gapped environment and can’t update your databases from the Elastic endpoint, you can bootstrap the environment as follows.

You can create a service that mimics the Elastic GeoIP endpoint. You can then get automatic updates from this service.

  1. Download your .mmdb database files from the MaxMind site.
  2. Copy your database files to a single directory.
  3. Download Elasticsearch.
  4. From your Elasticsearch directory, run:

    ./bin/elasticsearch-geoip -s my/database/dir
  5. Serve the static database files from your directory. For example, you can use Docker to serve the files from nginx server:

    docker run -p 8080:80 -v my/database/dir:/usr/share/nginx/html:ro nginx
  6. Specify the service’s endpoint URL using the xpack.geoip.download.endpoint=http://localhost:8080/overview.json setting in logstash.yml.

Database Metricsedit

You can monitor database status through the Node Stats API.

The following request returns a JSON document containing database manager stats, including:

  • database status and freshness

    • geoip_download_manager.database.*.status

      • init : initial CC database status
      • up_to_date : using up-to-date EULA database
      • to_be_expired : 25 days without calling service
      • expired : 30 days without calling service
    • fail_check_in_days : number of days Logstash fails to call service since the last success
  • info about download successes and failures

    • geoip_download_manager.download_stats.successes number of successful checks and downloads
    • geoip_download_manager.download_stats.failures number of failed check or download
    • geoip_download_manager.download_stats.status

      • updating : check and download at the moment
      • succeeded : last download succeed
      • failed : last download failed
curl -XGET 'localhost:9600/_node/stats/geoip_download_manager?pretty'

Example response:

{
  "geoip_download_manager" : {
    "database" : {
      "ASN" : {
        "status" : "up_to_date",
        "fail_check_in_days" : 0,
        "last_updated_at": "2021-06-21T16:06:54+02:00"
      },
      "City" : {
        "status" : "up_to_date",
        "fail_check_in_days" : 0,
        "last_updated_at": "2021-06-21T16:06:54+02:00"
      }
    },
    "download_stats" : {
      "successes" : 15,
      "failures" : 1,
      "last_checked_at" : "2021-06-21T16:07:03+02:00",
      "status" : "succeeded"
    }
  }
}

Detailsedit

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 datatype.

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).

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.

Versions 4.0.0 and later of the GeoIP filter use the MaxMind GeoLite2 database and support both IPv4 and IPv6 lookups. Versions prior to 4.0.0 use the legacy MaxMind GeoLite database and support IPv4 lookups only.

Geoip Filter Configuration Optionsedit

This plugin supports the following configuration options plus the Common Options described later.

Setting Input type Required

cache_size

number

No

database

a valid filesystem path

No

default_database_type

City or ASN

No

ecs_compatibility

string

No

fields

array

No

source

string

Yes

tag_on_failure

array

No

target

string

No

Also see Common Options for a list of options supported by all filter plugins.

 

cache_sizeedit

  • Value type is number
  • Default value is 1000

GeoIP lookup is surprisingly expensive. This filter uses an 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. Since the Geoip API upgraded to v2, there is not any eviction policy so far, if cache is full, no more record can be added. 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.

databaseedit

  • Value type is path
  • If not specified, the database defaults to the GeoLite2 City database that ships with Logstash.

The path to MaxMind’s database file that Logstash should use. The default database is GeoLite2-City. GeoLite2-City, GeoLite2-Country, GeoLite2-ASN are the free databases from MaxMind that are supported. GeoIP2-City, GeoIP2-ISP, GeoIP2-Country are the commercial databases from MaxMind that are supported.

Database auto-update applies to default distribution. When database points to user’s database path, auto-update will be disabled. See Database License for more information.

default_database_typeedit

This plugin now includes both the GeoLite2-City and GeoLite2-ASN databases. If database and default_database_type are unset, the GeoLite2-City database will be selected. To use the included GeoLite2-ASN database, set default_database_type to ASN.

  • Value type is string
  • The default value is City
  • The only acceptable values are City and ASN

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, location, longitude, postal_code, region_code, region_name and timezone.

ecs_compatibilityedit

  • Value type is string
  • Supported values are:

    • disabled: unstructured geo data added at root level
    • v1: uses fields that are compatible with Elastic Common Schema (for example, [client][geo][country_name])
  • Default value depends on which version of Logstash is running:

    • When Logstash provides a pipeline.ecs_compatibility setting, its value is used as the default
    • Otherwise, the default value is disabled.

Controls this plugin’s compatibility with the Elastic Common Schema (ECS). The value of this setting affects the default value of target.

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.

tag_on_failureedit

  • Value type is array
  • Default value is ["_geoip_lookup_failure"]

Tags the event on failure to look up geo information. This can be used in later analysis.

targetedit

  • This is an optional setting with condition.
  • Value type is string
  • Default value depends on whether ecs_compatibility is enabled:

    • ECS Compatibility disabled: geoip
    • ECS Compatibility enabled: If source is an ip sub-field, eg. [client][ip], target will automatically set to the parent field, in this example client, otherwise, target is a required setting

      • geo field is nested in [client][geo]
      • ECS compatible values are client, destination, host, observer, server, source

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.

Common Optionsedit

The following configuration options are supported by all filter plugins:

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).

enable_metricedit

  • Value type is boolean
  • Default value is true

Disable or enable metric logging for this specific plugin instance. By default we record all the metrics we can, but you can disable metrics collection for a specific plugin.

idedit

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

Add a unique ID to the plugin configuration. If no ID is specified, Logstash will generate one. It is strongly recommended to set this ID in your configuration. This is particularly useful when you have two or more plugins of the same type, for example, if you have 2 geoip filters. Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.

    filter {
      geoip {
        id => "ABC"
      }
    }

Variable substitution in the id field only supports environment variables and does not support the use of values from the secret store.

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. Fields names can be dynamic and include parts of the event using the %{field} 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.