fluent-plugin-filter-geoip 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ed42a070dbbdd79fe1ebbbc200ed6575c73d5b9
-  data.tar.gz: e4494a384ecb2a16d9207ebef62f7811d69c6630
+  metadata.gz: d8edef2e0b807f33865469e4657a8c41f130cc7d
+  data.tar.gz: 12aed486300080cec3457636590e6e3696118e02
 SHA512:
-  metadata.gz: cae6f7761e4806d00d1d18be4a287ce28187fb4881f902d08e4433b00e121ba5a460ffe138235fd24f5bfec446032a9417d4457e2b6c539a714d35895f368d2b
-  data.tar.gz: f789f5e7c1e7c73983c95952038b33c459807056b0abf345c8de96b4c2183b12adcef05bc6012e221cadd6339daf3c8b506d94175d4cd1bff690cf2500c6d949
+  metadata.gz: 92ac13af10007c3ef2c767186c7008b11d5c6b93755b065ffce48e5a8b1642877a0a64736642f8cf5f7c81ef26018f10864ce2ff6ea310b35199f255cd0ef271
+  data.tar.gz: 7105c836eb52cce4bdcf6c3dacd7c91579ea8a8a5c19feee8aabd0bb90042f14fc25bbafd0d63b90713cde97d8a524b80aa928149391717098117ccb278ea6b0

data/README.md

@@ -20,122 +20,162 @@ Or install it yourself as:
 
 ## Config parameters
 
-### download_url
+### enable_auto_download
+
+If true, enable to download GeoIP2 database autometically (default: true).
 
 ```
-download_url http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz
+enable_auto_download true
 ```
 
 ### md5_url
 
+GeoIP2 MD5 checksum URL (default: http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.md5)
+
 ```
 md5_url http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.md5
 ```
 
-### database_path
+### download_url
+
+GeoIP2 database download URL (default: http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz).
 
 ```
-database_path ./geoip/database/GeoLite2-City.mmdb
+download_url http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz
 ```
 
 ### md5_path
 
+GeoIP2 MD5 checksum path. (default: ./geoip/database/GeoLite2-City.md5)
+
 ```
 md5_path ./geoip/database/GeoLite2-City.md5
 ```
 
-### enable_auto_download
+### database_path
+
+GeoIP2 database path. (default: ./geoip/database/GeoLite2-City.md5)
 
 ```
-enable_auto_download true
+database_path ./geoip/database/GeoLite2-City.mmdb
 ```
 
 ### lookup_field
 
+Specify the field name that IP address is stored (default: ip).
+
 ```
 lookup_field host
 ```
 
-### field_prefix
+### output_field
+
+Specify the field name that store the result (default: geoip).
 
 ```
-field_prefix geoip
+output_field geoip
 ```
 
 ### field_delimiter
 
+Specify the field delimiter (default .).
+
 ```
-field_delimiter _
+field_delimiter .
 ```
 
 ### flatten
 
+If true, to flatten the result using field_delimiter (default: true).
+
 ```
 flatten true
 ```
 
-### languages
+### locale
+
+Get the data for the specified locale (default: en).
 
 ```
-languages ["en"]
+locale en
 ```
 
 ### continent
 
+If true, to get continent information (default: true).
+
 ```
 continent true
 ```
 
 ### country
 
+If true, to get country information (default: true).
+
 ```
 country true
 ```
 
 ### city
 
+If true, to get city information (default: true).
+
 ```
 city true
 ```
 
 ### location
 
+If true, to get location information (default: true).
+
 ```
 location true
 ```
 
 ### postal
 
+If true, to get postal information (default: true).
+
 ```
 postal true
 ```
 
 ### registered_country
 
+If true, to get registered country information (default: true).
+
 ```
 registered_country true
 ```
 
 ### represented_country
 
+If true, to get represented country information (default: true).
+
 ```
 represented_country true
 ```
 
 ### subdivisions
 
