logstash-output-udp 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6d89de043149e0924a181b904dfd2d56766fd52c77ffb7ad623c27c3ee18df4
-  data.tar.gz: 94ad42d0d5b5d9c2bda8714318b3ca79899b8889e1db69e1e2a4c71358059f2d
+  metadata.gz: b3988df4d07ed849b41de584e2c9e6b37edc51d002b773ad1cc9719e71ed7f9f
+  data.tar.gz: 5ee9f9e3d85b0640a5fe9986950e68a07901c6252073fe3c9b2034a8e0793bbd
 SHA512:
-  metadata.gz: ead3de8b14b596c8cac1330ca63737232fb8d8ce5e2564f5aed6cedb54e811662dae7ba2a2a36680ba6aba9d11aa1ce6f14e1e35888076d01907de6976fb5e2d
-  data.tar.gz: 71d2903845ceed02477768fe9eea5ca8c27a0875ba064b96a2d396331c726d1bbaa0aca88d64ed9df77b70a7ab30b0523ceaf67a648436f87449a33ba4b9cf26
+  metadata.gz: 842bb5c01a12602223e3e9778f756e6a25a9505a9e8c61d79b99aa801497ae990d5e241d6051ba79e9e4c3cb0b0871ff455d635f10d97946c4328ffd0fee2d3a
+  data.tar.gz: 9250a7c4cecbafc3a1c8c36fd15c62c8a24bbebb38479f397dc2837b07f6860cc4ec391c7a4244caff2301d9a82a9f443d72d7b226eb18c87869208fbed98fa4

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.2.0
+ - Added field reference support in `port` [#13](https://github.com/logstash-plugins/logstash-output-udp/pull/13)
+
 ## 3.1.0
  - Fixed plugin crash upon socket write exception [#10](https://github.com/logstash-plugins/logstash-output-udp/pull/10)
  - Added support for the 'retry_count' and 'retry_backoff_ms' options [#12](https://github.com/logstash-plugins/logstash-output-udp/pull/12)

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-output-udp.svg)](https://travis-ci.org/logstash-plugins/logstash-output-udp)
+[![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-output-udp.svg)](https://travis-ci.com/logstash-plugins/logstash-output-udp)
 
 This is a plugin for [Logstash](https://github.com/elastic/logstash).
 

data/docs/index.asciidoc

@@ -41,7 +41,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
 |=======================================================================
 |Setting |Input type|Required
 | <<plugins-{type}s-{plugin}-host>> |<<string,string>>|Yes
-| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|Yes
+| <<plugins-{type}s-{plugin}-port>> |<<string,string>>|Yes
 | <<plugins-{type}s-{plugin}-retry_count>> |<<number,number>>|No
 | <<plugins-{type}s-{plugin}-retry_backoff_ms>> |<<number,number>>|No
 |=======================================================================
@@ -64,10 +64,10 @@ The address to send messages to
 ===== `port` 
 
   * This is a required setting.
-  * Value type is <<number,number>>
+  * Value type is <<string,string>>
   * There is no default value for this setting.
 
-The port to send messages on
+The port to send messages on. This can be dynamic using the `%{[target][port]}` syntax.
 
 [id="plugins-{type}s-{plugin}-retry_count"]
 ===== `retry_count`

data/lib/logstash/outputs/udp.rb

@@ -1,12 +1,13 @@
 # encoding: utf-8
+require "socket"
 require "logstash/outputs/base"
 require "logstash/namespace"
-require "socket"
 
 # Send events over UDP
 #
 # Keep in mind that UDP is a lossy protocol
 class LogStash::Outputs::UDP < LogStash::Outputs::Base
+
   config_name "udp"
   
   default :codec, "json"
@@ -15,7 +16,7 @@ class LogStash::Outputs::UDP < LogStash::Outputs::Base
   config :host, :validate => :string, :required => true
 
   # The port to send messages on
-  config :port, :validate => :number, :required => true
+  config :port, :validate => :string, :required => true
 
   # The number of times to retry a failed UPD socket write
   config :retry_count, :validate => :number, :default => 0
@@ -27,7 +28,14 @@ class LogStash::Outputs::UDP < LogStash::Outputs::Base
     @socket = UDPSocket.new
 
     @codec.on_event do |event, payload|
-      socket_send(payload)
+      port = event.sprintf(@port)
+      begin
+        port = Integer(port)
+      rescue => e # ArgumentError (invalid value for Integer(): "foo")
+        logger.error("Failed to resolve port, dropping event", port: @port, event: event.to_hash, message: e.message)
+      else
+        socket_send(payload, port)
+      end
     end
   end
 
@@ -37,16 +45,16 @@ class LogStash::Outputs::UDP < LogStash::Outputs::Base
 
   private
 
-  def socket_send(payload)
+  def socket_send(payload, port)
     send_count = 0
     begin
       send_count += 1
-      @socket.send(payload, 0, @host, @port)
+      @socket.send(payload, 0, @host, port)
     rescue Errno::EMSGSIZE => e
       logger.error("Failed to send event, message size of #{payload.size} too long", error_hash(e, payload))
     rescue => e
       if @retry_count > 0 && send_count <= @retry_count
-        logger.warn("Failed to send event, retrying:", error_hash(e, payload))
+        logger.warn("Failed to send event, retrying:", error_hash(e, payload, trace: false))
         sleep(@retry_backoff_ms / 1000.0)
         retry
       else
@@ -57,18 +65,13 @@ class LogStash::Outputs::UDP < LogStash::Outputs::Base
 
   MAX_DEBUG_PAYLOAD = 1000
 
-  def error_hash(error, payload)
-    error_hash = {
-      :error => error.inspect,
-      :backtrace => error.backtrace.first(10)
-    }
+  def error_hash(error, payload, trace: true)
+    error_hash = { :message => error.message, :exception => error.class }
     if logger.debug?
-      error_hash.merge(
-        :event_payload =>
-        payload.length > MAX_DEBUG_PAYLOAD ? "#{payload[0...MAX_DEBUG_PAYLOAD]}...<TRUNCATED>" : payload
-      )
-    else
-      error_hash
+      error_hash[:event_payload] =
+          payload.length > MAX_DEBUG_PAYLOAD ? "#{payload[0...MAX_DEBUG_PAYLOAD]}...<TRUNCATED>" : payload
     end
+    error_hash[:backtrace] = error.backtrace if trace || logger.debug?
+    error_hash
   end
 end

data/logstash-output-udp.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-output-udp'
-  s.version         = '3.1.0'
+  s.version         = '3.2.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Sends events over UDP"
   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"

data/spec/outputs/udp_spec.rb

@@ -8,6 +8,9 @@ describe LogStash::Outputs::UDP do
   let(:port) { rand(1024..65535) }
   let(:config) {{ "host" => host, "port" => port}}
 
+  let(:logger) { subject.logger }
+  let(:socket) { subject.instance_variable_get("@socket") }
+
   it "should register without errors" do
     plugin = LogStash::Plugin.lookup("output", "udp").new(config)
     expect { plugin.register }.to_not raise_error
@@ -22,12 +25,52 @@ describe LogStash::Outputs::UDP do
     end
 
     it "should receive the generated event" do
-      expect(subject.instance_variable_get("@socket")).to receive(:send).with(kind_of(String), 0, host, port)
-      expect(subject.instance_variable_get("@logger")).not_to receive(:error)
+      expect(socket).to receive(:send).with(kind_of(String), 0, host, port)
+      expect(logger).not_to receive(:error)
       subject.receive(event)
     end
   end
 
+  describe "port" do
+
+    let(:config) { super().merge('port' => '%{[target_port]}') }
+
+    before do
+      subject.register
+    end
+
+    context 'valid' do
+
+      let(:event) { LogStash::Event.new('message' => 'Hey!', 'target_port' => '12345') }
+
+      before do
+        expect(socket).to receive(:send).with(kind_of(String), 0, host, 12345)
+        expect(logger).not_to receive(:error)
+      end
+
+      it "should receive the event" do
+        subject.receive(event)
+      end
+
+    end
+
+    context 'invalid' do
+
+      let(:event) { LogStash::Event.new('message' => 'Hey!', 'target_port' => 'bogus') }
+
+      before do
+        expect(socket).to_not receive(:send)
+        expect(logger).to receive(:error).with /Failed to resolve port, dropping event/,
+                                               hash_including(:message => "invalid value for Integer(): \"bogus\"")
+      end
+
+      it "should receive the event" do
+        subject.receive(event)
+      end
+
+    end
+  end
+
   describe "retries" do
     let(:event) { LogStash::Event.new("message" => "test") }
     let(:config) {{ "host" => host, "port" => port}}
@@ -38,8 +81,8 @@ describe LogStash::Outputs::UDP do
 
     context "not using :retry_count" do
       it "should not retry upon send exception by default" do
-        allow(subject.instance_variable_get("@socket")).to receive(:send).once.and_raise(IOError)
-        expect(subject.instance_variable_get("@logger")).to receive(:error).once
+        allow(socket).to receive(:send).once.and_raise(IOError)
+        expect(logger).to receive(:error).once
         subject.receive(event)
       end
     end
@@ -50,9 +93,9 @@ describe LogStash::Outputs::UDP do
       let(:config) {{ "host" => host, "port" => port, "retry_count" => retry_count, "retry_backoff_ms" => backoff}}
 
       it "should retry upon send exception" do
-        allow(subject.instance_variable_get("@socket")).to receive(:send).exactly(retry_count + 1).times.and_raise(IOError)
-        expect(subject.instance_variable_get("@logger")).to receive(:warn).exactly(retry_count).times
-        expect(subject.instance_variable_get("@logger")).to receive(:error).once
+        allow(socket).to receive(:send).exactly(retry_count + 1).times.and_raise(IOError)
+        expect(logger).to receive(:warn).exactly(retry_count).times
+        expect(logger).to receive(:error).once
         expect(subject).to receive(:sleep).with(backoff / 1000.0).exactly(retry_count).times
         subject.receive(event)
       end
@@ -68,13 +111,13 @@ describe LogStash::Outputs::UDP do
     end
 
     it "should handle the error and log when an error is received" do
-      expect(subject.instance_variable_get("@logger")).to receive(:error)
+      expect(logger).to receive(:error)
       subject.receive(event)
     end
 
     it "should log a truncated payload with debug logging when an error is received and the message is too long" do
-      expect(subject.instance_variable_get("@logger")).to receive(:debug?).and_return(true)
-      expect(subject.instance_variable_get("@logger")).to receive(:error) do |_, hash|
+      expect(logger).to receive(:debug?).and_return(true)
+      expect(logger).to receive(:error) do |_, hash|
         expect(hash).to include(:event_payload)
         expect(hash[:event_payload]).to include("TRUNCATED")
       end
@@ -82,8 +125,8 @@ describe LogStash::Outputs::UDP do
     end
 
     it "should not log a payload with debug logging when an error is received" do
-      expect(subject.instance_variable_get("@logger")).to receive(:debug?).and_return(false)
-      expect(subject.instance_variable_get("@logger")).to receive(:error) do |_, hash|
+      expect(logger).to receive(:debug?).and_return(false)
+      expect(logger).to receive(:error) do |_, hash|
         expect(hash).not_to include(:event_payload)
       end
       subject.receive(event)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-output-udp
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Elastic
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-12-17 00:00:00.000000000 Z
+date: 2021-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
@@ -20,8 +20,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.99'
   name: logstash-core-plugin-api
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -37,8 +37,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: logstash-codec-json
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -51,8 +51,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: logstash-devutils
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -98,8 +98,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.0.6
 signing_key:
 specification_version: 4
 summary: Sends events over UDP