fluent-plugin-filter-geoip 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 486c0eaea288541dc8e8f1fb44c651aa22979dd5
-  data.tar.gz: aa88708061c48476208ab0b2d0afabb351670fd3
+  metadata.gz: 5f2fd0ecc7c4107238ac0036c23619c8de8c22aa
+  data.tar.gz: c670f95a24c05f40f4c85601296b9dec171a2414
 SHA512:
-  metadata.gz: ece9b9d918165337bb4896b8708fae36223a11b9de9254a55ae11420694799d6b400621ec9358ad396f2021683ddfb75c4455b035b7905b178b55753b2c429af
-  data.tar.gz: ec4db585b1d4d3c0103da848ccadde85c8c488465b2552d1e5072fc5cacc5e7ecb007298a9e59c7955a06487ba38753552581e74f6a7fbcfb9fdf4878653b655
+  metadata.gz: aef325575c76255ca1479f7649a38fb2bb19e963fa40fe403f804f92d7b91f7882474c09b8f7aba2f4c04acd0e2844bab5f878aaf4f4caaa9efbff6091b4e100
+  data.tar.gz: 8a0661ce524170f0d6900789f4f4bc6d7954810813848e73a0f32606fbd6d11b5f9c3f4d5903f2a74836e6e7aaa4691375e4258de88e5b0477cb6438ff945378

data/.gitignore

@@ -36,3 +36,6 @@ build/
 
 Gemfile.lock
 geoip
+
+# RubyMine
+.idea/

data/README.md

@@ -4,19 +4,21 @@ This is a [Fluentd](http://fluentd.org/) filter plugin for adding [GeoIP data](h
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install it yourself as:
 
 ```
-gem 'fluent-plugin-filter-geoip'
+$ gem install fluent-plugin-filter-geoip
 ```
 
-And then execute:
+## How to build
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install fluent-plugin-filter-geoip
+```
+$ gem install bundler
+$ bundle install
+$ rake test
+$ rake build
+$ rake install
+```
 
 ## Config parameters
 
@@ -193,7 +195,7 @@ connection_type true
   database_path ./geoip/database/GeoLite2-City.mmdb
 
   lookup_field clientip
-  field_prefix geoip
+  output_field geoip
   field_delimiter .
   flatten false
 
@@ -259,6 +261,73 @@ then output bocomes as belows:
 }
 ```
 
+
+## Example command
+
+Start fluentd using example fluent.conf.
+
+```
+$ fluentd -c ~/github/fluent-plugin-filter-geoip/fluent.conf
+2017-03-13 15:11:31 +0900 [info]: reading config file path="/Users/mosuka/github/fluent-plugin-filter-geoip/fluent.conf"
+2017-03-13 15:11:31 +0900 [info]: starting fluentd-0.12.33
+2017-03-13 15:11:31 +0900 [info]: gem 'fluent-plugin-filter-geoip' version '0.5.3'
+2017-03-13 15:11:31 +0900 [info]: gem 'fluent-plugin-grok-parser' version '1.0.0'
+2017-03-13 15:11:31 +0900 [info]: gem 'fluent-plugin-output-solr' version '0.4.0'
+2017-03-13 15:11:31 +0900 [info]: gem 'fluent-plugin-ua-parser' version '1.1.0'
+2017-03-13 15:11:31 +0900 [info]: gem 'fluentd' version '0.12.33'
+2017-03-13 15:11:31 +0900 [info]: gem 'fluentd' version '0.12.32'
+2017-03-13 15:11:31 +0900 [info]: adding filter pattern="messages" type="geoip"
+2017-03-13 15:11:31 +0900 [info]: Current MD5: cc1f9a6f7def282bc33cb477f3379d9f
+2017-03-13 15:11:31 +0900 [info]: Fetched MD5: cc1f9a6f7def282bc33cb477f3379d9f
+2017-03-13 15:11:32 +0900 [info]: adding match pattern="messages" type="stdout"
+2017-03-13 15:11:32 +0900 [info]: adding source type="forward"
+2017-03-13 15:11:32 +0900 [info]: using configuration file: <ROOT>
+  <source>
+    @type forward
+    port 24224
+  </source>
+  <filter messages>
+    @type geoip
+    enable_auto_download true
+    md5_url http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.md5
+    download_url http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz
+    md5_path ./geoip/database/GeoLite2-City.md5
+    database_path ./geoip/database/GeoLite2-City.mmdb
+    lookup_field clientip
+    output_field geoip
+    field_delimiter .
+    flatten false
+    locale en
+    continent true
+    country true
+    city true
+    location true
+    postal true
+    registered_country true
+    represented_country true
+    subdivisions true
+    traits true
+    connection_type true
+  </filter>
+  <match messages>
+    type stdout
+  </match>
+</ROOT>
+2017-03-13 15:11:32 +0900 [info]: listening fluent socket on 0.0.0.0:24224
+```
+
+Send message via `fluent-cat`.
+
+```
+$ echo '{"clientip": "200.114.49.218"}' | fluent-cat messages
+```
+
+Fluentd outputs message in standard output.
+
+```
+2017-03-13 15:13:02 +0900 messages: {"clientip":"200.114.49.218","geoip":{"continent":{"code":"SA","geoname_id":6255150,"name":"South America"},"country":{"geoname_id":3686110,"iso_code":"CO","name":"Colombia"},"city":{"geoname_id":3674962,"name":"Medellín"},"location":{"latitude":6.2518,"longitude":-75.5636,"time_zone":"America/Bogota"},"registered_country":{"geoname_id":3686110,"iso_code":"CO","name":"Colombia"},"subdivisions":[{"geoname_id_0":3689815,"iso_code_0":"ANT","name_0":"Antioquia"}]}}
+```
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests.
@@ -266,4 +335,3 @@ After checking out the repo, run `bundle install` to install dependencies. Then,
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/mosuka/fluent-plugin-filter-geoip.
-

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.5.2"
+  spec.version       = "0.5.3"
   spec.authors       = ["Minoru Osuka"]
   spec.email         = ["minoru.osuka@gmail.com"]
 
@@ -19,10 +19,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'fluentd', '~> 0.14.6'
+  spec.add_runtime_dependency 'fluentd', '~> 0.12.32'
   spec.add_runtime_dependency 'maxminddb', '~> 0.1.11'
 
-  spec.add_development_dependency 'bundler', '~> 1.13.6'
+  spec.add_development_dependency 'bundler', '~> 1.14.6'
   spec.add_development_dependency 'rake', '~> 11.1.2'
   spec.add_development_dependency 'test-unit', '~> 3.1.5'
   spec.add_development_dependency 'minitest', '~> 5.8.3'

data/fluent.conf

@@ -0,0 +1,36 @@
+<source>
+  @type forward
+  port 24224
+</source>
+
+<filter messages>
+  @type geoip
+
+  enable_auto_download true
+  md5_url http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.md5
+  download_url http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz
+  md5_path ./geoip/database/GeoLite2-City.md5
+  database_path ./geoip/database/GeoLite2-City.mmdb
+
+  lookup_field clientip
+  output_field geoip
+  field_delimiter .
+  flatten false
+
+  locale en
+
+  continent true
+  country true
+  city true
+  location true
+  postal true
+  registered_country true
+  represented_country true
+  subdivisions true
+  traits true
+  connection_type true
+</filter>
+
+<match messages>
+  type stdout
+</match>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-filter-geoip
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Minoru Osuka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-21 00:00:00.000000000 Z
+date: 2017-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.6
+        version: 0.12.32
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.6
+        version: 0.12.32
 - !ruby/object:Gem::Dependency
   name: maxminddb
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.6
+        version: 1.14.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.13.6
+        version: 1.14.6
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,7 @@ files:
 - README.md
 - Rakefile
 - fluent-plugin-filter-geoip.gemspec
+- fluent.conf
 - lib/fluent/plugin/filter_geoip.rb
 homepage: https://github.com/mosuka/fluent-plugin-filter-geoip
 licenses:
@@ -129,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Fluent filter plugin for adding GeoIP data to record.