README.md

gogstash ip2location filter module

You need to download ip2location database manually and setup file path in config.

• Paying customers
• Free databases

The database will be reloaded when changed.

Synopsis

filter:
  - type: ip2location
    # (required) database file path
    db_path: "IP-COUNTRY.BIN"

    # (required) ip address field to parse
    ip_field: remote_addr

    # (optional) parsed ip2location info should be saved to field, default: ip2location
    key: ip2location

    # (optional) does not try to process private IP networks as they will fail, default: false
    skip_private: true

    # (optional) lets you specify your own definition for private IP addresses, both IPv4 and IPv6, default is private IP addresses
    private_net:
      - 10.0.0.0/8
      - 192.168.0.0/16

    # (optional) size of cache entries on IP addresses, so lookups don't go through the database, default is 100000
    cache_size: 100000

    # (optional) if true does not log lookup failures from the database, default is false
    quiet: true

Based on an input like this:

{
  "ip": "1.1.1.1"
}

You should get an output like this with a country database:

{
  "ip": "1.1.1.1",
  "ip2location": {
    "country_code": "US",
    "country_name": "United States of America"
  }
}