logstash-input-gelf 2.0.5 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f27853975b76062b44845eeec5bc56c2aef98744
-  data.tar.gz: b45085314c95cc08aa1bde4472cd77b6ce5ce696
+  metadata.gz: 158054a93311590d65d56a3ff79aa12c56092d23
+  data.tar.gz: b469cff4004b9f25dc4e3f389e9a2b006d09417f
 SHA512:
-  metadata.gz: 75d4a43e78b2c71359392ef45157ebb2f5c4a3deef26808df9acc2d4cac21855e5234f4eb6d595b203192f406188e055e646b183dc23d8c39cdf6be60cd5d5d7
-  data.tar.gz: 6352f3f823a587f374199bdf64b23d8e886fa25ca7f8f4497510ad1fa34f39c75339517e0b907511025983b7e4957dcd2fbade742a361d403b15e92fa686fb34
+  metadata.gz: 213969545dfabb0868b5796ffe90aefb0a065fd63872338bbb9423eae1bc088365e54c69a446da2ef1075c65de431dbf3dfee9d8081592b1264f64aeda22e2a0
+  data.tar.gz: 6708cfb23edfeac1c79bfa104c676e024baac35e42e2e367d6f597b83f4ba30b61757023bdeb444fdf250988f315c365d20e85a697b7d79c37d52565ed292280

data/CHANGELOG.md

@@ -1,12 +1,14 @@
+# 2.0.7
+  - Fix failing test caused by reverting Java Event back to Ruby Event
+# 2.0.6
+  - Fix plugin crash when Logstash::Json fails to parse a message, https://github.com/logstash-plugins/logstash-input-gelf/pull/27
 # 2.0.5
   - Depend on logstash-core-plugin-api instead of logstash-core, removing the need to mass update plugins on major releases of logstash
 # 2.0.4
   - New dependency requirements for logstash-core for the 5.0 release
-## 2.0.3
+# 2.0.3
  - Fix Timestamp coercion to preserve upto microsecond precision, https://github.com/logstash-plugins/logstash-input-gelf/pull/35
-
-## 2.0.0
+# 2.0.0
  - Plugins were updated to follow the new shutdown semantic, this mainly allows Logstash to instruct input plugins to terminate gracefully,
    instead of using Thread.raise on the plugins' threads. Ref: https://github.com/elastic/logstash/pull/3895
  - Dependency on logstash-core update to 2.0
-

data/CONTRIBUTORS

@@ -15,6 +15,7 @@ Contributors:
 * Richard Pijnenburg (electrical)
 * Suyog Rao (suyograo)
 * joe miller (joemiller)
+* Guy Boertje (guyboertje)
 
 Note: If you've sent us patches, bug reports, or otherwise contributed to
 Logstash, and you aren't on the list above and want to be, please let us know

data/README.md

@@ -1,7 +1,6 @@
 # Logstash Plugin
 
