fluent-plugin-geoip 0.0.2 → 0.0.3

data/README.md

@@ -2,6 +2,14 @@
 
 Fluentd Output plugin to add information about geographical location of IP addresses with Maxmind GeoIP databases.
 
+fluent-plugin-geoip has bundled cost-free [GeoLite City database](http://dev.maxmind.com/geoip/legacy/geolite/) by default.  
+Also you can use purchased [GeoIP City database](http://www.maxmind.com/en/city) ([lang:ja](http://www.maxmind.com/ja/city)) which costs starting from $50.  
+
+The accuracy details for GeoLite City (free) and GeoIP City (purchased) has described at the page below.
+
+* http://www.maxmind.com/en/geolite_city_accuracy ([lang:ja](http://www.maxmind.com/ja/geolite_city_accuracy))
+* http://www.maxmind.com/en/city_accuracy ([lang:ja](http://www.maxmind.com/ja/city_accuracy))
+
 ## Installation
 
 install with `gem` or `fluent-gem` command as:
@@ -20,7 +28,7 @@ $ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-geoip
 <match access.apache>
   type geoip
 
-  # buffering time
+  # buffering time (default: 60s)
   flush_interval           1s
 
   # tag settings
@@ -28,10 +36,13 @@ $ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-geoip
   add_tag_prefix           geoip.
   include_tag_key          false
 
-  # geoip settings
+  # specify geoip lookup field (default: host)
   geoip_lookup_key         host
 
-  # record settings
+  # specify geoip database (using bundled GeoLiteCity databse by default)
+  geoip_database           'data/GeoLiteCity.dat'
+
+  # record settings (enable more than one keys required.)
   enable_key_city          geoip_city
   enable_key_latitude      geoip_lat
   enable_key_longitude     geoip_lon
@@ -87,6 +98,11 @@ $ tail /var/log/td-agent/td-agent.log
 2013-08-04 16:21:32 +0900 debug.geoip: {"host":"66.102.9.80","message":"test","city":"Mountain View","lat":37.4192008972168,"lon":-122.05740356445312}
 ```
 
+## Articles
+
+* [IPアドレスを元に位置情報をリアルタイムに付与する fluent-plugin-geoip v0.0.1をリリースしました #fluentd - Y-Ken Studio](http://y-ken.hatenablog.com/entry/fluent-plugin-geoip-has-released)  
+http://y-ken.hatenablog.com/entry/fluent-plugin-geoip-has-released
+
 ## TODO
 
 Pull requests are very welcome!!

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       = "0.0.2"
+  spec.version       = "0.0.3"
   spec.authors       = ["Kentaro Yoshida"]
   spec.email         = ["y.ken.studio@gmail.com"]
   spec.summary       = %q{Fluentd Output plugin to add information about geographical location of IP addresses with Maxmind GeoIP databases.}

data/lib/fluent/plugin/out_geoip.rb

@@ -45,12 +45,21 @@ class Fluent::GeoipOutput < Fluent::BufferedOutput
 
   def write(chunk)
     chunk.msgpack_each do |tag, time, record|
-      result = @geoip.look_up(record[@geoip_lookup_key])
+      Fluent::Engine.emit(tag, time, add_geoip_field(record))
+    end
+  end
+
+  def add_geoip_field(record)
+    address = record[@geoip_lookup_key]
+    return record if address.nil?
+    result = @geoip.look_up(address)
+    if result.nil?
+      $log.info "geoip: lookup failed.", :address => address
+    else
       @geoip_keys_map.each do |geoip_key,record_key|
         record.store(record_key, result[geoip_key.to_sym])
       end
-      $log.info "geoip: record:#{record}, result:#{result}"
-      Fluent::Engine.emit(tag, time, record)
     end
+    return record
   end
 end

data/test/plugin/test_out_geoip.rb

@@ -35,13 +35,33 @@ class GeoipOutputTest < Test::Unit::TestCase
   def test_emit
     d1 = create_driver(CONFIG, 'input.access')
     d1.run do
-      d1.emit({'host' => '66.102.3.80', 'message' => 'action foo'})
+      d1.emit({'host' => '66.102.3.80', 'message' => 'valid ip'})
+      d1.emit({'message' => 'missing field'})
     end
     emits = d1.emits
-    assert_equal 1, emits.length
+    assert_equal 2, emits.length
     p emits[0]
     assert_equal 'geoip.access', emits[0][0] # tag
     assert_equal 'Mountain View', emits[0][2]['geoip_city']
+    p emits[1]
+    assert_equal nil, emits[1][2]['geoip_city']
+  end
+
+  def test_emit_with_unknown_address
+    d1 = create_driver(CONFIG, 'input.access')
+    d1.run do
+      # 203.0.113.1 is a test address described in RFC5737
+      d1.emit({'host' => '203.0.113.1', 'message' => 'invalid ip'})
+      d1.emit({'host' => '0', 'message' => 'invalid ip'})
+    end
+    emits = d1.emits
+    assert_equal 2, emits.length
+    p emits[0]
+    assert_equal 'geoip.access', emits[0][0] # tag
+    assert_equal nil, emits[0][2]['geoip_city']
+    p emits[1]
+    assert_equal 'geoip.access', emits[1][0] # tag
+    assert_equal nil, emits[1][2]['geoip_city']
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-geoip
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-16 00:00:00.000000000 Z
+date: 2013-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler