logstash-filter-private_geoip 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bb1d1e7b4b8854ff8ed70dad9b8f2cd995deff51
-  data.tar.gz: 4fd7f2f248d4cd01ef4dd31f8c32c41281121f21
+SHA256:
+  metadata.gz: 317a05ecd4529d3cbb0a12eed49ae8537e9e09c816826f1826f93214bba1523d
+  data.tar.gz: 6de06e1a7ae9dfc300c26dfb3e8eae846ae237649a190310e3dca2a4db8fb1c5
 SHA512:
-  metadata.gz: 1989fd62d6cd32f95890430baced04915fefaf89686a0715b5e71a97ebb40e5530e755623a1bc0fa856e63c508f55c0d0d8380523fe8e5c4860f19b5cec556b5
-  data.tar.gz: 114a016e0540a3f77147054f6ee4a9ee29f04efddea782487942996afb32b1364269c229a286d5070b880d5ad78fade46a9f4f3eccce332e9ae9fd70b94fd5df
+  metadata.gz: b554b60402c1bdd8bc349cc868bf729c7d964205b2788cb8bcb6fa38702de9f3ad69dd0631710b9373493ede45778eb7ad66269a2599545a99ac04c6c1462111
+  data.tar.gz: 51233d074eb95064e99a8e130d6d633897c15fe703f1e0beefd8672cf2c451059bed070e73703e95dd6255baa3d3a39f2940c40f976322fb5bdea78913b48569

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 3.0.2
+ - Docs: Add documentation template
+## 2.0.0
+ - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully, 
+   instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
+ - Dependency on logstash-core update to 2.0
+

data/CONTRIBUTORS

@@ -0,0 +1,11 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* Aaron Mildenstein (untergeek)
+* Pier-Hugues Pellerin (ph)
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-filter-example
+Example filter plugin. This should help bootstrap your effort to write your own filter plugin!

data/Gemfile

@@ -1,2 +1,11 @@
 source 'https://rubygems.org'
-gemspec
+
+gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015 KULeuven/LIBIS <http://www.libis.be>
+Copyright (c) 2012-2018 Elasticsearch <http://www.elastic.co>
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -10,4 +10,4 @@ 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.
+limitations under the License.