-[![Build
-Status](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Inputs/job/logstash-plugin-input-gelf-unit/badge/icon)](http://build-eu-00.elastic.co/view/LS%20Plugins/view/LS%20Inputs/job/logstash-plugin-input-gelf-unit/)
+[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-input-gelf.svg)](https://travis-ci.org/logstash-plugins/logstash-input-gelf)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 

data/lib/logstash/inputs/gelf.rb

@@ -54,6 +54,10 @@ class LogStash::Inputs::Gelf < LogStash::Inputs::Base
   RECONNECT_BACKOFF_SLEEP = 5
   TIMESTAMP_GELF_FIELD = "timestamp".freeze
   SOURCE_HOST_FIELD = "source_host".freeze
+  MESSAGE_FIELD = "message"
+  TAGS_FIELD = "tags"
+  PARSE_FAILURE_TAG = "_jsonparsefailure"
+  PARSE_FAILURE_LOG_MESSAGE = "JSON parse failure. Falling back to plain-text"
 
   public
   def initialize(params)
@@ -121,7 +125,7 @@ class LogStash::Inputs::Gelf < LogStash::Inputs::Base
   # @param host [String] source host of GELF data
   # @return [LogStash::Event] new event with parsed json gelf, assigned source host and coerced timestamp
   def self.new_event(json_gelf, host)
-    event = LogStash::Event.new(LogStash::Json.load(json_gelf))
+    event = parse(json_gelf)
 
     event[SOURCE_HOST_FIELD] = host
 
@@ -142,6 +146,29 @@ class LogStash::Inputs::Gelf < LogStash::Inputs::Base
     timestamp.is_a?(BigDecimal) ? LogStash::Timestamp.at(timestamp.to_i, timestamp.frac * 1000000) : LogStash::Timestamp.at(timestamp)
   end
 
+  # from_json_parse uses the Event#from_json method to deserialize and directly produce events
+  def self.from_json_parse(json)
+    LogStash::Event.from_json(json).each { |event| event }
+  rescue LogStash::Json::ParserError => e
+    logger.error(PARSE_FAILURE_LOG_MESSAGE, :error => e, :data => json)
+    LogStash::Event.new(MESSAGE_FIELD => json, TAGS_FIELD => [PARSE_FAILURE_TAG, '_fromjsonparser'])
+  end # def self.from_json_parse
+
+  # legacy_parse uses the LogStash::Json class to deserialize json
+  def self.legacy_parse(json)
+    o = LogStash::Json.load(json)
+    LogStash::Event.new(o) if o
+  rescue LogStash::Json::ParserError => e
+    logger.error(PARSE_FAILURE_LOG_MESSAGE, :error => e, :data => json)
+    LogStash::Event.new(MESSAGE_FIELD => json, TAGS_FIELD => [PARSE_FAILURE_TAG, '_legacyjsonparser'])
+  end # def self.parse
+
+  # keep compatibility with all v2.x distributions. only in 2.3 will the Event#from_json method be introduced
+  # and we need to keep compatibility for all v2 releases.
+  class << self
+    alias_method :parse, LogStash::Event.respond_to?(:from_json) ? :from_json_parse : :legacy_parse
+  end
+
   private
   def remap_gelf(event)
     if event["full_message"] && !event["full_message"].empty?

data/logstash-input-gelf.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-gelf'
-  s.version         = '2.0.5'
+  s.version         = '2.0.7'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "This input will read GELF messages as events over the network, making it a good choice if you already use Graylog2 today."
   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"
@@ -30,4 +30,3 @@ Gem::Specification.new do |s|
   s.add_development_dependency "gelf", ["1.3.2"]                  #(MIT license)
   s.add_development_dependency "flores"
 end
-

data/spec/inputs/gelf_spec.rb

@@ -146,4 +146,42 @@ describe LogStash::Inputs::Gelf do
       expect(event.timestamp.usec).to be_within(1000).of(123456)
     end
   end
+
+  context "when an invalid JSON is fed to the listener" do
+    subject { LogStash::Inputs::Gelf.new_event(message, "host") }
+    let(:message) { "Invalid JSON message" }
+    if LogStash::Event.respond_to?(:from_java)
+      context "default :from_json parser output" do
+        it { should be_a(LogStash::Event) }
+
+        it "falls back to plain-text" do
+          expect(subject["message"]).to eq(message)
+        end
+
+        it "tags message with _jsonparsefailure" do
+          expect(subject["tags"]).to include("_jsonparsefailure")
+        end
+
+        it "tags message with _fromjsonparser" do
+          expect(subject["tags"]).to include("_fromjsonparser")
+        end
+      end
+    else
+      context "legacy JSON parser output" do
+        it { should be_a(LogStash::Event) }
+
+        it "falls back to plain-text" do
+          expect(subject["message"]).to eq(message)
+        end
+
+        it "tags message with _jsonparsefailure" do
+          expect(subject["tags"]).to include("_jsonparsefailure")
+        end
+
+        it "tags message with _legacyjsonparser" do
+          expect(subject["tags"]).to include("_legacyjsonparser")
+        end
+      end
+    end
+  end
 end

metadata

@@ -1,113 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-gelf
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.0.7
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-04-14 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: '1.0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
-  name: logstash-core-plugin-api
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: gelfd
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
+        version: 0.2.0
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.2.0
-  name: gelfd
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.2.0
-- !ruby/object:Gem::Dependency
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: logstash-codec-plain
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: stud
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+        version: 0.0.22
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.22
-  name: stud
   prerelease: false
   type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.0.22
-- !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
+- !ruby/object:Gem::Dependency
+  name: gelf
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
+        version: 1.3.2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.3.2
-  name: gelf
   prerelease: false
   type: :development
+- !ruby/object:Gem::Dependency
+  name: flores
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.3.2
-- !ruby/object:Gem::Dependency
+        version: '0'
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: flores
   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: []
@@ -136,12 +136,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: []