logstash-filter-kv 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c3a30f76a6b29f2c91f79432efd228a4c1738c5
-  data.tar.gz: b7feb914934bb80c192f2417677fa821e43f79a0
+  metadata.gz: a5b62e210c5764ad9af5185a3a18806a811dee71
+  data.tar.gz: 638c1ce5512591a29bf4b501d727fd36e42f5c80
 SHA512:
-  metadata.gz: 08612fb7ba9e11af65575bb0cb6c0e693d29bf400737ec8a7502e31c4483acd4b34c0bbd652c908e1b0368e5b795b1a30e10161b8f193a6a4f0f84d5bb06a571
-  data.tar.gz: da170f52b4dca7c396fda8c9a0307d5ccf01f3182efb1985931d80385ccffda72294994efd9aceafcb1b47da52d915323f67eff2a61d438e0e9cdd81b0905f44
+  metadata.gz: 37fa6c205f3151745222a53dd25e3083ae8fc048008f45a2f6300e3402c61953d7b4c798353697486da5964afe48d77828cd869872e20c02fc8c7f1dc7648de3
+  data.tar.gz: 847df25bdce86f4f22fa1f8e716f88cd7d7bce4fa0a698f2752a4f96d161a63d3f6196abf11bd18a2bb9dc71593592f1bc9f4906d89664f8d6bf54e736d6a1f6

data/CHANGELOG.md

@@ -1,3 +1,5 @@
+## 3.1.0
+  - Adds :transform_value and :transform_key options to lowercase/upcase or capitalize all keys/values
 ## 3.0.1
   - Republish all the gems under jruby.
 ## 3.0.0

data/lib/logstash/filters/kv.rb

@@ -29,6 +29,11 @@ require "logstash/namespace"
 class LogStash::Filters::KV < LogStash::Filters::Base
   config_name "kv"
 
+  # Constants used for transform check
+  TRANSFORM_LOWERCASE_KEY = "lowercase"
+  TRANSFORM_UPPERCASE_KEY = "uppercase"
+  TRANSFORM_CAPITALIZE_KEY = "capitalize"
+
   # A string of characters to trim from the value. This is useful if your
   # values are wrapped in brackets or are terminated with commas (like postfix
   # logs).
@@ -60,6 +65,28 @@ class LogStash::Filters::KV < LogStash::Filters::Base
   #     }
   config :trimkey, :validate => :string
 
+  # Transform values to lower case, upper case or capitals.
+  #
+  # For example, to capitalize all values:
+  # [source,ruby]
+  #     filter {
+  #       kv {
+  #         transform_value => "capitalize"
+  #       }
+  #     }
+  config :transform_value, :validate => [TRANSFORM_LOWERCASE_KEY, TRANSFORM_UPPERCASE_KEY, TRANSFORM_CAPITALIZE_KEY]
+
+  # Transform keys to lower case, upper case or capitals.
+  #
+  # For example, to lowercase all keys:
+  # [source,ruby]
+  #     filter {
+  #       kv {
+  #         transform_key => "lowercase"
+  #       }
+  #     }
+  config :transform_key, :validate => [TRANSFORM_LOWERCASE_KEY, TRANSFORM_UPPERCASE_KEY, TRANSFORM_CAPITALIZE_KEY]
+
   # A string of characters to use as delimiters for parsing out key-value pairs.
   #
   # These characters form a regex character class and thus you must escape special regex
@@ -269,6 +296,17 @@ class LogStash::Filters::KV < LogStash::Filters::Base
     s =~ @value_split_re
   end
 
+  def transform(text, method)
+    case method
+    when TRANSFORM_LOWERCASE_KEY
+      return text.downcase
+    when TRANSFORM_UPPERCASE_KEY
+      return text.upcase
+    when TRANSFORM_CAPITALIZE_KEY
+      return text.capitalize
+    end
+  end
+
   def parse(text, event, kv_keys)
     # short circuit parsing if the text does not contain the @value_split
     return kv_keys unless has_value_splitter?(text)
