logstash-filter-math 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 688ef95d7c3e22368cc2f22096bdc92a607837f2
+  data.tar.gz: 959e396a772352c39d644b510f6e462d31659a22
+SHA512:
+  metadata.gz: f1e9fa9e6e35566f0de7645bb48335551ccb58fc722ab706845e7acc0f30f6021db570a9e6f32cf3317762aa4c3cc154db47c734f9dbe45c639710af20df2296
+  data.tar.gz: 7dc97ea5d30cd5f2f17cec357b433141487e132861cca54afeee1970c8edc060db57f5173473a197f6c049f686649161ec0a3c39e6c8f3c8608ae4d8a9106c48

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+Gemfile.lock
+.bundle
+vendor

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+#gem "logstash", :github => "elastic/logstash", :branch => "1.5"

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012-2015 Elastics.co <http://www.elastics.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,86 @@
+# 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.org/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 logstash-users@googlegroups.com mailing list.
+
+## 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
+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
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- 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/Rakefile

@@ -0,0 +1,2 @@
+require "logstash/devutils/rake"
+require "logstash/devutils/rake"

data/lib/logstash/filters/math.rb

@@ -0,0 +1,68 @@
+require "logstash/filters/base"
+require "logstash/namespace"
+# Do various simple math operations
+# Configuration:
+# filter {
+#   math {
+#     calculate => [
+#         [ "add", "a_field1", "a_field2", "a_target" ],   # a + b => target
+#         [ "sub", "b_field1", "b_field2", "b_target" ],   # a - b => target
+#         [ "div", "c_field1", "c_field2", "c_target" ],   # a / b => target
+#         [ "mpx", "d_field1", "d_field2", "d_target" ]    # a * b => target
+#     ]
+#   }
+# }
+# Multiple calculations can be executed with one call
+#
+# Sequence of processing is as they are listed, so processing of just-generated fields is
+# possible as long as it is done in the correct sequence.
+#
+# Works with float and integer values
+
+class LogStash::Filters::Math < LogStash::Filters::Base
+  config_name "math"
+
+  # fields - second subtracted from the first
+  config :calculate, :validate => :array, :required => true
+
+  public
+  def register
+    # Do some sanity checks that calculate is actually an array-of-arrays, and that each calculation (sub-array)
+    # is exactly 4 fields and the first field is a valid calculation opperator name.
+    for calculation in calculate do
+      if calculation.length % 4 != 0
+        abort("Each calculation must have 4 elements, this one had " + calculation.length + " " + calculation.to_s )
+      end # end calculaction.length is 4
+      if ! calculation[0].match('^(add|sub|div|mpx)$' )
+        abort("First element of a calculation must be add|sub|div|mpx, but is: " + calculation[0] )
+      end # if calculation[0] valid
+    end # for each calculate
+  end # def register
+
+  public
+  def filter(event)
+    return unless filter?(event)
+    for calculation in calculate do
+      # Check that all the fields exist and are numeric
+      next unless event.include?(calculation[1])
+      next unless event.include?(calculation[2])
+      next unless event[calculation[1]] == 0 or event[calculation[1]].is_a? Float or event[calculation[1]].is_a? Integer
+      next unless event[calculation[2]] == 0 or event[calculation[2]].is_a? Float or event[calculation[2]].is_a? Integer
+      case calculation[0]
+      when "add"
+        event[calculation[3]] = event[calculation[1]] + event[calculation[2]]
+      when "sub"
+        event[calculation[3]] = event[calculation[1]] - event[calculation[2]]
+      when "div"
+        # Avoid division by zero
+        next if event[calculation[2]] == 0
+        event[calculation[3]] = event[calculation[1]].to_f / event[calculation[2]]
+      when "mpx"
+        event[calculation[3]] = event[calculation[1]] * event[calculation[2]]
+      end # case calculation[0]
+    end # for each calculate
+    filter_matched(event)
+  end # def filter
+end # class LogStash::Filters::Math
+
+

data/logstash-filter-math.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+  s.name            = 'logstash-filter-math'
+  s.version         = '0.1'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "Do simple math functions on numeric fields."
+  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"
+  s.authors         = ["Elastics.co"]
+  s.email           = 'info@elastics.co'
+  s.homepage        = "http://www.elastics.co/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)
+
+  # 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", '>= 1.4.0', '< 2.0.0'
+
+  s.add_development_dependency 'logstash-devutils'
+end
+

data/spec/filters/math_spec.rb