+If true, to get subdivisions information (default: true).
+
 ```
 subdivisions true
 ```
 
 ### traits
 
+If true, to get traits information (default: true).
+
 ```
 traits true
 ```
 
 ### connection_type
 
+If true, to get connection type information (default: true).
+
 ```
 connection_type true
 ```

data/fluent-plugin-filter-geoip.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-filter-geoip"
-  spec.version       = "0.2.5"
+  spec.version       = "0.2.6"
   spec.authors       = ["Minoru Osuka"]
   spec.email         = ["minoru.osuka@gmail.com"]
 

data/lib/fluent/plugin/filter_geoip.rb

@@ -14,7 +14,7 @@ module Fluent
     DEFAULT_DATABASE_PATH = './geoip/database/GeoLite2-City.mmdb'
 
     DEFAULT_LOOKUP_FIELD = 'ip'
-    DEFAULT_FIELD_PREFIX = 'geoip'
+    DEFAULT_OUTPU_FIELD = 'geoip'
     DEFAULT_FIELD_DELIMITER = '.'
     DEFAULT_FLATTEN = false
 
@@ -49,7 +49,7 @@ module Fluent
     config_param :lookup_field, :string, :default => DEFAULT_LOOKUP_FIELD,
                  :desc => ''
 
-    config_param :field_prefix, :string, :default => DEFAULT_FIELD_PREFIX,
+    config_param :output_field, :string, :default => DEFAULT_OUTPU_FIELD,
                  :desc => ''
 
     config_param :field_delimiter, :string, :default => DEFAULT_FIELD_DELIMITER,
@@ -110,7 +110,7 @@ module Fluent
 
       @lookup_field = conf.has_key?('lookup_field') ? conf['lookup_field'] : DEFAULT_LOOKUP_FIELD
 
-      @field_prefix = conf.has_key?('field_prefix') ? conf['field_prefix'] : DEFAULT_FIELD_PREFIX
+      @output_field = conf.has_key?('output_field') ? conf['output_field'] : DEFAULT_OUTPU_FIELD
 
       @field_delimiter = conf.has_key?('field_delimiter') ? conf['field_delimiter'] : DEFAULT_FIELD_DELIMITER
 
@@ -163,9 +163,9 @@ module Fluent
             continent_hash['name'] = geoip.continent.name(@locale)
 
             if @flatten then
-              record.merge!(to_flatten(continent_hash, [@field_prefix, 'continent'], @field_delimiter))
+              record.merge!(to_flatten(continent_hash, [@output_field, 'continent'], @field_delimiter))
             else
-              record[[@field_prefix, 'continent'].join(@field_delimiter)] = continent_hash.to_json
+              record[[@output_field, 'continent'].join(@field_delimiter)] = continent_hash.to_json
             end
           end
 
@@ -178,9 +178,9 @@ module Fluent
             country_hash['name'] = geoip.country.name(@locale)
 
             if @flatten then
-              record.merge!(to_flatten(country_hash, [@field_prefix, 'country'], @field_delimiter))
+              record.merge!(to_flatten(country_hash, [@output_field, 'country'], @field_delimiter))
             else
-              record[[@field_prefix, 'country'].join(@field_delimiter)] = country_hash.to_json
+              record[[@output_field, 'country'].join(@field_delimiter)] = country_hash.to_json
             end
           end
 
@@ -193,9 +193,9 @@ module Fluent
             city_hash['name'] = geoip.city.name(@locale)
 
             if @flatten then
-              record.merge!(to_flatten(city_hash, [@field_prefix, 'city'], @field_delimiter))
+              record.merge!(to_flatten(city_hash, [@output_field, 'city'], @field_delimiter))
             else
-              record[[@field_prefix, 'city'].join(@field_delimiter)] = city_hash.to_json
+              record[[@output_field, 'city'].join(@field_delimiter)] = city_hash.to_json
             end
           end
 
