logstash-input-gelf 3.1.0 → 3.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b380005f437f84a9255e8583c3b3ea1fc6c54e7c7f4ab67aef8f5e674729887a
-  data.tar.gz: fe84ff257d1cffec9cf3c9281e08a9dd3b5d32388eb7c50682ba2ec38db7ce28
+  metadata.gz: b4b681e1769e452f4699058f8663137c81fe50e2ce19f1f8ec130964125bade1
+  data.tar.gz: 70f5a59240931cfcac843db52e275cbe97a2e624c59c59e9162fe6a34251f8db
 SHA512:
-  metadata.gz: 2a0aea419cecf15aef6c248b71c3c46098ed974cc534cb32746c416feae7e6c9de03126a399b23ef5540ab5c306aaac9429f629fdd03499387507583a58f9791
-  data.tar.gz: dd6dd7344a6facc9519e9beee80aff02771fea93023af8578dcf3593d97364576e97ff01ca95bb32124aa3a62bf3019615a13b10160c98aed308c0da2e41d6fe
+  metadata.gz: a602e5bea3c91f985e72b49780241696da85f7eb210c2028396edf328a0214de738001e476f0f763dcc06aa4a6d5224e98a0003411d56480fb60bf8e92bf6b10
+  data.tar.gz: 43b6c5cf39ef80374b75272431c50e5a16facc67300a753523ede5ed5b78d1c05103405cd8a4ca898e0e474835b946554ca7856239095bd65c38087bc912757e

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 3.3.1
+  - Fix: safely coerce the value of `_@timestamp` to avoid crashing the plugin [#67](https://github.com/logstash-plugins/logstash-input-gelf/pull/67)
+
+## 3.3.0
+  - Updated library to gelfd2 [#48](https://github.com/logstash-plugins/logstash-input-gelf/pull/48)
+
+## 3.2.0
+  - Fixed shutdown handling, robustness in socket closing and restarting, json parsing, code DRYing and cleanups [62](https://github.com/logstash-plugins/logstash-input-gelf/pull/62)
+
+## 3.1.1
+  - Docs: Set the default_codec doc attribute.
+
 ## 3.1.0
   - Add support for listening on TCP socket
 

data/LICENSE

@@ -1,13 +1,202 @@
-Copyright (c) 2012-2018 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.
-You may obtain a copy of the License at
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-    http://www.apache.org/licenses/LICENSE-2.0
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2020 Elastic and contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -1,6 +1,6 @@
 # Logstash Plugin
 
-[![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-input-gelf.svg)](https://travis-ci.org/logstash-plugins/logstash-input-gelf)
+[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-input-gelf.svg)](https://travis-ci.com/logstash-plugins/logstash-input-gelf)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 

data/docs/index.asciidoc

@@ -1,5 +1,6 @@
 :plugin: gelf
 :type: input
+:default_codec: plain
 
 ///////////////////////////////////////////
 START - GENERATED VARIABLES, DO NOT EDIT!
@@ -24,15 +25,7 @@ This input will read GELF messages as events over the network,
 making it a good choice if you already use Graylog2 today.
 
 The main use case for this input is to leverage existing GELF
-logging libraries such as the GELF log4j appender. A library used
-by this plugin has a bug which prevents it parsing uncompressed data.
-If you use the log4j appender you need to configure it like this to force
-gzip even for small messages:
-
-  <Socket name="logstash" protocol="udp" host="logstash.example.com" port="5001">
-     <GelfLayout compressionType="GZIP" compressionThreshold="1" />
-  </Socket>
-
+logging libraries such as the GELF log4j appender.
 
 
 [id="plugins-{type}s-{plugin}-options"]
@@ -139,3 +132,5 @@ e.g. `\_foo` becomes `foo`
 
 [id="plugins-{type}s-{plugin}-common-options"]
 include::{include_path}/{type}.asciidoc[]
+
+:default_codec!:

data/lib/logstash/inputs/gelf.rb

@@ -12,16 +12,8 @@ require "json"
 # making it a good choice if you already use Graylog2 today.
 #
 # The main use case for this input is to leverage existing GELF
-# logging libraries such as the GELF log4j appender. A library used
-# by this plugin has a bug which prevents it parsing uncompressed data.
-# If you use the log4j appender you need to configure it like this to force
-# gzip even for small messages:
-#
-#   <Socket name="logstash" protocol="udp" host="logstash.example.com" port="5001">
-#      <GelfLayout compressionType="GZIP" compressionThreshold="1" />
-#   </Socket>
-#
-#
+# logging libraries such as the GELF log4j appender.
+
 class LogStash::Inputs::Gelf < LogStash::Inputs::Base
   config_name "gelf"
 
@@ -67,149 +59,142 @@ class LogStash::Inputs::Gelf < LogStash::Inputs::Base
   config :use_tcp, :validate => :boolean, :default => false
   config :use_udp, :validate => :boolean, :default => true
 
-  public
   def initialize(params)
     super
     BasicSocket.do_not_reverse_lookup = true
-  end # def initialize
+  end
 
-  public
   def register
-    require 'gelfd'
+    require 'gelfd2'
     @port_tcp ||= @port
     @port_udp ||= @port
   end
 
-  public
   def run(output_queue)
     begin
       if @use_tcp
-        tcp_thr = Thread.new(output_queue) do |output_queue|
-          tcp_listener(output_queue)
-        end
+        @tcp_thr = Thread.new(output_queue) { |output_queue| tcp_listener(output_queue) }
       end
       if @use_udp
-        udp_thr = Thread.new(output_queue) do |output_queue|
-          udp_listener(output_queue)
-        end
+        @udp_thr = Thread.new(output_queue) { |output_queue| udp_listener(output_queue) }
       end
     rescue => e
       unless stop?
         @logger.warn("gelf listener died", :exception => e, :backtrace => e.backtrace)
         Stud.stoppable_sleep(RECONNECT_BACKOFF_SLEEP) { stop? }
-        retry unless stop?
+        if !stop?
+          # before retrying make sure we close all sockets
+          stop
+          wait_server_thread
+          retry
+        end
       end
-    end # begin
-    if @use_tcp
-      tcp_thr.join
-    end
-    if @use_udp
-      udp_thr.join
     end
-  end # def run
 
-  public
+    wait_server_thread
+  end
+
   def stop
     begin
       @udp.close if @use_udp
-    rescue IOError => e
-      @logger.warn("Caugh exception while closing udp socket", :exception => e.inspect)
+      @udp = nil
+    rescue => e
+      @logger.debug("Caught exception while closing udp socket", :exception => e)
     end
     begin
       @tcp.close if @use_tcp
-    rescue IOError => e
-      @logger.warn("Caugh exception while closing tcp socket", :exception => e.inspect)
+      @tcp = nil
+    rescue => e
+      @logger.debug("Caught exception while closing tcp socket", :exception => e)
     end
   end
 
   private
-  def tcp_listener(output_queue)
 
+  def wait_server_thread
+    @tcp_thr.join if @use_tcp
+    @udp_thr.join if @use_udp
+  end
+
+  def tcp_listener(output_queue)
     @logger.info("Starting gelf listener (tcp) ...", :address => "#{@host}:#{@port_tcp}")
 
     if @tcp.nil?
       @tcp = TCPServer.new(@host, @port_tcp)
     end
 
-    while !@shutdown_requested
+    while !stop?
       Thread.new(@tcp.accept) do |client|
-        @logger.debug? && @logger.debug("Gelf (tcp): Accepting connection from:  #{client.peeraddr[2]}:#{client.peeraddr[1]}")
-
         begin
-          while !client.nil? && !client.eof?
+          @logger.debug? && @logger.debug("Gelf (tcp): Accepting connection from:  #{client.peeraddr[2]}:#{client.peeraddr[1]}")
+
+          while !client.nil? && !client.eof? && !stop?
 
             begin # Read from socket
               data_in = client.gets("\u0000")
             rescue => ex
-              @logger.warn("Gelf (tcp): failed gets from client socket:", :exception => ex, :backtrace => ex.backtrace)
+              if !stop?
+                @logger.warn("Gelf (tcp): failed gets from client socket:", :exception => ex, :backtrace => ex.backtrace)
+              end
             end
 
              if data_in.nil?
-              @logger.warn("Gelf (tcp): socket read succeeded, but data is nil.  Skipping.")
+              @logger.debug("Gelf (tcp): socket read succeeded, but data is nil. Skipping.")
               next
-            end
+             end
 
             # data received.  Remove trailing \0
             data_in[-1] == "\u0000" && data_in = data_in[0...-1]
-            begin # Parse JSON
-              jsonObj = JSON.parse(data_in)
-            rescue => ex
-              @logger.warn("Gelf (tcp): failed to parse a message. Skipping: " + data_in, :exception => ex, :backtrace => ex.backtrace)
-              next
-            end
 
-            begin  # Create event
-              event = LogStash::Event.new(jsonObj)
-              event.set(SOURCE_HOST_FIELD, host.force_encoding("UTF-8"))
-              if event.get("timestamp").is_a?(Numeric)
-                event.set("timestamp", LogStash::Timestamp.at(event.get("timestamp")))
-                event.remove("timestamp")
-              end
-              remap_gelf(event) if @remap
-              strip_leading_underscore(event) if @strip_leading_underscore
-              decorate(event)
-              output_queue << event
-            rescue => ex
-              @logger.warn("Gelf (tcp): failed to create event from json object. Skipping: " + jsonObj.to_s, :exception => ex, :backtrace => ex.backtrace)
-            end
+            event = self.class.new_event(data_in, client.peeraddr[3])
+            next if event.nil?
+
+            remap_gelf(event) if @remap
+            strip_leading_underscore(event) if @strip_leading_underscore
+            decorate(event)
+            output_queue << event
+          end
 
-          end # while client
           @logger.debug? && @logger.debug("Gelf (tcp): Closing client connection")
-          client.close
+          client.close rescue nil
           client = nil
         rescue => ex
-          @logger.warn("Gelf (tcp): client socket failed.", :exception => ex, :backtrace => ex.backtrace)
+          if !stop?
+            @logger.warn("Gelf (tcp): client socket failed.", :exception => ex, :backtrace => ex.backtrace)
+          end
         ensure
           if !client.nil?
             @logger.debug? && @logger.debug("Gelf (tcp): Ensuring client is closed")
-            client.close
+            client.close rescue nil
             client = nil
           end
-        end # begin client
-      end  # Thread.new
-    end # @shutdown_requested
-
+        end
+      end
+    end
+  ensure
+    @logger.debug? && @logger.debug("Gelf (tcp): Ensuring tcp server is closed")
+    @tcp.close rescue nil
+    @tcp = nil
   end
 
-  private
   def udp_listener(output_queue)
     @logger.info("Starting gelf listener (udp) ...", :address => "#{@host}:#{@port_udp}")
 
     @udp = UDPSocket.new(Socket::AF_INET)
     @udp.bind(@host, @port_udp)
 
-    while !@udp.closed?
+    while !stop?
       begin
         line, client = @udp.recvfrom(8192)
       rescue => e
-        if !stop? # if we're shutting down there's no point in logging anything
-          @logger.error("Caught exception while reading from UDP socket", :exception => e.inspect)
+        if !stop?
+          @logger.error("Caught exception while reading from UDP socket", :exception => e)
         end
         next
       end
 
       begin
-        data = Gelfd::Parser.parse(line)
+        data = Gelfd2::Parser.parse(line)
       rescue => ex
         @logger.warn("Gelfd failed to parse a message skipping", :exception => ex, :backtrace => ex.backtrace)
         next
@@ -227,7 +212,11 @@ class LogStash::Inputs::Gelf < LogStash::Inputs::Base
 
       output_queue << event
     end
-  end # def udp_listener
+  ensure
+    @logger.debug? && @logger.debug("Gelf (udp): Ensuring udp socket is closed")
+    @udp.close rescue nil
+    @udp = nil
+  end
 
   # generate a new LogStash::Event from json input and assign host to source_host event field.
   # @param json_gelf [String] GELF json data
@@ -252,36 +241,19 @@ class LogStash::Inputs::Gelf < LogStash::Inputs::Base
   # @param timestamp [Numeric] a Numeric (integer, float or bigdecimal) timestampo representation
   # @return [LogStash::Timestamp] the proper LogStash::Timestamp representation
   def self.coerce_timestamp(timestamp)
-    # bug in JRuby prevents correcly parsing a BigDecimal fractional part, see https://github.com/elastic/logstash/issues/4565
-    timestamp.is_a?(BigDecimal) ? LogStash::Timestamp.at(timestamp.to_i, timestamp.frac * 1000000) : LogStash::Timestamp.at(timestamp)
+    # prevent artificial precision from being injected by floats
+    timestamp = timestamp.rationalize if timestamp.kind_of?(Float)
+    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)
-    # from_json will always return an array of item.
-    # in the context of gelf, the payload should be an array of 1
-    LogStash::Event.from_json(json).first
-  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)
+  def self.parse(json)
     o = LogStash::Json.load(json)
     LogStash::Event.new(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
+    logger.error(PARSE_FAILURE_LOG_MESSAGE, :error => e, :data => json.inspect)
+    LogStash::Event.new(MESSAGE_FIELD => json.inspect, TAGS_FIELD => [PARSE_FAILURE_TAG])
   end
 
-  private
   def remap_gelf(event)
     if event.get("full_message") && !event.get("full_message").empty?
       event.set("message", event.get("full_message").dup)
@@ -293,15 +265,28 @@ class LogStash::Inputs::Gelf < LogStash::Inputs::Base
       event.set("message", event.get("short_message").dup)
       event.remove("short_message")
     end
-  end # def remap_gelf
+  end
 
-  private
   def strip_leading_underscore(event)
-     # Map all '_foo' fields to simply 'foo'
-     event.to_hash.keys.each do |key|
-       next unless key[0,1] == "_"
-       event.set(key[1..-1], event.get(key))
-       event.remove(key)
-     end
-  end # deef removing_leading_underscores
-end # class LogStash::Inputs::Gelf
+    # Map all '_foo' fields to simply 'foo'
+    event.to_hash.keys.each do |key|
+      move_field(event, key, key.slice(1..-1)) if key.start_with?('_')
+    end
+  end
+
+  def move_field(event, source_field, destination_field)
+    value = event.get(source_field)
+    value = coerce_timestamp_carefully(value) if destination_field == LogStash::Event::TIMESTAMP
+    event.set(destination_field, value)
+    event.remove(source_field)
+  rescue => e
+    @logger.warn("Failed to move field `#{source_field}` to `#{destination_field}`: #{e.message}")
+    event.tag("_gelf_move_field_failure")
+  end
+
+  def coerce_timestamp_carefully(value)
+    # catch float numbers in 123.567 or 0.123567e3 forms
+    value = BigDecimal(value) if value.kind_of?(String)
+    self.class.coerce_timestamp(value)
+  end
+end

data/logstash-input-gelf.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-gelf'
-  s.version         = '3.1.0'
+  s.version         = '3.3.1'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Reads GELF-format messages from Graylog2 as events"
   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"
@@ -22,11 +22,11 @@ Gem::Specification.new do |s|
   # Gem dependencies
   s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
 
-  s.add_runtime_dependency "gelfd", ["0.2.0"]                 #(Apache 2.0 license)
+  s.add_runtime_dependency "gelfd2", ["0.4.1"]                 #(Apache 2.0 license)
   s.add_runtime_dependency 'logstash-codec-plain'
-  s.add_runtime_dependency "stud", "~> 0.0.22"
+  s.add_runtime_dependency 'stud', '>= 0.0.22', '< 0.1.0'
 
-  s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'logstash-devutils', '>= 2.3'
   s.add_development_dependency "gelf", ["3.0.0"]                  #(MIT license)
   s.add_development_dependency "flores"
 end

data/spec/inputs/gelf_spec.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 require "logstash/devutils/rspec/spec_helper"
+require "logstash/devutils/rspec/shared_examples"
 require "logstash/inputs/gelf"
 require_relative "../support/helpers"
 require "gelf"
@@ -19,6 +20,19 @@ describe LogStash::Inputs::Gelf do
     it_behaves_like "an interruptible input plugin"
   end
 
+  def client_bootstrap(gelfclient, queue)
+    while queue.size <= 0
+      gelfclient.notify!("short_message" => "prime")
+      sleep(0.1)
+    end
+    gelfclient.notify!("short_message" => "start")
+
+    e = queue.pop
+    while (e.get("message") != "start")
+      e = queue.pop
+    end
+  end
+
   describe "chunked gelf messages" do
     let(:port) { 12209 }
     let(:host) { "127.0.0.1" }
@@ -40,21 +54,18 @@ describe LogStash::Inputs::Gelf do
 
     before(:each) do
       subject.register
-      Thread.new { subject.run(queue) }
-    end
+      @runner = Thread.new { subject.run(queue) }
 
-    it "processes them" do
-      while queue.size <= 0
-        gelfclient.notify!("short_message" => "prime")
-        sleep(0.1)
-      end
-      gelfclient.notify!("short_message" => "start")
+      client_bootstrap(gelfclient, queue)
+    end
 
-      e = queue.pop
-      while (e.get("message") != "start")
-        e = queue.pop
-      end
+    after(:each) do
+      subject.do_stop
+      @runner.kill
+      @runner.join
+    end
 
+    it "processes them" do
       messages.each do |m|
         gelfclient.notify!("short_message" => m)
       end
@@ -68,13 +79,75 @@ describe LogStash::Inputs::Gelf do
     end
   end
 
+  describe "sending _@timestamp as bigdecimal" do
+    let(:host) { "127.0.0.1" }
+    let(:chunksize) { 1420 }
+    let(:gelfclient) { GELF::Notifier.new(host, port, chunksize) }
+
+    let(:config) { { "port" => port, "host" => host } }
+    let(:queue) { Queue.new }
+
+    subject(:gelf_input) { described_class.new(config) }
+
+    before(:each) do
+      subject.register
+      @runner = Thread.new { subject.run(queue) }
+
+      client_bootstrap(gelfclient, queue)
+    end
+
+    after(:each) do
+      subject.do_stop
+      @runner.kill
+      @runner.join
+    end
+
+    context "with valid value" do
+      let(:port) { 12210 }
+
+      it "should be correctly processed" do
+        gelfclient.notify!("short_message" => "msg1", "_@timestamp" => BigDecimal.new("946702800.1"))
+        gelfclient.notify!("short_message" => "msg2")
+
+        e = queue.pop
+        expect(e.get("message")).to eq("msg1")
+        expect(e.timestamp).to be_a_logstash_timestamp_equivalent_to("2000-01-01T05:00:00.100Z")
+        expect(e.get("host")).to eq(Socket.gethostname)
+
+        e = queue.pop
+        expect(e.get("message")).to eq("msg2")
+      end
+    end
+
+    context "with invalid value" do
+      let(:port) { 12211 }
+
+      it "should create an error tagged event" do
+        gelfclient.notify!("short_message" => "msg1", "_@timestamp" => "foo")
+        gelfclient.notify!("short_message" => "msg2")
+      
+        e = queue.pop
+        expect(e.get("message")).to eq("msg1")
+        event_tags = e.to_hash['tags']
+        aggregate_failures "tag and leave bad value in place" do
+          expect(event_tags).to include("_gelf_move_field_failure")
+          expect(e.get('_@timestamp')).to eq("foo")
+        end
+        expect(e.get("host")).to eq(Socket.gethostname)
+
+        e = queue.pop
+        expect(e.get("message")).to eq("msg2")
+      end
+    end
+  end
+
   context "timestamp coercion" do
     # these test private methods, this is advisable for now until we roll out this coercion in the Timestamp class
     # and remove this
 
     context "integer numeric values" do
       it "should coerce" do
-        expect(LogStash::Inputs::Gelf.coerce_timestamp(946702800).to_iso8601).to eq("2000-01-01T05:00:00.000Z")
+        expect(LogStash::Inputs::Gelf.coerce_timestamp(946702800)).to be_a_logstash_timestamp_equivalent_to("2000-01-01T05:00:00.000Z")
         expect(LogStash::Inputs::Gelf.coerce_timestamp(946702800).usec).to eq(0)
       end
     end
@@ -83,9 +156,9 @@ describe LogStash::Inputs::Gelf do
       # using explicit and certainly useless to_f here just to leave no doubt about the numeric type involved
 
       it "should coerce and preserve millisec precision in iso8601" do
-        expect(LogStash::Inputs::Gelf.coerce_timestamp(946702800.1.to_f).to_iso8601).to eq("2000-01-01T05:00:00.100Z")
-        expect(LogStash::Inputs::Gelf.coerce_timestamp(946702800.12.to_f).to_iso8601).to eq("2000-01-01T05:00:00.120Z")
-        expect(LogStash::Inputs::Gelf.coerce_timestamp(946702800.123.to_f).to_iso8601).to eq("2000-01-01T05:00:00.123Z")
+        expect(LogStash::Inputs::Gelf.coerce_timestamp(946702800.1.to_f)).to be_a_logstash_timestamp_equivalent_to("2000-01-01T05:00:00.100Z")
+        expect(LogStash::Inputs::Gelf.coerce_timestamp(946702800.12.to_f)).to be_a_logstash_timestamp_equivalent_to("2000-01-01T05:00:00.120Z")
+        expect(LogStash::Inputs::Gelf.coerce_timestamp(946702800.123.to_f)).to be_a_logstash_timestamp_equivalent_to("2000-01-01T05:00:00.123Z")
       end
 
       it "should coerce and preserve usec precision" do
@@ -128,7 +201,7 @@ describe LogStash::Inputs::Gelf do
 
     it "should coerce integer numeric json timestamp input" do
       event = LogStash::Inputs::Gelf.new_event("{\"timestamp\":946702800}", "dummy")
-      expect(event.timestamp.to_iso8601).to eq("2000-01-01T05:00:00.000Z")
+      expect(event.timestamp).to be_a_logstash_timestamp_equivalent_to("2000-01-01T05:00:00.000Z")
     end
 
     it "should coerce float numeric value and preserve milliseconds precision in iso8601" do
@@ -148,38 +221,15 @@ describe LogStash::Inputs::Gelf do
   context "when an invalid JSON is fed to the listener" do
     subject { LogStash::Inputs::Gelf.new_event(message, "host") }
     let(:message) { "Invalid JSON message" }
+    context "JSON parser output" do
+      it { should be_a(LogStash::Event) }
 
-    if LogStash::Event.respond_to?(:from_json)
-      context "default :from_json parser output" do
-        it { should be_a(LogStash::Event) }
-
-        it "falls back to plain-text" do
-          expect(subject.get("message")).to eq(message)
-        end
-
-        it "tags message with _jsonparsefailure" do
-          expect(subject.get("tags")).to include("_jsonparsefailure")
-        end
-
-        it "tags message with _fromjsonparser" do
-          expect(subject.get("tags")).to include("_fromjsonparser")
-        end
+      it "falls back to plain-text" do
+        expect(subject.get("message")).to eq(message.inspect)
       end
-    else
-      context "legacy JSON parser output" do
-        it { should be_a(LogStash::Event) }
-
-        it "falls back to plain-text" do
-          expect(subject.get("message")).to eq(message)
-        end
 
-        it "tags message with _jsonparsefailure" do
-          expect(subject.get("tags")).to include("_jsonparsefailure")
-        end
-
-        it "tags message with _legacyjsonparser" do
-          expect(subject.get("tags")).to include("_legacyjsonparser")
-        end
+      it "tags message with _jsonparsefailure" do
+        expect(subject.get("tags")).to include("_jsonparsefailure")
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-gelf
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.3.1
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-01-15 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -35,15 +35,15 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.0
-  name: gelfd
+        version: 0.4.1
+  name: gelfd2
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -61,23 +61,29 @@ dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.22
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
   name: stud
   prerelease: false
   type: :runtime
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.0.22
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
   name: logstash-devutils
   prerelease: false
   type: :development
@@ -85,7 +91,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -154,8 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.6.13
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Reads GELF-format messages from Graylog2 as events