fluent-plugin-geoip 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f265530c6153294e8c0e5c35176a8e51f926708757622feee23177dbf388252
-  data.tar.gz: fd1b525e0e78306a8d87356531ddd5106de541b60e0521cad6e5cbeca15a84ff
+  metadata.gz: 3a88a41e91e927825689d485148e6d1369532f01f2bc3395d76204c98f02366f
+  data.tar.gz: 984c8db424d319565862de808844432366f38d00b2cd1c6b617d4ead0d77af8f
 SHA512:
-  metadata.gz: 32c7fb52de7c2a970fffe128e1c86cd327b8615e6e124d3019e50c74e4808674179de9a6761a4929375c8f159866364fe2e93e1042311e310bf52639b24058ca
-  data.tar.gz: d7f3f9f3cb1d7be3bf294bdc1b000c74d379e3454f64b188ab05a2804fc1d3379c775c758e2dab37e9f0477980f9466ba239542b868d7eaaf3b9a92ab50dcee6
+  metadata.gz: 0f48ad83f7b2ed7d47bd7822042e546cd1f0b6503d71c3175c07ccdc84fbfa21fdafc960187a40b5cd39d85636e256b09ba69ff69972ef5806bf3aa746d6ef82
+  data.tar.gz: 1ee9ce806e3bf90c1fac1657bc09ad1abfac5033ce6ac1f79b78fe6d374caab45b2fcb3eb3812ccae34124da2e861bd9e65f19dbac4574ae4d3db637bff3e567

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,19 @@
+#### Problem
+
+...
+
+#### Steps to replicate
+
+Provide example config and message
+
+#### Expected Behavior
+
+...
+
+#### Your environment
+
+* OS version
+* paste result of ``fluentd --version`` or ``td-agent --version``
+* plugin version
+  * paste boot log of fluentd or td-agent
+  * paste result of ``fluent-gem list``, ``td-agent-gem list`` or your Gemfile.lock

data/.travis.yml

@@ -4,7 +4,7 @@ services:
 
 env:
   global:
-    DOCKER_COMPOSE_VERSION: 1.8.1
+    DOCKER_COMPOSE_VERSION: 1.18.0
   matrix:
     - TARGET_RUBY_VERSION=2.1 BUNDLE_GEMFILE=/app/gemfiles/fluentd_v1.0_with_backport_dig.gemfile
     - TARGET_RUBY_VERSION=2.2 BUNDLE_GEMFILE=/app/gemfiles/fluentd_v1.0_with_backport_dig.gemfile

data/README.md

@@ -78,7 +78,7 @@ before use, install dependent library as:
 
 ```bash
 # for RHEL/CentOS
-$ sudo yum group install "Development Tools"
+$ sudo yum groupinstall "Development Tools"
 $ sudo yum install geoip-devel --enablerepo=epel
 
 # for Ubuntu/Debian
@@ -117,7 +117,7 @@ Note that filter version of geoip plugin does not have handling tag feature.
 
   # Specify one or more geoip lookup field which has ip address (default: host)
   # in the case of accessing nested value, delimit keys by dot like 'host.ip'.
-  geoip_lookup_key  host
+  geoip_lookup_keys host
 
   # Specify optional geoip database (using bundled GeoLiteCity databse by default)
   # geoip_database    "/path/to/your/GeoIPCity.dat"
@@ -149,7 +149,7 @@ Note that filter version of geoip plugin does not have handling tag feature.
 ```xml
 <filter access.apache>
   @type geoip
-  geoip_lookup_key  user1_host, user2_host
+  geoip_lookup_keys user1_host, user2_host
   <record>
     user1_city      ${city.names.en["user1_host"]}
     user2_city      ${city.names.en["user2_host"]}
