logstash-filter-kv 2.0.7 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89fab778db6cbc596686f72f373c528ae84a92d5
-  data.tar.gz: 49a11f4d5b256a0ca5edc20d55708b5209065d8d
+  metadata.gz: 63ffef94da43256770287a0a3f1e25791617f74a
+  data.tar.gz: e36145dfaf5d8184e4dd7d60418c9c36dcfab319
 SHA512:
-  metadata.gz: 4196694c4bd9ced68c2a538cce208c0cb72abcc1c301e4565f3b0253ebc3dc249daf5b109ea5a74a386688e2f4735430ca4748e921d63f09ee96546c9f5305ab
-  data.tar.gz: ec32f4fbd402c545f6a3d3177416eac8dbebd3e6768e41e4b9798af823a30fbae4393e474e1f81efcb975a91ca04c2ae9655b6fdb04c2e97d95e6a5cc3791bb4
+  metadata.gz: f7bd945d5df9b1eaae90b399910612d5236c8ff0bcf55ab4feedbe87995e39a0dcb09cccc3139a6afd2dafdaf998ed1ed02625f31a957e76cae812285fc72780
+  data.tar.gz: ff374c0ac7d74d7c2f3f772a28481c89122cc21fcac883843a4873475c508d71f31e85eec0aac4a11baa947ea9a624e3bfbcfbfaf8128f6ded14c5082271681b

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 2.1.0
+  - Adds :transform_value and :transform_key options to lowercase/upcase or capitalize all keys/values
+
 # 2.0.7
   - With include_brackets enabled, angle brackets (\< and \>) are treated the same as square brackets and parentheses, making it easy to parse strings like "a=\<b\> c=\<d\>".
   - An empty value_split option value now gives a useful error message.

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+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.

data/README.md

@@ -1,7 +1,6 @@
 # Logstash Plugin
 
-[![Build
-Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Filters/job/logstash-plugin-filter-kv-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Filters/job/logstash-plugin-filter-kv-unit/)
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-filter-kv.svg)](https://travis-ci.org/logstash-plugins/logstash-filter-kv)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 
@@ -56,7 +55,12 @@ 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
@@ -74,7 +78,12 @@ gem build logstash-filter-awesome.gemspec
 ```
 - Install the plugin from the Logstash home
 ```sh
-bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+# 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
 

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,10 +1,10 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-kv'
-  s.version         = '2.0.7'
+  s.version         = '2.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/plugin install gemname. This gem is not a stand-alone program"
+  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         = ["Elastic"]
   s.email           = 'info@elastic.co'
   s.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"

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["HELLO"] } == "world"
+      insist { subject["FOO"] } == "bar"
+      insist { subject["BAZ"] } == "fizz"
+      insist { subject["DOUBLEQUOTED"] } == "hello world"
+      insist { subject["SINGLEQUOTED"] } == "hello world"
+      insist { subject["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["hello"] } == "WORLD"
+      insist { subject["foo"] } == "BAR"
+      insist { subject["baz"] } == "FIZZ"
+      insist { subject["doublequoted"] } == "HELLO WORLD"
+      insist { subject["singlequoted"] } == "HELLO WORLD"
+      insist { subject["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["Hello"] } == "World"
+      insist { subject["Foo"] } == "Bar"
+      insist { subject["Baz"] } == "Fizz"
+      insist { subject["Doublequoted"] } == "Hello world"
+      insist { subject["Singlequoted"] } == "Hello world"
+      insist { subject["Brackets"] } == "Hello world"
+    end
+  end
+
   describe  "test spaces attached to the field_split" do
     config <<-CONFIG
       filter {

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-kv
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.1.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-30 00:00:00.000000000 Z
+date: 2016-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   name: logstash-core-plugin-api
@@ -21,13 +21,13 @@ dependencies:
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   name: logstash-devutils
@@ -35,10 +35,10 @@ dependencies:
   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
+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: []
 extensions: []
@@ -65,17 +65,17 @@ 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
+rubygems_version: 2.6.3
 signing_key:
 specification_version: 4
 summary: This filter helps automatically parse messages (or specific event fields) which are of the 'foo=bar' variety.