@@ -280,6 +318,7 @@ class LogStash::Filters::KV < LogStash::Filters::Base
     text.scan(@scan_re) do |key, v1, v2, v3, v4, v5, v6|
       value = v1 || v2 || v3 || v4 || v5 || v6
       key = @trimkey ? key.gsub(@trimkey_re, "") : key
+      key = @transform_key ? transform(key, @transform_key) : key
 
       # Bail out as per the values of include_keys and exclude_keys
       next if not include_keys.empty? and not include_keys.include?(key)
@@ -289,6 +328,7 @@ class LogStash::Filters::KV < LogStash::Filters::Base
       key = event.sprintf(@prefix) + key
 
       value = @trim ? value.gsub(@trim_re, "") : value
+      value = @transform_value ? transform(value, @transform_value) : value
 
       # Bail out if inserting duplicate value in key mapping when unique_values
       # option is set to true.

data/logstash-filter-kv.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-kv'
-  s.version         = '3.0.1'
+  s.version         = '3.1.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This filter helps automatically parse messages (or specific event fields) which are of the 'foo=bar' variety."
   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"

data/spec/filters/kv_spec.rb

@@ -26,6 +26,66 @@ describe LogStash::Filters::KV do
     end
   end
 
+  describe  "test transforming keys to uppercase and values to lowercase" do
+    config <<-CONFIG
+      filter {
+        kv {
+          transform_key => "uppercase"
+          transform_value => "lowercase"
+        }
+      }
+    CONFIG
+
+    sample "hello = world Foo =Bar BAZ= FIZZ doublequoteD = \"hellO worlD\" Singlequoted= 'Hello World' brAckets =(hello World)" do
+      insist { subject.get("HELLO") } == "world"
+      insist { subject.get("FOO") } == "bar"
+      insist { subject.get("BAZ") } == "fizz"
+      insist { subject.get("DOUBLEQUOTED") } == "hello world"
+      insist { subject.get("SINGLEQUOTED") } == "hello world"
+      insist { subject.get("BRACKETS") } == "hello world"
+    end
+  end
+
+  describe  "test transforming keys to lowercase and values to uppercase" do
+    config <<-CONFIG
+      filter {
+        kv {
+          transform_key => "lowercase"
+          transform_value => "uppercase"
+        }
+      }
+    CONFIG
+
+    sample "Hello = World fOo =bar baz= FIZZ DOUBLEQUOTED = \"hellO worlD\" singlequoted= 'hEllo wOrld' brackets =(HELLO world)" do
+      insist { subject.get("hello") } == "WORLD"
+      insist { subject.get("foo") } == "BAR"
+      insist { subject.get("baz") } == "FIZZ"
+      insist { subject.get("doublequoted") } == "HELLO WORLD"
+      insist { subject.get("singlequoted") } == "HELLO WORLD"
+      insist { subject.get("brackets") } == "HELLO WORLD"
+    end
+  end
+
+  describe  "test transforming keys and values to capitals" do
+    config <<-CONFIG
+      filter {
+        kv {
+          transform_key => "capitalize"
+          transform_value => "capitalize"
+        }
+      }
+    CONFIG
+
+    sample "Hello = World fOo =bar baz= FIZZ DOUBLEQUOTED = \"hellO worlD\" singlequoted= 'hEllo wOrld' brackets =(HELLO world)" do
+      insist { subject.get("Hello") } == "World"
+      insist { subject.get("Foo") } == "Bar"
+      insist { subject.get("Baz") } == "Fizz"
+      insist { subject.get("Doublequoted") } == "Hello world"
+      insist { subject.get("Singlequoted") } == "Hello world"
+      insist { subject.get("Brackets") } == "Hello world"
+    end
+  end
+
   describe  "test spaces attached to the field_split" do
     config <<-CONFIG
       filter {

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-kv
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2016-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: logstash-core-plugin-api
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.0'
-  name: logstash-core-plugin-api
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
+        version: '0'
   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/logstash-plugin install gemname. This gem is not a stand-alone program
 email: info@elastic.co
 executables: []
@@ -65,12 +65,12 @@ 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: []