@@ -164,7 +164,7 @@ It is a sample to get friendly geo point recdords for elasticsearch with Yajl (J
 ```
 <filter access.apache>
   @type                  geoip
-  geoip_lookup_key       host
+  geoip_lookup_keys      host
   <record>
     # lat lon as properties
     # ex. {"lat" => 37.4192008972168, "lon" => -122.05740356445312 }
@@ -189,7 +189,7 @@ On the case of using td-agent3 (v1-config), it have to quote `{ ... }` or `[ ...
 ```
 <filter access.apache>
   @type                  geoip
-  geoip_lookup_key       host
+  geoip_lookup_keys      host
   <record>
     location_properties  '{ "lat" : ${location.latitude["host"]}, "lon" : ${location.longitude["host"]} }'
     location_string      ${location.latitude["host"]},${location.longitude["host"]}
@@ -207,7 +207,7 @@ On the case of using td-agent3 (v1-config), it have to quote `{ ... }` or `[ ...
 
   # Specify one or more geoip lookup field which has ip address (default: host)
   # in the case of accessing nested value, delimit keys by dot like 'host.ip'.
-  geoip_lookup_key  host
+  geoip_lookup_keys host
 
   # Specify optional geoip database (using bundled GeoLiteCity databse by default)
   geoip_database    "/path/to/your/GeoIPCity.dat"
@@ -255,9 +255,10 @@ On the case of using td-agent3 (v1-config), it have to quote `{ ... }` or `[ ...
   @type forward
 </source>
 
+
 <filter test.geoip>
   @type    geoip
-  geoip_lookup_key  host
+  geoip_lookup_keys  host
   <record>
     city  ${city.names.en["host"]}
     lat   ${location.latitude["host"]}
@@ -305,7 +306,7 @@ $ bundle exec ruby urils/dump.rb geoip 66.102.3.80
   </store>
   <store>
     @type    geoip
-    geoip_lookup_key  host
+    geoip_lookup_keys  host
     <record>
       lat     ${location.latitude["host"]}
       lon     ${location.longitude["host"]}
@@ -438,12 +439,18 @@ Path to GeoIP database file.
 
 Path to GeoIP2 database file.
 
-**geoip_lookup_key** (string) (optional)
+**geoip_lookup_keys** (array) (optional)
 
-* Default value: `host`.
+* Default_value: `["host"]`
 
 Specify one or more geoip lookup field which has IP address.
 
+**geoip_lookup_key** (string) (optional) (deprecated)
+
+* Default value: `nil`.
+
+Use geoip_lookup_keys instead.
+
 **skip_adding_null_record** (bool) (optional)
 
 * Default value: `nil`
@@ -489,12 +496,18 @@ Path to GeoIP database file.
 
 Path to GeoIP2 database file.
 
-**geoip_lookup_key** (string) (optional)
+**geoip_lookup_keys** (array) (optional)
 
-* Default value: `host`.
+* Default value: `["host"]`
 
 Specify one or more geoip lookup field which has IP address.
 
+**geoip_lookup_key** (string) (optional) (deprecated)
+
+* Default value: `nil`.
+
+Use geoip_lookup_keys instead.
+
 **skip_adding_null_record** (bool) (optional)
 
 * Default value: `nil`

data/docker-compose.yml

@@ -1,31 +1,38 @@
-version: "2"
+version: "3"
 services:
+  test-ruby2.5:
+    build:
+      context: .
+      dockerfile: dockerfiles/Dockerfile-ruby2.5
+    env_file:
+      - env
+    command: tail -f /dev/null
   test-ruby2.4:
     build:
       context: .
       dockerfile: dockerfiles/Dockerfile-ruby2.4
     env_file:
       - env
-    command: ruby -run -e httpd .
+    command: tail -f /dev/null
   test-ruby2.3:
     build:
       context: .
       dockerfile: dockerfiles/Dockerfile-ruby2.3
     env_file:
       - env
-    command: ruby -run -e httpd .
+    command: tail -f /dev/null
   test-ruby2.2:
     build:
       context: .
       dockerfile: dockerfiles/Dockerfile-ruby2.2
     env_file:
       - env
-    command: ruby -run -e httpd .
+    command: tail -f /dev/null
   test-ruby2.1:
     build:
       context: .
       dockerfile: dockerfiles/Dockerfile-ruby2.1
     env_file:
       - env
-    command: ruby -run -e httpd .
+    command: tail -f /dev/null
 

data/dockerfiles/Dockerfile-ruby2.1

@@ -2,7 +2,7 @@ FROM ruby:2.1-alpine
 
 ENV BUNDLE_GEMFILE=$BUNDLE_GEMFILE
 
-RUN apk --no-cache --update add build-base ruby-dev libc6-compat libmaxminddb-dev geoip-dev git
+RUN apk --no-cache --update add build-base automake autoconf libtool ruby-dev libc6-compat geoip-dev git
 
 WORKDIR /app
 COPY . .

data/dockerfiles/Dockerfile-ruby2.2

@@ -2,7 +2,7 @@ FROM ruby:2.2-alpine
 
 ENV BUNDLE_GEMFILE=$BUNDLE_GEMFILE
 
-RUN apk --no-cache --update add build-base ruby-dev libc6-compat libmaxminddb-dev geoip-dev git
+RUN apk --no-cache --update add build-base automake autoconf libtool ruby-dev libc6-compat geoip-dev git
 
 WORKDIR /app
 COPY . .

data/dockerfiles/Dockerfile-ruby2.3

@@ -2,7 +2,7 @@ FROM ruby:2.3-alpine
 
 ENV BUNDLE_GEMFILE=$BUNDLE_GEMFILE
 
-RUN apk --no-cache --update add build-base ruby-dev libc6-compat libmaxminddb-dev geoip-dev git
+RUN apk --no-cache --update add build-base automake autoconf libtool ruby-dev libc6-compat geoip-dev git
 
 WORKDIR /app
 COPY . .

data/dockerfiles/Dockerfile-ruby2.4

@@ -2,7 +2,7 @@ FROM ruby:2.4-alpine
 
 ENV BUNDLE_GEMFILE=$BUNDLE_GEMFILE
 
-RUN apk --no-cache --update add build-base ruby-dev libc6-compat libmaxminddb-dev geoip-dev git
+RUN apk --no-cache --update add build-base automake autoconf libtool ruby-dev libc6-compat geoip-dev git
 
 WORKDIR /app
 COPY . .

data/dockerfiles/Dockerfile-ruby2.5

@@ -0,0 +1,8 @@
+FROM ruby:2.5-alpine
+
+ENV BUNDLE_GEMFILE=$BUNDLE_GEMFILE
+
+RUN apk --no-cache --update add build-base automake autoconf libtool ruby-dev libc6-compat geoip-dev git
+
+WORKDIR /app
+COPY . .

data/fluent-plugin-geoip.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-geoip"
-  spec.version       = "1.1.0"
+  spec.version       = "1.2.0"
   spec.authors       = ["Kentaro Yoshida"]
   spec.email         = ["y.ken.studio@gmail.com"]
   spec.summary       = %q{Fluentd Filter plugin to add information about geographical location of IP addresses with Maxmind GeoIP databases.}

data/lib/fluent/plugin/filter_geoip.rb

@@ -9,7 +9,8 @@ module Fluent::Plugin
 
     config_param :geoip_database, :string, default: File.expand_path('../../../data/GeoLiteCity.dat', __dir__)
     config_param :geoip2_database, :string, default: File.expand_path('../../../data/GeoLite2-City.mmdb', __dir__)
-    config_param :geoip_lookup_key, :string, default: 'host'
+    config_param :geoip_lookup_keys, :array, value_type: :string, default: ["host"]
+    config_param :geoip_lookup_key, :string, default: nil, deprecated: "Use geoip_lookup_keys instead"
     config_param :skip_adding_null_record, :bool, default: false
 
     config_set_default :@log_level, "warn"

data/lib/fluent/plugin/geoip.rb

@@ -24,25 +24,15 @@ module Fluent
 
     def initialize(plugin, conf)
       @map = {}
-      plugin.geoip_lookup_key = plugin.geoip_lookup_key.split(/\s*,\s*/)
-      @geoip_lookup_key = plugin.geoip_lookup_key
+      @geoip_lookup_keys = plugin.geoip_lookup_keys
+      if plugin.geoip_lookup_key
+        @geoip_lookup_keys = plugin.geoip_lookup_key.split(/\s*,\s*/)
+      end
       @skip_adding_null_record = plugin.skip_adding_null_record
       @log = plugin.log
 
-      # enable_key_* format (legacy format)
-      conf.keys.select{|k| k =~ /^enable_key_/}.each do |key|
-        geoip_key = key.sub('enable_key_','')
-        raise Fluent::ConfigError, "geoip: unsupported key #{geoip_key}" unless GEOIP_KEYS.include?(geoip_key)
-        @geoip_lookup_key.zip(conf[key].split(/\s*,\s*/)).each do |lookup_field,record_key|
-          if record_key.nil?
-            raise Fluent::ConfigError, "geoip: missing value found at '#{key} #{lookup_field}'"
-          end
-          @map[record_key] = "${#{geoip_key}['#{lookup_field}']}"
-        end
-      end
-      if conf.keys.select{|k| k =~ /^enable_key_/}.size > 0
-        log.warn "geoip: 'enable_key_*' config format is obsoleted. use <record></record> directive for now."
-        log.warn "geoip: for further details referable to https://github.com/y-ken/fluent-plugin-geoip"
+      if conf.keys.any? {|k| k =~ /^enable_key_/ }
+        raise Fluent::ConfigError, "geoip: 'enable_key_*' config format is obsoleted. use <record></record> directive instead."
       end
 
       # <record></record> directive
@@ -124,7 +114,7 @@ module Fluent
 
     def get_address(record)
       address = {}
-      @geoip_lookup_key.each do |field|
+      @geoip_lookup_keys.each do |field|
         address[field] = record[field] || record.dig(*field.split('.'))
       end
       address

data/lib/fluent/plugin/out_geoip.rb

@@ -8,7 +8,8 @@ class Fluent::Plugin::GeoipOutput < Fluent::Plugin::Output
 
   config_param :geoip_database, :string, default: File.expand_path('../../../data/GeoLiteCity.dat', __dir__)
   config_param :geoip2_database, :string, default: File.expand_path('../../../data/GeoLite2-City.mmdb', __dir__)
-  config_param :geoip_lookup_key, :string, default: 'host'
+  config_param :geoip_lookup_keys, :array, value_type: :string, default: ["host"]
+  config_param :geoip_lookup_key, :string, default: nil, deprecated: "Use geoip_lookup_keys instead"
   config_param :tag, :string, default: nil
   config_param :skip_adding_null_record, :bool, default: false
 

data/test/plugin/test_filter_geoip.rb

@@ -9,8 +9,10 @@ class GeoipFilterTest < Test::Unit::TestCase
   end
 
   CONFIG = %[
-    geoip_lookup_key  host
-    enable_key_city   geoip_city
+    geoip_lookup_keys  host
+    <record>
+      geoip_city ${city.names.en['host']}
+    </record>
   ]
 
   def create_driver(conf = CONFIG, syntax: :v1)
@@ -44,42 +46,29 @@ class GeoipFilterTest < Test::Unit::TestCase
       }
     end
 
-    test "missing required parameters" do
+    test "obsoleted configuration" do
       assert_raise(Fluent::ConfigError) {
-        create_driver('enable_key_cities')
+        create_driver('enable_key_city geoip_city')
       }
     end
 
-    test "minimum" do
-      d = create_driver %[
-        enable_key_city   geoip_city
-      ]
-      assert_equal 'geoip_city', d.instance.config['enable_key_city']
-    end
-
-    test "multiple key config" do
-      d = create_driver %[
-        geoip_lookup_key  from.ip, to.ip
-        enable_key_city   from_city, to_city
+    test "deprecated configuration geoip_lookup_key" do
+      conf = %[
+        geoip_lookup_key  host,ip
+        <record>
+          geoip_city ${city['host']}
+        </record>
+        tag               geoip.${tag[1]}
       ]
-      assert_equal 'from_city, to_city', d.instance.config['enable_key_city']
-    end
-
-    test "multiple key config (bad configure)" do
-      assert_raise(Fluent::ConfigError) {
-        create_driver %[
-          geoip_lookup_key  from.ip, to.ip
-          enable_key_city   from_city
-          enable_key_region from_region
-        ]
-      }
+      d = create_driver(conf)
+      assert_equal(["host", "ip"],
+                   d.instance.instance_variable_get(:@geoip).instance_variable_get(:@geoip_lookup_keys))
     end
 
     test "invalid json structure w/ Ruby hash like" do
-
       assert_raise(Fluent::ConfigParseError) {
         create_driver %[
-          geoip_lookup_key  host
+          geoip_lookup_keys host
           <record>
             invalid_json    {"foo" => 123}
           </record>
@@ -90,7 +79,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     test "invalid json structure w/ unquoted string literal" do
       assert_raise(Fluent::ConfigParseError) {
         create_driver %[
-          geoip_lookup_key  host
+          geoip_lookup_keys host
           <record>
             invalid_json    {"foo" : string, "bar" : 123}
           </record>
@@ -139,7 +128,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_with_dot_key
       config = %[
         backend_library   geoip2_c
-        geoip_lookup_key  ip.origin, ip.dest
+        geoip_lookup_keys ip.origin, ip.dest
         <record>
           origin_country  ${country.iso_code['ip.origin']}
           dest_country    ${country.iso_code['ip.dest']}
@@ -159,7 +148,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_with_unknown_address
       config = %[
         backend_library   geoip2_c
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           geoip_city      ${city.names.en['host']}
           geopoint        [${location.longitude['host']}, ${location.latitude['host']}]
@@ -182,7 +171,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_with_skip_unknown_address
       config = %[
         backend_library   geoip2_c
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           geoip_city      ${city.names.en['host']}
           geopoint        [${location.longitude['host']}, ${location.latitude['host']}]
@@ -208,7 +197,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_record_directive
       config = %[
         backend_library   geoip2_c
-        geoip_lookup_key  from.ip
+        geoip_lookup_keys from.ip
         <record>
           from_city       ${city.names.en['from.ip']}
           from_country    ${country.names.en['from.ip']}
@@ -275,7 +264,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_record_directive_multiple_record
       config = %[
         backend_library   geoip2_c
-        geoip_lookup_key  from.ip, to.ip
+        geoip_lookup_keys from.ip, to.ip
         <record>
           from_city       ${city.names.en['from.ip']}
           to_city         ${city.names.en['to.ip']}
@@ -314,7 +303,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def config_quoted_record
       %[
         backend_library   geoip2_c
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           location_properties  '{ "country_code" : "${country.iso_code["host"]}", "lat": ${location.latitude["host"]}, "lon": ${location.longitude["host"]} }'
           location_string      ${location.latitude['host']},${location.longitude['host']}
@@ -375,7 +364,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_multiline_v1_config
       config = %[
         backend_library   geoip2_c
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           location_properties  {
             "city": "${city.names.en['host']}",
@@ -406,7 +395,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_when_latitude_longitude_is_nil
       config = %[
         backend_library   geoip2_c
-        geoip_lookup_key  host
+        geoip_lookup_keys  host
         <record>
           latitude  ${location.latitude['host']}
           longitude ${location.longitude['host']}
@@ -434,7 +423,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_with_dot_key
       config = %[
         backend_library   geoip2_compat
-        geoip_lookup_key  ip.origin, ip.dest
+        geoip_lookup_keys ip.origin, ip.dest
         <record>
           origin_country  ${country_code['ip.origin']}
           dest_country    ${country_code['ip.dest']}
@@ -454,7 +443,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_with_unknown_address
       config = %[
         backend_library   geoip2_compat
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           geoip_city      ${city['host']}
           geopoint        [${longitude['host']}, ${latitude['host']}]
@@ -477,7 +466,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_with_skip_unknown_address
       config = %[
         backend_library   geoip2_compat
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           geoip_city      ${city['host']}
           geopoint        [${longitude['host']}, ${latitude['host']}]
@@ -503,7 +492,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_record_directive
       config = %[
         backend_library   geoip2_compat
-        geoip_lookup_key  from.ip
+        geoip_lookup_keys from.ip
         <record>
           from_city       ${city['from.ip']}
           from_country    ${country_name['from.ip']}
@@ -570,7 +559,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_record_directive_multiple_record
       config = %[
         backend_library   geoip2_compat
-        geoip_lookup_key  from.ip, to.ip
+        geoip_lookup_keys from.ip, to.ip
         <record>
           from_city       ${city['from.ip']}
           to_city         ${city['to.ip']}
@@ -609,7 +598,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def config_quoted_record
       %[
         backend_library   geoip2_compat
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           location_properties  '{ "country_code" : "${country_code["host"]}", "lat": ${latitude["host"]}, "lon": ${longitude["host"]} }'
           location_string      ${latitude['host']},${longitude['host']}
@@ -670,7 +659,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_multiline_v1_config
       config = %[
         backend_library   geoip2_compat
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           location_properties  {
             "city": "${city['host']}",
@@ -701,7 +690,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_when_latitude_longitude_is_nil
       config = %[
         backend_library   geoip2_compat
-        geoip_lookup_key  host
+        geoip_lookup_keys  host
         <record>
           latitude  ${latitude['host']}
           longitude ${longitude['host']}
@@ -729,8 +718,10 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter
       config = %[
         backend_library geoip
-        geoip_lookup_key  host
-        enable_key_city   geoip_city
+        geoip_lookup_keys  host
+        <record>
+          geoip_city ${city['host']}
+        </record>
       ]
       messages = [
         {'host' => '66.102.3.80', 'message' => 'valid ip'},
@@ -747,7 +738,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_with_dot_key
       config = %[
         backend_library geoip
-        geoip_lookup_key  ip.origin, ip.dest
+        geoip_lookup_keys ip.origin, ip.dest
         <record>
           origin_country  ${country_code['ip.origin']}
           dest_country    ${country_code['ip.dest']}
@@ -767,8 +758,10 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_nested_attr
       config = %[
         backend_library geoip
-        geoip_lookup_key  host.ip
-        enable_key_city   geoip_city
+        geoip_lookup_keys  host.ip
+        <record>
+          geoip_city ${city['host.ip']}
+        </record>
       ]
       messages = [
         {'host' => {'ip' => '66.102.3.80'}, 'message' => 'valid ip'},
@@ -785,7 +778,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_with_unknown_address
       config = %[
         backend_library geoip
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           geoip_city      ${city['host']}
           geopoint        [${longitude['host']}, ${latitude['host']}]
@@ -808,7 +801,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_with_skip_unknown_address
       config = %[
         backend_library geoip
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           geoip_city      ${city['host']}
           geopoint        [${longitude['host']}, ${latitude['host']}]
@@ -834,8 +827,11 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_multiple_key
       config = %[
         backend_library geoip
-        geoip_lookup_key  from.ip, to.ip
-        enable_key_city   from_city, to_city
+        geoip_lookup_keys  from.ip, to.ip
+        <record>
+          from_city ${city['from.ip']}
+          to_city   ${city['to.ip']}
+        </record>
       ]
       messages = [
         {'from' => {'ip' => '66.102.3.80'}, 'to' => {'ip' => '125.54.15.42'}},
@@ -853,9 +849,13 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_multiple_key_multiple_record
       config = %[
         backend_library geoip
-        geoip_lookup_key  from.ip, to.ip
-        enable_key_city   from_city, to_city
-        enable_key_country_name from_country, to_country
+        geoip_lookup_keys  from.ip, to.ip
+        <record>
+          from_city    ${city['from.ip']}
+          from_country ${country_name['from.ip']}
+          to_city      ${city['to.ip']}
+          to_country   ${country_name['to.ip']}
+        </record>
       ]
       messages = [
         {'from' => {'ip' => '66.102.3.80'}, 'to' => {'ip' => '125.54.15.42'}},
@@ -893,7 +893,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_record_directive
       config = %[
         backend_library geoip
-        geoip_lookup_key  from.ip
+        geoip_lookup_keys from.ip
         <record>
           from_city       ${city['from.ip']}
           from_country    ${country_name['from.ip']}
@@ -960,7 +960,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_record_directive_multiple_record
       config = %[
         backend_library geoip
-        geoip_lookup_key  from.ip, to.ip
+        geoip_lookup_keys from.ip, to.ip
         <record>
           from_city       ${city['from.ip']}
           to_city         ${city['to.ip']}
@@ -999,7 +999,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def config_quoted_record
       %[
         backend_library geoip
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           location_properties  '{ "country_code" : "${country_code["host"]}", "lat": ${latitude["host"]}, "lon": ${longitude["host"]} }'
           location_string      ${latitude['host']},${longitude['host']}
@@ -1060,7 +1060,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_multiline_v1_config
       config = %[
         backend_library geoip
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           location_properties  {
             "city": "${city['host']}",
@@ -1091,7 +1091,7 @@ class GeoipFilterTest < Test::Unit::TestCase
     def test_filter_when_latitude_longitude_is_nil
       config = %[
         backend_library   geoip
-        geoip_lookup_key  host
+        geoip_lookup_keys  host
         <record>
           latitude  ${latitude['host']}
           longitude ${longitude['host']}

data/test/plugin/test_out_geoip.rb

@@ -8,8 +8,10 @@ class GeoipOutputTest < Test::Unit::TestCase
   end
 
   CONFIG = %[
-    geoip_lookup_key  host
-    enable_key_city   geoip_city
+    geoip_lookup_keys  host
+    <record>
+      geoip_city ${city['host']}
+    </record>
     tag               geoip.${tag[1]}
   ]
 
@@ -24,50 +26,29 @@ class GeoipOutputTest < Test::Unit::TestCase
       end
     end
 
-    test "missing required parameters" do
+    test "obsoleted configuration" do
       assert_raise(Fluent::ConfigError) {
-        create_driver('enable_key_cities')
+        create_driver('enable_key_city geoip_city')
       }
     end
 
-    test "minimum" do
-      d = create_driver %[
-        enable_key_city   geoip_city
-        tag               geoip.${tag[1]}
-      ]
-      assert_equal 'geoip_city', d.instance.config['enable_key_city']
-    end
-
-    test "invalid key name" do
-      assert_raise(Fluent::ConfigError.new("geoip: unsupported key cities")) do
-        create_driver('enable_key_cities')
-      end
-    end
-
-    test "multiple key config" do
-      d = create_driver %[
-        geoip_lookup_key  from.ip, to.ip
-        enable_key_city   from_city, to_city
+    test "deprecated configuration geoip_lookup_key" do
+      conf = %[
+        geoip_lookup_key  host,ip
+        <record>
+          geoip_city ${city['host']}
+        </record>
         tag               geoip.${tag[1]}
       ]
-      assert_equal 'from_city, to_city', d.instance.config['enable_key_city']
-    end
-
-    test "multiple key config (bad configure)" do
-      assert_raise(Fluent::ConfigError) do
-        create_driver %[
-          geoip_lookup_key  from.ip, to.ip
-          enable_key_city   from_city
-          enable_key_region from_region
-          tag               geoip.${tag[1]}
-        ]
-      end
+      d = create_driver(conf)
+      assert_equal(["host", "ip"],
+                   d.instance.instance_variable_get(:@geoip).instance_variable_get(:@geoip_lookup_keys))
     end
 
     test "invalid json structure w/ Ruby hash like" do
       assert_raise(Fluent::ConfigParseError) do
         create_driver %[
-          geoip_lookup_key  host
+          geoip_lookup_keys host
           <record>
             invalid_json    {"foo" => 123}
           </record>
@@ -79,7 +60,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     test "invalid json structure w/ unquoted string literal" do
       assert_raise(Fluent::ConfigParseError) do
         create_driver %[
-          geoip_lookup_key  host
+          geoip_lookup_keys host
           <record>
             invalid_json    {"foo" : string, "bar" : 123}
           </record>
@@ -132,7 +113,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_tag_option
       d1 = create_driver(%[
         backend_library   geoip2_c
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           geoip_city      ${city.names.en['host']}
         </record>
@@ -152,7 +133,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_tag_parts
       d1 = create_driver(%[
         backend_library   geoip2_c
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           geoip_city      ${city.names.en['host']}
         </record>
@@ -170,7 +151,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_with_dot_key
       d1 = create_driver(%[
         backend_library   geoip2_c
-        geoip_lookup_key  ip.origin, ip.dest
+        geoip_lookup_keys ip.origin, ip.dest
         <record>
           origin_country  ${country.iso_code['ip.origin']}
           dest_country    ${country.iso_code['ip.dest']}
@@ -190,7 +171,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_with_unknown_address
       d1 = create_driver(%[
         backend_library   geoip2_c
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           geoip_city      ${city.names.en['host']}
           geopoint        [${location.longitude['host']}, ${location.latitude['host']}]
@@ -214,7 +195,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_with_skip_unknown_address
       d1 = create_driver(%[
         backend_library   geoip2_c
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           geoip_city      ${city.names.en['host']}
           geopoint        [${location.longitude['host']}, ${location.latitude['host']}]
@@ -243,7 +224,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_record_directive
       d1 = create_driver(%[
         backend_library   geoip2_c
-        geoip_lookup_key  from.ip
+        geoip_lookup_keys from.ip
         <record>
           from_city       ${city.names.en['from.ip']}
           from_country    ${country.names.en['from.ip']}
@@ -308,7 +289,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_record_directive_multiple_record
       d1 = create_driver(%[
         backend_library   geoip2_c
-        geoip_lookup_key  from.ip, to.ip
+        geoip_lookup_keys from.ip, to.ip
         <record>
           from_city       ${city.names.en['from.ip']}
           to_city         ${city.names.en['to.ip']}
@@ -342,7 +323,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def config_quoted_record
       %[
       backend_library   geoip2_c
-      geoip_lookup_key  host
+      geoip_lookup_keys host
       <record>
         location_properties  '{ "country_code" : "${country.iso_code["host"]}", "lat": ${location.latitude["host"]}, "lon": ${location.longitude["host"]} }'
         location_string      ${location.latitude['host']},${location.longitude['host']}
@@ -392,7 +373,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_multiline_v1_config
       d1 = create_driver(%[
         backend_library   geoip2_c
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           location_properties  {
             "city": "${city.names.en['host']}",
@@ -418,7 +399,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_tag_option
       d1 = create_driver(%[
         backend_library   geoip2_compat
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           geoip_city      ${city['host']}
         </record>
@@ -438,7 +419,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_tag_parts
       d1 = create_driver(%[
         backend_library   geoip2_compat
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           geoip_city      ${city['host']}
         </record>
@@ -456,7 +437,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_with_dot_key
       d1 = create_driver(%[
         backend_library   geoip2_compat
-        geoip_lookup_key  ip.origin, ip.dest
+        geoip_lookup_keys ip.origin, ip.dest
         <record>
           origin_country  ${country_code['ip.origin']}
           dest_country    ${country_code['ip.dest']}
@@ -476,7 +457,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_with_unknown_address
       d1 = create_driver(%[
         backend_library   geoip2_compat
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           geoip_city      ${city['host']}
           geopoint        [${longitude['host']}, ${latitude['host']}]
@@ -500,7 +481,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_with_skip_unknown_address
       d1 = create_driver(%[
         backend_library   geoip2_compat
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           geoip_city      ${city['host']}
           geopoint        [${longitude['host']}, ${latitude['host']}]
@@ -529,7 +510,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_record_directive
       d1 = create_driver(%[
         backend_library   geoip2_compat
-        geoip_lookup_key  from.ip
+        geoip_lookup_keys from.ip
         <record>
           from_city       ${city['from.ip']}
           from_country    ${country_name['from.ip']}
@@ -594,7 +575,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_record_directive_multiple_record
       d1 = create_driver(%[
         backend_library   geoip2_compat
-        geoip_lookup_key  from.ip, to.ip
+        geoip_lookup_keys from.ip, to.ip
         <record>
           from_city       ${city['from.ip']}
           to_city         ${city['to.ip']}
@@ -628,7 +609,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def config_quoted_record
       %[
       backend_library   geoip2_compat
-      geoip_lookup_key  host
+      geoip_lookup_keys host
       <record>
         location_properties  '{ "country_code" : "${country_code["host"]}", "lat": ${latitude["host"]}, "lon": ${longitude["host"]} }'
         location_string      ${latitude['host']},${longitude['host']}
@@ -678,7 +659,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_multiline_v1_config
       d1 = create_driver(%[
         backend_library   geoip2_compat
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           location_properties  {
             "city": "${city['host']}",
@@ -701,28 +682,10 @@ class GeoipOutputTest < Test::Unit::TestCase
   end
 
   sub_test_case "geoip legacy" do
-    def test_emit
-      d1 = create_driver(%[
-        backend_library geoip
-        geoip_lookup_key  host
-        enable_key_city   geoip_city
-        tag               geoip.${tag[1]}
-      ])
-      d1.run(default_tag: 'input.access') do
-        d1.feed({'host' => '66.102.3.80', 'message' => 'valid ip'})
-        d1.feed({'message' => 'missing field'})
-      end
-      events = d1.events
-      assert_equal 2, events.length
-      assert_equal 'geoip.access', events[0][0] # tag
-      assert_equal 'Mountain View', events[0][2]['geoip_city']
-      assert_equal nil, events[1][2]['geoip_city']
-    end
-
     def test_emit_tag_option
       d1 = create_driver(%[
         backend_library geoip
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           geoip_city      ${city['host']}
         </record>
@@ -742,7 +705,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_tag_parts
       d1 = create_driver(%[
         backend_library geoip
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           geoip_city      ${city['host']}
         </record>
@@ -760,7 +723,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_with_dot_key
       d1 = create_driver(%[
         backend_library geoip
-        geoip_lookup_key  ip.origin, ip.dest
+        geoip_lookup_keys ip.origin, ip.dest
         <record>
           origin_country  ${country_code['ip.origin']}
           dest_country    ${country_code['ip.dest']}
@@ -780,8 +743,10 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_nested_attr
       d1 = create_driver(%[
         backend_library geoip
-        geoip_lookup_key  host.ip
-        enable_key_city   geoip_city
+        geoip_lookup_keys  host.ip
+        <record>
+          geoip_city ${city['host.ip']}
+        </record>
         tag               geoip.${tag[1]}
       ])
       d1.run(default_tag: 'input.access') do
@@ -798,7 +763,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_with_unknown_address
       d1 = create_driver(%[
         backend_library geoip
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           geoip_city      ${city['host']}
           geopoint        [${longitude['host']}, ${latitude['host']}]
@@ -822,7 +787,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_with_skip_unknown_address
       d1 = create_driver(%[
         backend_library geoip
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           geoip_city      ${city['host']}
           geopoint        [${longitude['host']}, ${latitude['host']}]
@@ -851,8 +816,11 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_multiple_key
       d1 = create_driver(%[
         backend_library geoip
-        geoip_lookup_key  from.ip, to.ip
-        enable_key_city   from_city, to_city
+        geoip_lookup_keys  from.ip, to.ip
+        <record>
+          from_city ${city['from.ip']}
+          to_city   ${city['to.ip']}
+        </record>
         tag               geoip.${tag[1]}
       ])
       d1.run(default_tag: 'input.access') do
@@ -871,9 +839,13 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_multiple_key_multiple_record
       d1 = create_driver(%[
         backend_library geoip
-        geoip_lookup_key  from.ip, to.ip
-        enable_key_city   from_city, to_city
-        enable_key_country_name from_country, to_country
+        geoip_lookup_keys  from.ip, to.ip
+        <record>
+          from_city    ${city['from.ip']}
+          from_country ${country_name['from.ip']}
+          to_city      ${city['to.ip']}
+          to_country   ${country_name['to.ip']}
+        </record>
         tag               geoip.${tag[1]}
       ])
       d1.run(default_tag: 'input.access') do
@@ -903,7 +875,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_record_directive
       d1 = create_driver(%[
         backend_library geoip
-        geoip_lookup_key  from.ip
+        geoip_lookup_keys from.ip
         <record>
           from_city       ${city['from.ip']}
           from_country    ${country_name['from.ip']}
@@ -968,7 +940,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_record_directive_multiple_record
       d1 = create_driver(%[
         backend_library geoip
-        geoip_lookup_key  from.ip, to.ip
+        geoip_lookup_keys from.ip, to.ip
         <record>
           from_city       ${city['from.ip']}
           to_city         ${city['to.ip']}
@@ -1002,7 +974,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def config_quoted_record
       %[
         backend_library geoip
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           location_properties  '{ "country_code" : "${country_code["host"]}", "lat": ${latitude["host"]}, "lon": ${longitude["host"]} }'
           location_string      ${latitude['host']},${longitude['host']}
@@ -1052,7 +1024,7 @@ class GeoipOutputTest < Test::Unit::TestCase
     def test_emit_multiline_v1_config
       d1 = create_driver(%[
         backend_library geoip
-        geoip_lookup_key  host
+        geoip_lookup_keys host
         <record>
           location_properties  {
             "city": "${city['host']}",

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-geoip
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Kentaro Yoshida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-26 00:00:00.000000000 Z
+date: 2018-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -149,6 +149,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE.md"
 - ".gitignore"
 - ".travis.yml"
 - Appraisals
@@ -166,6 +167,7 @@ files:
 - dockerfiles/Dockerfile-ruby2.2
 - dockerfiles/Dockerfile-ruby2.3
 - dockerfiles/Dockerfile-ruby2.4
+- dockerfiles/Dockerfile-ruby2.5
 - fluent-plugin-geoip.gemspec
 - gemfiles/fluentd_v1.0_with_backport_dig.gemfile
 - gemfiles/fluentd_v1.0_without_backport_dig.gemfile