@@ -208,9 +208,9 @@ module Fluent
             location_hash['time_zone'] = geoip.location.time_zone
 
             if @flatten then
-              record.merge!(to_flatten(location_hash, [@field_prefix, 'location'], @field_delimiter))
+              record.merge!(to_flatten(location_hash, [@output_field, 'location'], @field_delimiter))
             else
-              record[[@field_prefix, 'location'].join(@field_delimiter)] = location_hash.to_json
+              record[[@output_field, 'location'].join(@field_delimiter)] = location_hash.to_json
             end
           end
 
@@ -220,9 +220,9 @@ module Fluent
             postal_hash['code'] = geoip.postal.code
 
             if @flatten then
-              record.merge!(to_flatten(postal_hash, [@field_prefix, 'postal'], @field_delimiter))
+              record.merge!(to_flatten(postal_hash, [@output_field, 'postal'], @field_delimiter))
             else
-              record[[@field_prefix, 'postal'].join(@field_delimiter)] = postal_hash.to_json
+              record[[@output_field, 'postal'].join(@field_delimiter)] = postal_hash.to_json
             end
           end
 
@@ -235,9 +235,9 @@ module Fluent
             registered_country_hash['name'] = geoip.registered_country.name(@locale)
 
             if @flatten then
-              record.merge!(to_flatten(registered_country_hash, [@field_prefix, 'registered_country'], @field_delimiter))
+              record.merge!(to_flatten(registered_country_hash, [@output_field, 'registered_country'], @field_delimiter))
             else
-              record[[@field_prefix, 'registered_country'].join(@field_delimiter)] = registered_country_hash.to_json
+              record[[@output_field, 'registered_country'].join(@field_delimiter)] = registered_country_hash.to_json
             end
           end
 
@@ -250,9 +250,9 @@ module Fluent
             represented_country_hash['name'] = geoip.represented_country.name(@locale)
 
             if @flatten then
-              record.merge!(to_flatten(represented_country_hash, [@field_prefix, 'represented_country'], @field_delimiter))
+              record.merge!(to_flatten(represented_country_hash, [@output_field, 'represented_country'], @field_delimiter))
             else
-              record[[@field_prefix, 'represented_country'].join(@field_delimiter)] = represented_country_hash.to_json
+              record[[@output_field, 'represented_country'].join(@field_delimiter)] = represented_country_hash.to_json
             end
           end
 
@@ -276,11 +276,11 @@ module Fluent
             if @flatten then
               i = 0
               subdivision_arry.each do |subdivision|
-                record.merge!(to_flatten(subdivision, [@field_prefix, 'subdivisions', i.to_s], @field_delimiter))
+                record.merge!(to_flatten(subdivision, [@output_field, 'subdivisions', i.to_s], @field_delimiter))
                 i = i + 1
               end
             else
-              record[[@field_prefix, 'subdivisions'].join(@field_delimiter)] = subdivision_arry.to_json
+              record[[@output_field, 'subdivisions'].join(@field_delimiter)] = subdivision_arry.to_json
             end
           end
 
@@ -291,14 +291,14 @@ module Fluent
             traits_hash['is_satellite_provider'] = geoip.traits.is_satellite_provider
 
             if @flatten then
-              record.merge!(to_flatten(traits_hash, [@field_prefix, 'traits'], @field_delimiter))
+              record.merge!(to_flatten(traits_hash, [@output_field, 'traits'], @field_delimiter))
             else
-              record[[@field_prefix, 'traits'].join(@field_delimiter)] = traits_hash.to_json
+              record[[@output_field, 'traits'].join(@field_delimiter)] = traits_hash.to_json
             end
           end
 
           if @connection_type then
-            record[[@field_prefix, 'connection_type'].join(@field_delimiter)] = geoip.connection_type
+            record[[@output_field, 'connection_type'].join(@field_delimiter)] = geoip.connection_type
           end
 
           log.info "Record: %s" % record.inspect

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-filter-geoip
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Minoru Osuka