logstash-filter-contains 1.0.0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 34c2672e7b79ed2fade7c9eaa406023435edae44
+  data.tar.gz: 987c6c08d7ec7b1e8729eba02ef16f0b9712f7b9
+SHA512:
+  metadata.gz: d12a48998e71d7228a178a29c785fdb9ef011cf438a586c2f65a09769af7f1f9a4dadc7fade39fafccc568e3acfce8b79fc9213712b945877d16779fff64302e
+  data.tar.gz: 37746e2b3f644f4aa3e7e533f7e44f1591754ecdd8100fde9db8249a90fbfd633ff51902ecbed02efff533e6a76d12ec6dd993a3aa93e279bc875fa0945ab80e

data/CONTRIBUTORS

@@ -0,0 +1,5 @@
+The following people (name and/or nickname and/or GitHub id) have contributed code
+patches or helped out in other ways to the Logstash Filter Contains project:
+
+Contributors:
+* donghyeon kim (EastBright) (inaz1502)

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+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

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2016 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.
+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,96 @@
+# Logstash Plugin
+
+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 generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` 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=example).
+
+- 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-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+# 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 {awesome {}}'
+```
+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-awesome.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.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/docs/index.asciidoc

@@ -0,0 +1,111 @@
+:plugin: contains
+:type: filter
+
+///////////////////////////////////////////
+START - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+:version: %VERSION%
+:release_date: %RELEASE_DATE%
+:changelog_url: %CHANGELOG_URL%
+:include_path: ../../../../logstash/docs/include
+///////////////////////////////////////////
+END - GENERATED VARIABLES, DO NOT EDIT!
+///////////////////////////////////////////
+
+[id="plugins-{type}s-{plugin}"]
+
+=== Contains filter plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+filter to check if value is contains
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Contains Filter Configuration Options
+
+This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
+
+[cols="<,<,<",options="header",]
+|=======================================================================
+|Setting |Input type|Required
+| <<plugins-{type}s-{plugin}-field>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-value>> |<<array,array>>|No
+| <<plugins-{type}s-{plugin}-value_path>> |a valid filesystem path|No
+| <<plugins-{type}s-{plugin}-refresh_interval>>| <<number,number>>|No
+| <<plugins-{type}s-{plugin}-separator>> |<<string,string>>|No
+|=======================================================================
+
+Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
+filter plugins.
+
+&nbsp;
+
+[id="plugins-{type}s-{plugin}-field"]
+===== `field`
+
+  * Value type is <<array,array>>
+  * Default value is `[]`
+
+The field[s] to check with. Example:
+[source,ruby]
+    filter {
+      contains {
+        add_tag => [ "fruits" ]
+        field => [ "%{a}", "%{b}" ]
+        value => [ "apple" ]
+      }
+    }
+
+[id="plugins-{type}s-{plugin}-value"]
+===== `value`
+
+  * Value type is <<array,array>>
+  * Default value is `[]`
+
+The value(s) to check against. Example:
+[source,ruby]
+    filter {
+      contains {
+        add_tag => [ "fruits" ]
+        field => [ "%{a}" ]
+        value => [ "banana" ]
+      }
+    }
+
+
+[id="plugins-{type}s-{plugin}-value_path"]
+===== `value_path`
+
+  * Value type is <<path,path>>
+  * There is no default value for this setting.
+
+The full path of the external file containing the values the filter should check with.
+Values are separated by a separator character defined in `separator`.
+[source,ruby]
+    apple
+    banana
+NOTE: It is an error to specify both `value` and `value_path`.
+
+[id="plugins-{type}s-{plugin}-refresh_interval"]
+===== `refresh_interval`
+
+  * Value type is <<number,number>>
+  * Default value is `600`
+
+When using an external file, this setting will indicate how frequently
+(in seconds) Logstash will check the file for updates.
+
+
+[id="plugins-{type}s-{plugin}-separator"]
+===== `separator`
+
+  * Value type is <<string,string>>
+  * Default value is `\n`
+
+Separator character used for parsing values from the external file
+specified by `value_path`. Defaults to newline `\n` character.
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/lib/logstash/filters/contains.rb

