logstash-filter-kv 2.0.6 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 748ca82a1d9a0b967e92a494e7ea1ce307fee1f5
-  data.tar.gz: 0d64ccdbf5f4b00c231ded98b40d3a7a72877bb8
+  metadata.gz: 89fab778db6cbc596686f72f373c528ae84a92d5
+  data.tar.gz: 49a11f4d5b256a0ca5edc20d55708b5209065d8d
 SHA512:
-  metadata.gz: 24ef76707e5e5ab5211a3cd25ea1cdea757bfba96d2c8291e67fc0124029ce22828b944f010254adca5b60c8eca6d394d30e16b601e8703c01cd2d280d7354e5
-  data.tar.gz: bf90b0657aa8adb2edca85a11462bae35ccc026e9c1f8b8890f41fbee42e0433be1e21facc9a0cd510472b536ceeed38a0fad30f5c7b4ca3f80af26ac49a434c
+  metadata.gz: 4196694c4bd9ced68c2a538cce208c0cb72abcc1c301e4565f3b0253ebc3dc249daf5b109ea5a74a386688e2f4735430ca4748e921d63f09ee96546c9f5305ab
+  data.tar.gz: ec32f4fbd402c545f6a3d3177416eac8dbebd3e6768e41e4b9798af823a30fbae4393e474e1f81efcb975a91ca04c2ae9655b6fdb04c2e97d95e6a5cc3791bb4

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 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.
+
 # 2.0.6
   - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
 # 2.0.5

data/lib/logstash/filters/kv.rb

@@ -87,7 +87,7 @@ class LogStash::Filters::KV < LogStash::Filters::Base
   config :field_split, :validate => :string, :default => ' '
 
 
-  # A string of characters to use as delimiters for identifying key-value relations.
+  # A non-empty string of characters to use as delimiters for identifying key-value relations.
   #
   # These characters form a regex character class and thus you must escape special regex
   # characters like `[` or `]` using `\`.
@@ -173,8 +173,8 @@ class LogStash::Filters::KV < LogStash::Filters::Base
   #     }
   config :allow_duplicate_values, :validate => :boolean, :default => true
 
-  # A boolean specifying whether to include brackets as value `wrappers`
-  # (the default is true)
+  # A boolean specifying whether to treat square brackets, angle brackets,
+  # and parentheses as value "wrappers" that should be removed from the value.
   # [source,ruby]
   #     filter {
   #       kv {
@@ -183,17 +183,19 @@ class LogStash::Filters::KV < LogStash::Filters::Base
   #     }
   #
   # For example, the result of this line:
-  # `bracketsone=(hello world) bracketstwo=[hello world]`
+  # `bracketsone=(hello world) bracketstwo=[hello world] bracketsthree=<hello world>`
   #
   # will be:
   #
   # * bracketsone: hello world
   # * bracketstwo: hello world
+  # * bracketsthree: hello world
   #
   # instead of:
   #
   # * bracketsone: (hello
   # * bracketstwo: [hello
+  # * bracketsthree: <hello
   #
   config :include_brackets, :validate => :boolean, :default => true
 
@@ -212,11 +214,20 @@ class LogStash::Filters::KV < LogStash::Filters::Base
   config :recursive, :validate => :boolean, :default => false
 
   def register
+    if @value_split.empty?
+      raise LogStash::ConfigurationError, I18n.t(
+        "logstash.agent.configuration.invalid_plugin_register",
+        :plugin => "filter",
+        :type => "kv",
+        :error => "Configuration option 'value_split' must be a non-empty string"
+      )
+    end
+
     @trim_re = Regexp.new("[#{@trim}]") if @trim
     @trimkey_re = Regexp.new("[#{@trimkey}]") if @trimkey
 
     valueRxString = "(?:\"([^\"]+)\"|'([^']+)'"
-    valueRxString += "|\\(([^\\)]+)\\)|\\[([^\\]]+)\\]" if @include_brackets
+    valueRxString += "|\\(([^\\)]+)\\)|\\[([^\\]]+)\\]|<([^>]+)>" if @include_brackets
     valueRxString += "|((?:\\\\ |[^" + @field_split + "])+))"
     @scan_re = Regexp.new("((?:\\\\ |[^" + @field_split + @value_split + "])+)\s*[" + @value_split + "]\s*" + valueRxString)
     @value_split_re = /[#{@value_split}]/
@@ -266,8 +277,8 @@ class LogStash::Filters::KV < LogStash::Filters::Base
     include_keys = @include_keys.map{|key| event.sprintf(key)}
     exclude_keys = @exclude_keys.map{|key| event.sprintf(key)}
 
-    text.scan(@scan_re) do |key, v1, v2, v3, v4, v5|
-      value = v1 || v2 || v3 || v4 || v5
+    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
 
       # Bail out as per the values of include_keys and exclude_keys

data/logstash-filter-kv.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-kv'
-  s.version         = '2.0.6'
+  s.version         = '2.0.7'
   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"

data/spec/filters/kv_spec.rb

@@ -14,7 +14,7 @@ describe LogStash::Filters::KV do
       }
     CONFIG
 
-    sample "hello=world foo=bar baz=fizz doublequoted=\"hello world\" singlequoted='hello world' bracketsone=(hello world) bracketstwo=[hello world]" do
+    sample "hello=world foo=bar baz=fizz doublequoted=\"hello world\" singlequoted='hello world' bracketsone=(hello world) bracketstwo=[hello world] bracketsthree=<hello world>" do
       insist { subject["hello"] } == "world"
       insist { subject["foo"] } == "bar"
       insist { subject["baz"] } == "fizz"
@@ -22,6 +22,7 @@ describe LogStash::Filters::KV do
       insist { subject["singlequoted"] } == "hello world"
       insist { subject["bracketsone"] } == "hello world"
       insist { subject["bracketstwo"] } == "hello world"
+      insist { subject["bracketsthree"] } == "hello world"
     end
   end
 
@@ -629,4 +630,18 @@ describe LogStash::Filters::KV do
       end
     end
   end
+
+  describe "an empty value_split option should be reported" do
+    config <<-CONFIG
+      filter {
+        kv {
+          value_split => ""
+        }
+      }
+    CONFIG
+
+    sample("message" => "random message") do
+      insist { subject }.raises(LogStash::ConfigurationError)
+    end
+  end
 end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-kv
 version: !ruby/object:Gem::Version
-  version: 2.0.6
+  version: 2.0.7
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-03-30 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,7 +35,7 @@ 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
@@ -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.8
+rubygems_version: 2.4.5
 signing_key:
 specification_version: 4
 summary: This filter helps automatically parse messages (or specific event fields) which are of the 'foo=bar' variety.