logstash-filter-ruby 3.0.2 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d37b548007d87f94ac0e0d9d3826f08d861e70ee
-  data.tar.gz: 8fdf8080f42d9ac002cc2253496969ef5e6a8ae2
+  metadata.gz: 4a8891ff589543e9c6b32a92fb0e00bf2d1c183f
+  data.tar.gz: 8ce01783279280b5d28267e9fcdab6ee7cbb49fc
 SHA512:
-  metadata.gz: c5b474c54c025b3d43fb8cfe1b67f6ea83a82bc787b56d6d304dcc9f8bc43e0f712bd569a091b69e751c63f97aae7a256d2be9f6fa38aed943de3665daf98bc4
-  data.tar.gz: 160597360b990a703014ad66c5ee7c21b8be5b12ff32244678535bbe9919b0b48ed58e6c74061fcf1fdbfdcb6c4341491a625ed0756b62be5a85814fea5e6e9f
+  metadata.gz: 2fc859119ec3eda898ed2fa0b023efc53d45e07c6eb0270060e895a9375e710ca58c0ab030591dfd95b6a200017898dc9aa6852ee89b9e44310ac0e456c5d133
+  data.tar.gz: 1df337ed914ffddb74265e962af81e80d1c38fec4ab5d02472b0f3333afc5a03d97b98f7cf1403744be2e1b6866583a7b890a936297e41f38d727bffe915eed6

data/Gemfile

@@ -1,4 +1,11 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in logstash-mass_effect.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/docs/index.asciidoc

@@ -0,0 +1,82 @@
+:plugin: ruby
+: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}-{plugin}"]
+
+=== Ruby filter plugin
+
+include::{include_path}/plugin_header.asciidoc[]
+
+==== Description
+
+Execute ruby code.
+
+For example, to cancel 90% of events, you can do this:
+[source,ruby]
+    filter {
+      ruby {
+        # Cancel 90% of events
+        code => "event.cancel if rand <= 0.90"
+      }
+    }
+
+If you need to create additional events, it cannot be done as in other filters where you would use `yield`,
+you must use a specific syntax `new_event_block.call(event)` like in this example duplicating the input event
+[source,ruby]
+filter {
+  ruby {
+    code => "new_event_block.call(event.clone)"
+  }
+}
+
+
+[id="plugins-{type}s-{plugin}-options"]
+==== Ruby 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}-code>> |<<string,string>>|Yes
+| <<plugins-{type}s-{plugin}-init>> |<<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}-code"]
+===== `code` 
+
+  * This is a required setting.
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+The code to execute for every event.
+You will have an `event` variable available that is the event itself. See the <<event-api,Event API>> for more information.
+
+[id="plugins-{type}s-{plugin}-init"]
+===== `init` 
+
+  * Value type is <<string,string>>
+  * There is no default value for this setting.
+
+Any code to execute at logstash startup-time
+
+
+
+[id="plugins-{type}s-{plugin}-common-options"]
+include::{include_path}/{type}.asciidoc[]

data/lib/logstash/filters/ruby.rb

@@ -29,7 +29,7 @@ class LogStash::Filters::Ruby < LogStash::Filters::Base
   config :init, :validate => :string
 
   # The code to execute for every event.
-  # You will have an `event` variable available that is the event itself.
+  # You will have an `event` variable available that is the event itself. See the <<event-api,Event API>> for more information.
   config :code, :validate => :string, :required => true
 
   def register

data/logstash-filter-ruby.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-ruby'
-  s.version         = '3.0.2'
+  s.version         = '3.0.3'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Filter for executing ruby code on the event"
   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"
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # Files
-  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+  s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
 
   # Tests
   s.test_files = s.files.grep(%r{^(test|spec|features)/})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-ruby
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.3
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-07-14 00:00:00.000000000 Z
+date: 2017-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -70,6 +70,7 @@ files:
 - LICENSE
 - NOTICE.TXT
 - README.md
+- docs/index.asciidoc
 - lib/logstash/filters/ruby.rb
 - logstash-filter-ruby.gemspec
 - spec/filters/ruby_spec.rb
@@ -95,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.3
+rubygems_version: 2.4.8
 signing_key:
 specification_version: 4
 summary: Filter for executing ruby code on the event