@@ -0,0 +1,155 @@
+# encoding: utf-8
+require "logstash/filters/base"
+require "logstash/namespace"
+require "set"
+
+java_import 'java.util.concurrent.locks.ReentrantReadWriteLock'
+
+class LogStash::Filters::CONTAINS < LogStash::Filters::Base
+
+  config_name "contains"
+
+  # The field(s) to check with. Example:
+  # [source,ruby]
+  #     filter {
+  #       %PLUGIN% {
+  #         add_tag => [ "fruits" ]
+  #         field => [ "%{a}" ]
+  #         value => [ "apple" ]
+  #       }
+  #     }
+  config :field, :validate => :array, :default => []
+
+  # The value(s) to check against. Example:
+  # [source,ruby]
+  #     filter {
+  #       %PLUGIN% {
+  #         add_tag => [ "fruits" ]
+  #         field => [ "%{a}" ]
+  #         value => [ "banana" ]
+  #       }
+  #     }
+  config :value, :validate => :array, :default => []
+
+  # The full path of the external file containing the value(s) to check against. Example:
+  # [source,ruby]
+  #     filter {
+  #       %PLUGIN% {
+  #         add_tag => [ "fruits" ]
+  #         field => [ "%{a}" ]
+  #         value_path => "/etc/logstash/fruits"
+  #       }
+  #     }
+  # NOTE: it is an error to specify both 'value' and 'value_path'.
+  config :value_path, :validate => :path
+
+  # When using a network list from a file, this setting will indicate
+  # how frequently (in seconds) Logstash will check the file for
+  # updates.
+  config :refresh_interval, :validate => :number, :default => 600
+
+  # The separator character used in the encoding of the external file
+  # pointed by value_path.
+  config :separator, :validate => :string, :default => "\n"
+
+  public
+  def register
+    rw_lock = java.util.concurrent.locks.ReentrantReadWriteLock.new
+    @read_lock = rw_lock.readLock
+    @write_lock = rw_lock.writeLock
+
+    if @value_path && !@value.empty? #checks if both value and value_path are defined in configuration options
+      raise LogStash::ConfigurationError, I18n.t(
+        "logstash.agent.configuration.invalid_plugin_register",
+        :plugin => "filter",
+        :type => "contains",
+        :error => "The configuration options 'value' and 'value_path' are mutually exclusive"
+      )
+    end
+
+    if !@value.empty?
+      @value_set = @value.to_set
+    end
+
+    if @value_path
+      @next_refresh = Time.now + @refresh_interval
+      lock_for_write { load_file }
+    end
+  end # def register
+
+  def lock_for_write
+    @write_lock.lock
+    begin
+      yield
+    ensure
+      @write_lock.unlock
+    end
+  end # def lock_for_write
+
+  def lock_for_read #ensuring only one thread updates the network block list
+    @read_lock.lock
+    begin
+      yield
+    ensure
+      @read_lock.unlock
+    end
+  end #def lock_for_read
+
+  def needs_refresh?
+    @next_refresh < Time.now
+  end # def needs_refresh
+
+  def load_file
+    begin
+      temporary = File.open(@value_path, "r") {|file| file.read.split(@separator)}
+      if !temporary.empty? #ensuring the file was parsed correctly
+        @value_set = temporary.to_set
+      else
+        @value_set = set
+      end
+    rescue
+      if @value_set #if the list was parsed successfully before
+        @logger.error("Error while opening/parsing the file")
+      else
+        raise LogStash::ConfigurationError, I18n.t(
+          "logstash.agent.configuration.invalid_plugin_register",
+          :plugin => "filter",
+          :type => "contains",
+          :error => "The file containing the network list is invalid, please check the separator character or permissions for the file."
+        )
+      end
+    end
+  end #def load_file
+
+  public
+  def filter(event)
+    field = @field.collect do |f|
+      begin
+        event.sprintf(f)
+      rescue ArgumentError => e
+        @logger.warn("Invalid field, skipping", :field => f, :event => event)
+        nil
+      end
+    end
+    field.compact!
+
+    if @value_path #in case we are getting values from an external file
+      if needs_refresh?
+        lock_for_write do
+          if needs_refresh?
+            load_file
+            @next_refresh = Time.now() + @refresh_interval
+          end
+        end #end lock
+      end #end refresh from file
+    end
+
+    field.each do |f|
+      @logger.debug("Checking value contains", :field => f, :value => @value_set)
+      if @value_set.member?(f)
+        filter_matched(event)
+        return
+      end
+    end
+  end # def filter
+end # class LogStash::Filters::CONTAINS

data/logstash-filter-contains.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-filter-contains'
+  s.version         = '1.0.0'
+  s.platform        = 'java'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "filter to check if value is contains"
+  s.description     = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
+  s.authors         = ["donghyeon kim"]
+  s.email           = 'wjstk2650@gmail.com'
+  s.homepage        = ""
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
+
+  # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
+
+  s.add_development_dependency 'logstash-devutils'
+end
+

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-contains
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: java
+authors:
+- donghyeon kim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  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/logstash-plugin install gemname. This
+  gem is not a stand-alone program
+email: wjstk2650@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTORS
+- Gemfile
+- LICENSE
+- README.md
+- docs/index.asciidoc
+- lib/logstash/filters/contains.rb
+- logstash-filter-contains.gemspec
+homepage: ''
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: filter
+post_install_message: 
+rdoc_options: []
+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.5.2
+signing_key: 
+specification_version: 4
+summary: filter to check if value is contains
+test_files: []