logstash-filter-json 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21c3986274848a665933e6c3f2a32046b9e9c23e
-  data.tar.gz: f013b87add842f4245230e364c8f1fe5ecf2c49b
+  metadata.gz: 75b6415ca4f107d636b1305a1cfa50f5fe6116a5
+  data.tar.gz: 4b1adb7d1a1b8c24fc464dfcdd055b4d0372115c
 SHA512:
-  metadata.gz: c2c3f0c30346606a5ec260ce250f25691b93686ef1000bade64b0304c04c6d67763471263e73153987dc8fee3efcb26133fb213b124183609c87fa7ac53dc694
-  data.tar.gz: 759dc98379f42d47bbe60cbbd7e91761bb7d9e46075740e732a4620ac977e8c441e3fb18217461f151be2fbd97c9d0f833d205b89c7dbed713291ef19069b584
+  metadata.gz: 9c4057279fe3c6911553fc383883bc41deaccaee6f3cad0f56298d451d2bcb870176aa9ea0cf24c81c98acf1b4b11b675803444d9a419e41fe80baa907472fae
+  data.tar.gz: aa96a6fd9b490b9967f62ef022ae380af6edd232a850f164496d81c41067623a5508c5b6fe6c3b00f3c35985c07aedc8c88d3e86e58896cbff54fc4e271c1a49

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.0.2
+  - Relax constraint on logstash-core-plugin-api to >= 1.60 <= 2.99
+
 ## 3.0.1
   - Republish all the gems under jruby.
 ## 3.0.0

data/lib/logstash/filters/json.rb

@@ -59,6 +59,9 @@ class LogStash::Filters::Json < LogStash::Filters::Base
   # successful match
   config :tag_on_failure, :validate => :array, :default => ["_jsonparsefailure"]
 
+  # Allow to skip filter on invalid json (allows to handle json and non-json data without warnings)
+  config :skip_on_invalid_json, :validate => :boolean, :default => false
+
   def register
     # Nothing to do here
   end
@@ -72,8 +75,10 @@ class LogStash::Filters::Json < LogStash::Filters::Base
     begin
       parsed = LogStash::Json.load(source)
     rescue => e
-      @tag_on_failure.each{|tag| event.tag(tag)}
-      @logger.warn("Error parsing json", :source => @source, :raw => source, :exception => e)
+      unless @skip_on_invalid_json
+        @tag_on_failure.each{|tag| event.tag(tag)}
+        @logger.warn("Error parsing json", :source => @source, :raw => source, :exception => e)
+      end
       return
     end
 

data/logstash-filter-json.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-filter-json'
-  s.version         = '3.0.1'
+  s.version         = '3.0.2'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This is a JSON parsing filter. It takes an existing field which contains JSON and expands it into an actual data structure within the Logstash event."
   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"
@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.metadata = { "logstash_plugin" => "true", "logstash_group" => "filter" }
 
   # Gem dependencies
-  s.add_runtime_dependency "logstash-core-plugin-api", "~> 2.0"
+  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
 
   s.add_development_dependency 'logstash-devutils'
 end

data/spec/filters/json_spec.rb

@@ -175,4 +175,51 @@ describe LogStash::Filters::Json do
       end
     end
   end
+
+  describe "parse mixture of json an non-json content (skip_on_invalid_json)" do
+    subject(:filter) {  LogStash::Filters::Json.new(config)  }
+
+    let(:config) { {"source" => "message", "remove_field" => ["message"], "skip_on_invalid_json" => skip_on_invalid_json} }
+    let(:event) { LogStash::Event.new("message" => message) }
+
+    before(:each) do
+      allow(filter.logger).to receive(:warn)
+      filter.register
+      filter.filter(event)
+    end
+
+    let(:message) { "this is not a json message" }
+
+    context "with `skip_on_invalid_json` set to false" do
+      let(:skip_on_invalid_json) { false }
+
+      it "sends a warning to the logger" do
+        expect(filter.logger).to have_received(:warn).with("Error parsing json", anything())
+      end
+
+      it "keeps the source field" do
+        expect(event.get("message")).to eq message
+      end
+
+      it "adds a parse-error tag" do
+        expect(event.get("tags")).to eq ["_jsonparsefailure"]
+      end
+    end
+
+    context "with `skip_on_invalid_json` set to true" do
+      let(:skip_on_invalid_json) { true }
+
+      it "sends no warning" do
+        expect(filter.logger).to_not have_received(:warn)
+      end
+
+      it "keeps the source field" do
+        expect(event.get("message")).to eq message
+      end
+
+      it "does not add a parse-error tag" do
+        expect(event.get("tags")).to be_nil
+      end
+    end
+  end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: logstash-filter-json
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-05-09 00:00:00.000000000 Z
+date: 2016-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.99'
   name: logstash-core-plugin-api
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.99'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -75,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.8
+rubygems_version: 2.6.3
 signing_key:
 specification_version: 4
 summary: This is a JSON parsing filter. It takes an existing field which contains JSON and expands it into an actual data structure within the Logstash event.