data/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -1,49 +1,98 @@
-# logstash-filter-private_geoip
-
-Extends or overwrites the GeoIP event data. If you have a large network with _mixed_ calls from **public** and **private** 
-IP address the **private** IP addresses are NOT resolved by GeoIP.
-   
-If you supply the different local networks they will get mapped.
-   
-## Filter definition   
-```json
-    filter {
-        private_geoip {
-            source => "client_ip"
-            database => "/path/to/network_file.json"
-            target => 'geoip'
-            merge => false
-        }
-    }
-```  
-
-* source: field that contains the ip address that needs to be mapped. This can be http_clientip, http_x_forwarded_for or ...
-* database: location of the the JSON mapping file.
-* target: where should the mapping result be stored. default = private_geoip but you could change it to geoip
-* merge: should the target be overwritten with the mapping result. default = true
-  
-## Mapping definition
-```JSON
-    [
-        {"cidr":"10.33.104.0/22",
-         "data":{"organization_name":"XYZ Faculty",
-                 "city_name":"Leuven",
-                 "country_name":"Belgium",
-                 ...
-                }
-        },
-        ...
-    ]
-``` 
- 
- * cidr: contains the network 
- * data: can contain any key/value pair. If you want to extend/overwrite GeoIP take those fields ...
-   
-   
-# Install
-   
+# Logstash Plugin
+
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-private_geoip.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-private_geoip)
+
+This is a plugin for [Logstash](https://github.com/elastic/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically build documentation for this plugin. We provide a template file, index.asciidoc, where you can add documentation. The contents of this file will be converted into html and then placed with other plugin documentation in a [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting config examples, you can use the asciidoc `[source,json]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=private_geoip).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-private_geoip", :path => "/your/local/logstash-filter-private_geoip"
+```
+- Install plugin
 ```sh
-   bin/plugin install /your/local/plugin/logstash-filter-private_geoip.gem
-```   
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {private_geoip {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-private_geoip.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
 
-Restart LogStash.
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/filters/private_geoip.rb

@@ -5,6 +5,7 @@ require "logstash/namespace"
 # The Private GeoIP filter add information about local private IP addresses
 # This is a CIDR filter on steroids
 
+
 class LogStash::Filters::PrivateGeoIP < LogStash::Filters::Base
   config_name "private_geoip"
 
@@ -49,7 +50,7 @@ class LogStash::Filters::PrivateGeoIP < LogStash::Filters::Base
 
   public
   def filter(event)
-    ip = IP::Address::Util.string_to_ip(event[@source])
+    ip = IP::Address::Util.string_to_ip(event.get(@source))
 
     matched_cidr_data = {}
 
@@ -62,18 +63,18 @@ class LogStash::Filters::PrivateGeoIP < LogStash::Filters::Base
 
     return if matched_cidr_data.nil? || matched_cidr_data.empty?
 
-    geo_data = event[@target].nil? ? {} : event[@target]
+    geo_data = event.get(@target).nil? ? {} : event.get(@target)
 
     if @merge
       geo_data.merge!(matched_cidr_data)
-      geo_data['ip'] = event[@source]
+      geo_data['ip'] = event.get(@source)
     else
       add_keys = matched_cidr_data.keys - geo_data.keys
       geo_data.merge!(matched_cidr_data.select{|k,v| add_keys.include?(k)})
     end
 
-    event[@target] = geo_data
+    event.set(@target, geo_data)
 
     filter_matched(event)
   end
-end
+end

data/logstash-filter-private_geoip.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-private_geoip'
-  s.version         = '1.0.0'
+  s.version         = '1.1.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "$summary"
   s.description     = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
@@ -12,7 +12,6 @@ Gem::Specification.new do |s|
 
   # Files
   s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
-
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})
 
@@ -20,10 +19,7 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
-  #s.add_runtime_dependency "logstash-core", ">= 2.0.0.beta2", "< 3.0.0"
+  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
   s.add_runtime_dependency 'ip', "0.3.1"
-
-
-  s.add_development_dependency 'logstash-devutils', '~> 0'
-end
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/filters/private_geoip_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "logstash/devutils/rspec/spec_helper"
 require "logstash/filters/private_geoip"
 require 'pp'
@@ -91,7 +93,7 @@ describe LogStash::Filters::PrivateGeoIP do
 
     sample(sample_data) do
       #insist {subject}.include?("geoip")
-      insist {subject["geoip"]["city_name"]} == "KULASSOC"
+      insist {subject.get("geoip")["city_name"]} == "KULASSOC"
     end
   end
 
@@ -132,9 +134,9 @@ describe LogStash::Filters::PrivateGeoIP do
     sample(sample_data) do
       insist {subject}.include?("geoip")
       reject {subject}.include?("private_geoip")
-      insist {subject["geoip"]["city_name"]} == "Leuven"
+      insist {subject.get("geoip")["city_name"]} == "Leuven"
     end
   end
 
 
-end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -1,35 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-private_geoip
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Mehmet Celik
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-19 00:00:00.000000000 Z
+date: 2019-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - <
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  name: logstash-core
+        version: '2.0'
+  name: logstash-core-plugin-api
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.4.0
-    - - <
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -47,7 +41,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   name: logstash-devutils
@@ -55,22 +49,29 @@ dependencies:
   type: :development
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program
+description: This gem is a logstash plugin required to be installed on top of the
+  Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not
+  a stand-alone program
 email: mehmet.celik@kuleuven.libis.be
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
 - Gemfile
 - LICENSE
+- NOTICE.TXT
 - README.md
 - lib/logstash/filters/private_geoip.rb
 - logstash-filter-private_geoip.gemspec
 - spec/filters/private_geoip_spec.rb
 - spec/resources/cidr.json
+- spec/spec_helper.rb
 homepage: http://www.elastic.co/guide/en/logstash/current/index.html
 licenses:
 - Apache License (2.0)
@@ -83,20 +84,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.8
+rubygems_version: 2.7.6
 signing_key:
 specification_version: 4
-summary: $summary
+summary: "$summary"
 test_files:
 - spec/filters/private_geoip_spec.rb
 - spec/resources/cidr.json
+- spec/spec_helper.rb