fluent-plugin-geoip 0.0.1

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+vendor/
+Gemfile.lock
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-geoip.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright (c) 2013- Kentaro Yoshida
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,111 @@
+# fluent-plugin-geoip
+
+Fluentd Output plugin to add information about geographical location of IP addresses with Maxmind GeoIP databases.
+
+## Installation
+
+install with `gem` or `fluent-gem` command as:
+
+```
+# for fluentd
+$ gem install fluent-plugin-geoip
+
+# for td-agent
+$ sudo /usr/lib64/fluent/ruby/bin/fluent-gem install fluent-plugin-geoip
+```
+
+## Usage
+
+```
+<match access.apache>
+  type geoip
+
+  # buffering time
+  flush_interval           1s
+
+  # tag settings
+  remove_tag_prefix        access.
+  add_tag_prefix           geoip.
+  include_tag_key          false
+
+  # geoip settings
+  geoip_lookup_key         host
+
+  # record settings
+  enable_key_city          geoip_city
+  enable_key_latitude      geoip_lat
+  enable_key_longitude     geoip_lon
+  enable_key_country_code3 geoip_country3
+  enable_key_country_code  geoip_country
+  enable_key_country_name  geoip_country_name
+  enable_key_dma_code      geoip_dma
+  enable_key_area_code     geoip_area
+  enable_key_region        geoip_region
+</match>
+```
+
+## Tutorial
+
+#### configuration
+
+```
+<source>
+  type forward
+</source>
+
+<match test.geoip>
+  type copy
+  <store>
+    type stdout
+  </store>
+  <store>
+    type geoip
+    geoip_lookup_key     host
+    enable_key_city      city
+    enable_key_latitude  lat
+    enable_key_longitude lon
+    remove_tag_prefix    test.
+    add_tag_prefix       debug.
+    flush_interval       5s
+  </store>
+</match>
+
+<match debug.**>
+  type stdout
+</match>
+```
+
+#### result
+
+```
+# forward record with Google's ip address.
+$ echo '{"host":"66.102.9.80","message":"test"}' | fluent-cat test.geoip
+
+# check the result at stdout
+$ tail /var/log/td-agent/td-agent.log
+2013-08-04 16:21:32 +0900 test.geoip: {"host":"66.102.9.80","message":"test"}
+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}
+```
+
+## TODO
+
+Pull requests are very welcome!!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+Copyright (c) 2013- Kentaro Yoshida (@yoshi_ken)
+
+## License
+
+Apache License, Version 2.0
+
+This product includes GeoLite data created by MaxMind, available from
+<a href="http://www.maxmind.com">http://www.maxmind.com</a>.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/fluent-plugin-geoip.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-geoip"
+  spec.version       = "0.0.1"
+  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.}
+  spec.homepage      = "https://github.com/y-ken/fluent-plugin-geoip"
+  spec.license       = "Apache License, Version 2.0"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency "fluentd"
+  spec.add_runtime_dependency "geoip-c"
+end

data/lib/fluent/plugin/out_geoip.rb

@@ -0,0 +1,56 @@
+class Fluent::GeoipOutput < Fluent::BufferedOutput
+  Fluent::Plugin.register_output('geoip', self)
+  
+  GEOIP_KEYS = %w(city latitude longitude country_code3 country_code country_name dma_code area_code region)
+  config_param :geoip_database, :string, :default => 'data/GeoLiteCity.dat'
+  config_param :geoip_lookup_key, :string, :default => 'host'
+
+  include Fluent::HandleTagNameMixin
+  include Fluent::SetTagKeyMixin
+  config_set_default :include_tag_key, false
+
+  def initialize
+    require 'geoip.bundle'
+    super
+  end
+  
+  def configure(conf)
+    super
+
+    @geoip_keys_map = Hash.new
+    conf.keys.select{|k| k =~ /^enable_key_/}.each do |key|
+      geoip_key_name = key.sub('enable_key_','')
+      raise Fluent::ConfigError, "geoip: unsupported key #{geoip_key_name}" unless GEOIP_KEYS.include?(geoip_key_name)
+      @geoip_keys_map.store(geoip_key_name, conf[key])
+    end
+
+    if ( !@remove_tag_prefix && !@remove_tag_suffix && !@add_tag_prefix && !@add_tag_suffix )
+      raise Fluent::ConfigError, "geoip: missing remove_tag_prefix, remove_tag_suffix, add_tag_prefix or add_tag_suffix."
+    end
+
+    @geoip = GeoIP::City.new(@geoip_database, :memory, false)
+  end
+
+  def start
+    super
+  end
+  
+  def format(tag, time, record)
+    [tag, time, record].to_msgpack
+  end
+  
+  def shutdown
+    super
+  end
+
+  def write(chunk)
+    chunk.msgpack_each do |tag, time, record|
+      result = @geoip.look_up(record[@geoip_lookup_key])
+      @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
+  end
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/out_geoip'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_geoip.rb

@@ -0,0 +1,47 @@
+require 'helper'
+
+class GeoipOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    geoip_lookup_key  host
+    enable_key_city   geoip_city
+    remove_tag_prefix input.
+    add_tag_prefix    geoip.
+  ]
+
+  def create_driver(conf=CONFIG,tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::GeoipOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver('')
+    }
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver('enable_key_cities')
+    }
+    d = create_driver %[
+      enable_key_city geoip_city
+      remove_tag_prefix input.
+      add_tag_prefix    geoip.
+    ]
+    puts d.instance.inspect
+    assert_equal 'geoip_city', d.instance.config['enable_key_city']
+  end
+
+  def test_emit
+    d1 = create_driver(CONFIG, 'input.access')
+    d1.run do
+      d1.emit({'host' => '66.102.3.80', 'message' => 'action foo'})
+    end
+    emits = d1.emits
+    assert_equal 1, emits.length
+    p emits[0]
+    assert_equal 'geoip.access', emits[0][0] # tag
+    assert_equal 'Mountain View', emits[0][2]['geoip_city']
+  end
+
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-geoip
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kentaro Yoshida
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: geoip-c
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- y.ken.studio@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- data/GeoLiteCity.dat
+- fluent-plugin-geoip.gemspec
+- lib/fluent/plugin/out_geoip.rb
+- test/helper.rb
+- test/plugin/test_out_geoip.rb
+homepage: https://github.com/y-ken/fluent-plugin-geoip
+licenses:
+- Apache License, Version 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Fluentd Output plugin to add information about geographical location of IP
+  addresses with Maxmind GeoIP databases.
+test_files:
+- test/helper.rb
+- test/plugin/test_out_geoip.rb