logstash-filter-mutate 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d26ee5529a4d9879fb70a0267ce32060712f100
-  data.tar.gz: a18fdc2cc2140ccbc6bab53086642c9e51cb78bb
+  metadata.gz: 2deb0b46d89acc42b78efb99ca7b9ff488c0549a
+  data.tar.gz: 3fcf4bdb6d92975fcb936a5f215587b3d1b0c0d8
 SHA512:
-  metadata.gz: ad38c92e66e0a5dc47d8dac485a8e2c16619b8c50b9c068f6f15c7fe2bf3275fa1fd7b0da1a94b123e5f6486442da6a7122922cf9051970e9ae4284291cbd744
-  data.tar.gz: c6a00cc9e2a431f0fdb1674ceb6cfc2284f0a6e8e623f12601f9d51b1b3fb0f129ae2aaed5fbf4e63198ab63609d4a116398e6b4f55c324cb1389de67d732178
+  metadata.gz: 9cfdca9495c7a3c22c29886a4724aa9549f43a6ab6f7754e48d236cd212135bdcc3849e449b4df45719c07e8373474e6734e7c6f4a79b489db59170a367d5b63
+  data.tar.gz: 0322e26d0696ac60709dd205df9377a91016d8d510e4496cc6e459e436f684140dc5ecd3232980958c0e940617149ef5a1c6123e03873990fcd13e270e36c01f

data/lib/logstash/filters/mutate.rb

@@ -63,7 +63,13 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
   # integer. If the field value is an array, all members will be converted.
   # If the field is a hash, no action will be taken.
   #
-  # Valid conversion targets are: integer, float, string.
+  # If the conversion type is `boolean`, the acceptable values are:
+  # **True:** `true`, `t`, `yes`, `y`, and `1`
+  # **False:** `false`, `f`, `no`, `n`, and `0`
+  # "true" and "false".  If a value other than these is provided, it will
+  # pass straight through and log a warning message.
+  #
+  # Valid conversion targets are: integer, float, string, and boolean.
   #
   # Example:
   # [source,ruby]
@@ -172,7 +178,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
 
   public
   def register
-    valid_conversions = %w(string integer float)
+    valid_conversions = %w(string integer float boolean)
     # TODO(sissel): Validate conversion requests if provided.
     @convert.nil? or @convert.each do |field, type|
       if !valid_conversions.include?(type)
@@ -254,8 +260,7 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
     @convert.each do |field, type|
       next unless event.include?(field)
       original = event[field]
-
-      # calls convert_{string,integer,float} depending on type requested.
+      # calls convert_{string,integer,float,boolean} depending on type requested.
       converter = method("convert_" + type)
       if original.nil?
         next
@@ -288,6 +293,13 @@ class LogStash::Filters::Mutate < LogStash::Filters::Base
     return value.to_f
   end # def convert_float
 
+  def convert_boolean(value)
+    return true if value =~ (/^(true|t|yes|y|1)$/i)
+    return false if value.empty? || value =~ (/^(false|f|no|n|0)$/i)
+    @logger.warn("Failed to convert #{value} into boolean.")
+    return value
+  end # def convert_boolean
+
   private
   def gsub(event)
     @gsub_parsed.each do |config|

data/logstash-filter-mutate.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-mutate'
-  s.version         = '0.1.6'
+  s.version         = '0.1.7'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "The mutate filter allows you to perform general mutations on fields. You can rename, remove, replace, and modify fields in your events."
   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"
@@ -25,4 +25,3 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'logstash-filter-grok'
   s.add_development_dependency 'logstash-devutils'
 end
-

data/spec/filters/mutate_spec.rb

@@ -114,6 +114,52 @@ describe LogStash::Filters::Mutate do
     end
   end
 
+  describe "convert strings to boolean values" do
+    config <<-CONFIG
+      filter {
+        mutate {
+          convert => { "true_field"  => "boolean" }
+          convert => { "false_field" => "boolean" }
+          convert => { "true_upper"  => "boolean" }
+          convert => { "false_upper" => "boolean" }
+          convert => { "true_one"    => "boolean" }
+          convert => { "false_zero"  => "boolean" }
+          convert => { "true_yes"    => "boolean" }
+          convert => { "false_no"    => "boolean" }
+          convert => { "true_y"      => "boolean" }
+          convert => { "false_n"     => "boolean" }
+          convert => { "wrong_field" => "boolean" }
+        }
+      }
+    CONFIG
+    event = {
+      "true_field"  => "true",
+      "false_field" => "false",
+      "true_upper"  => "True",
+      "false_upper" => "False",
+      "true_one"    => "1",
+      "false_zero"  => "0",
+      "true_yes"    => "yes",
+      "false_no"    => "no",
+      "true_y"      => "Y",
+      "false_n"     => "N",
+      "wrong_field" => "none of the above"
+    }
+    sample event do
+      expect(subject["true_field"] ).to eq(true)
+      expect(subject["false_field"]).to eq(false)
+      expect(subject["true_upper"] ).to eq(true)
+      expect(subject["false_upper"]).to eq(false)
+      expect(subject["true_one"]   ).to eq(true)
+      expect(subject["false_zero"] ).to eq(false)
+      expect(subject["true_yes"]   ).to eq(true)
+      expect(subject["false_no"]   ).to eq(false)
+      expect(subject["true_y"]     ).to eq(true)
+      expect(subject["false_n"]    ).to eq(false)
+      expect(subject["wrong_field"]).to eq("none of the above")
+    end
+  end
+
   describe "gsub on a String" do
     config '
       filter {
@@ -382,4 +428,3 @@ describe LogStash::Filters::Mutate do
   end
 
 end
-

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-mutate
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-04-20 00:00:00.000000000 Z
+date: 2015-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  requirement: !ruby/object:Gem::Requirement
+  name: logstash-core
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -19,10 +20,7 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 2.0.0
-  name: logstash-core
-  prerelease: false
-  type: :runtime
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
@@ -30,48 +28,50 @@ dependencies:
     - - <
       - !ruby/object:Gem::Version
         version: 2.0.0
+  prerelease: false
+  type: :runtime
 - !ruby/object:Gem::Dependency
+  name: logstash-patterns-core
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-patterns-core
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-filter-grok
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-filter-grok
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '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@elastic.co
 executables: []
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.1.9
+rubygems_version: 2.2.2
 signing_key:
 specification_version: 4
 summary: The mutate filter allows you to perform general mutations on fields. You can rename, remove, replace, and modify fields in your events.