@@ -0,0 +1,202 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/filters/math"
+
+describe LogStash::Filters::Math do
+   
+  describe "Additions" do
+    # The logstash config.
+    config <<-CONFIG
+      filter {  math { calculate => [ [ "add", "var1", "var2", "result" ] ] } }
+    CONFIG
+  
+    describe "should add two integers" do
+      sample( "var1" => -2,  "var2" => 7 ) do
+        expect( subject["result"] ).to eq( 5 )
+      end
+    end
+    
+    describe "should add two floats" do
+      sample( "var1" => -2.4,  "var2" => 7.8 ) do
+        expect( subject["result"] ).to eq( 5.4  )
+      end
+    end
+    
+    describe "two huge numbers should add to infinity" do
+      sample( "var1" => 1.79769313486232e+308,  "var2" => 1e+308 ) do
+        expect( subject["result"] ).to eq( Float::INFINITY )
+      end
+    end
+
+    describe "one value being 0 should work" do
+      sample( "var1" => 0,  "var2" => 7.8 ) do
+        expect( subject["result"] ).to eq( 7.8 )
+      end
+    end
+
+    describe "first value missing should result in nil" do
+      sample( "var2" => 3 ) do
+        expect( subject["result"] ).to be_nil
+      end
+    end
+  
+    describe "Second value missing should result in nil" do
+      sample( "var1" => 3 ) do
+        expect( subject["result"] ).to be_nil
+      end
+    end
+  end
+
+  describe "Subtractions" do
+    # The logstash config.
+    config <<-CONFIG
+      filter {  math { calculate => [ [ "sub", "var1", "var2", "result" ] ] } }
+    CONFIG
+  
+    describe "should subtract two integers" do
+      sample( "var1" => -2,  "var2" => 7 ) do
+        expect( subject["result"] ).to eq( -9 )
+      end
+    end
+    
+    describe "should subtract two floats" do
+      sample( "var1" => -2.4,  "var2" => 7.8 ) do
+        expect( subject["result"] ).to eq( -10.2  )
+      end
+    end
+    
+    describe "two huge negative numbers should subtract to negative infinity" do
+      sample( "var1" => -1.79769313486232e+308,  "var2" => -1e+308 ) do
+        expect( subject["result"] ).to eq( -Float::INFINITY )
+      end
+    end
+    
+    describe "one value being 0 should work" do
+      sample( "var1" => 0,  "var2" => 7.8 ) do
+        expect( subject["result"] ).to eq( -7.8 )
+      end
+    end
+
+    describe "first value missing should result in nil" do
+      sample( "var2" => 3 ) do
+        expect( subject["result"] ).to be_nil
+      end
+    end
+    
+    describe "Second value missing should result in nil" do
+      sample( "var1" => 3 ) do
+        expect( subject["result"] ).to be_nil
+      end
+    end
+  end
+
+  describe "Multiplication" do
+    # The logstash config.
+    config <<-CONFIG
+      filter {  math { calculate => [ [ "mpx", "var1", "var2", "result" ] ] } }
+    CONFIG
+  
+    describe "should multiply two integers" do
+      sample( "var1" => -2,  "var2" => 7 ) do
+        expect( subject["result"] ).to eq( -14 )
+      end
+    end
+    
+    describe "should multiply two floats" do
+      sample( "var1" => -2.4,  "var2" => 7.8 ) do
+        expect( subject["result"] ).to eq( -18.72 )
+      end
+    end
+    
+    describe "two huge numbers should multiply to infinity" do
+      sample( "var1" => 1.79769313486232e+300,  "var2" => 1e+300 ) do
+        expect( subject["result"] ).to eq( Float::INFINITY )
+      end
+    end
+    
+    describe "one value being 0 should result in 0" do
+      sample( "var1" => 0,  "var2" => 7.8 ) do
+        expect( subject["result"] ).to eq( 0 )
+      end
+    end
+
+    describe "first value missing should result in nil" do
+      sample( "var2" => 3 ) do
+        expect( subject["result"] ).to be_nil
+      end
+    end
+    
+    describe "Second value missing should result in nil" do
+      sample( "var1" => 3 ) do
+        expect( subject["result"] ).to be_nil
+      end
+    end
+  end
+
+  describe "Division" do
+    # The logstash config.
+    config <<-CONFIG
+      filter {  math { calculate => [ [ "div", "var1", "var2", "result" ] ] } }
+    CONFIG
+  
+    describe "should divide two integers" do
+      sample( "var1" => -2,  "var2" => 7 ) do
+        expect( subject["result"] ).to eq( -0.2857142857142857 )
+      end
+    end
+    
+    describe "should divide two floats" do
+      sample( "var1" => -2.4,  "var2" => 7.8 ) do
+        expect( subject["result"] ).to eq( -0.3076923076923077 )
+      end
+    end
+    
+    describe "1 divided by a huge number should give zero" do
+      sample( "var1" => 1, "var2" => 1.79769313486232e+308 ) do
+        expect( subject["result"] ).to eq( 0 )
+      end
+    end
+    
+    describe "First variable being zero should result in 0" do
+      sample( "var1" => 0,  "var2" => 7.8 ) do
+        expect( subject["result"] ).to eq( 0 )
+      end
+    end
+    
+    describe "Second variable being zero should result in nil (would be infinity, but this can't be represented in JSON)" do
+      sample( "var1" => 2,  "var2" => 0 ) do
+        expect( subject["result"] ).to be_nil
+      end
+    end
+
+    describe "first value missing should result in nil" do
+      sample( "var2" => 3 ) do
+        expect( subject["result"] ).to be_nil
+      end
+    end
+    
+    describe "Second value missing should result in nil" do
+      sample( "var1" => 3 ) do
+        expect( subject["result"] ).to be_nil
+      end
+    end
+  end
+  
+  describe "Sequence" do
+    # The logstash config.
+    config <<-CONFIG
+      filter {  math { calculate => [ 
+          [ "add", "var1", "var2", "r1" ],
+          [ "sub", "var3", "var4", "r2" ],
+          [ "mpx", "r1", "r2", "result" ]
+          ] } }
+    CONFIG
+  
+    describe "results of one calculation can be used in the next calculation"
+      sample( "var1" => 3.4,  "var2" => 6.6, "var3" => 4.4, "var4" => 2.4 ) do
+        # I would really expect 20.0 here... what kind of floating point error is this?!
+        expect( subject["result"] ).to eq( 20.000000000000004 )
+      end
+    end
+
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: logstash-filter-math
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Elastics.co
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-06-29 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
+  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
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  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
+email: info@elastics.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/logstash/filters/math.rb
+- logstash-filter-math.gemspec
+- spec/filters/math_spec.rb
+homepage: http://www.elastics.co/guide/en/logstash/current/index.html
+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.4.5
+signing_key:
+specification_version: 4
+summary: Do simple math functions on numeric fields.
+test_files:
+- spec/filters/math_spec.rb