logstash-input-jms 3.2.2-java → 3.3.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17ab471b9058d8bdc626619b3bd60948e8b15022b5c0d7b576295a23f9fd9a6a
-  data.tar.gz: '09cc9532fc6183256f2d69b436d8dcd70ede94b89d14a8f9247e4f1d6baccf0e'
+  metadata.gz: f7e8a70badadf706c39ae7c2c1d91b40be697abba13ec8abe80d7e6a19e355af
+  data.tar.gz: 106b0f7af45b2426d6bb8ab3b927699145a8b958ba3ad4ace3cd204061e75199
 SHA512:
-  metadata.gz: cf73ec01b747be388ca3e091512806335ddb109d20844710c3bf5acfddd2bf460c8c5ad4210d54da38c5d99fecb140f75ce45f22f374ee220d379ede4d29a8f4
-  data.tar.gz: df5bf8bc4f1a0fb8efadb71083cc110a5c640c48f637adfb2ce43af0d8daeabfda087519547944966b2a9bc22f23d3342c82346004d7fbb68ddb13ff13d72392
+  metadata.gz: 26c0fee3a16983338c36071c8cd0007501f5a26284287bbd3d39da000ad651758a97067647bdb0ce00977358b5ac8b4fe61cdb60e46a93a733e61640c5b5ed62
+  data.tar.gz: e93a57c7fb6d4ec2560aed0443821dfe803d93d4e3964437c937765c0a623477a00c2c75ae7777d90c784b5832a2a2a3802d8fec0485de618def9c1dd682cefb

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.3.0
+ - Added support for decoding multiple events from text or binary messages when using a codec that produces multiple events
+
 ## 3.2.2
  - Fix: Remove usage of `java_kind_of?` to allow this plugin to be supported for versions of Logstash using jruby-9.3.x
  [#54](https://github.com/logstash-plugins/logstash-input-jms/pull/54)

data/lib/logstash/inputs/jms.rb

@@ -276,7 +276,7 @@ class LogStash::Inputs::Jms < LogStash::Inputs::Threadable
         # read from the queue/topic until :timeout is reached, or a message is available
         # (whichever comes first)
         do_receive_message(subscriber, timeout: @interval * 1000) do |message|
-          queue_event(message, output_queue)
+          queue_events(message, output_queue)
           break if stop?
         end
       end
@@ -296,20 +296,27 @@ class LogStash::Inputs::Jms < LogStash::Inputs::Threadable
     end
   end # def run_consumer
 
-  def queue_event(msg, output_queue)
-    begin
-      if @include_body
-        if msg.kind_of?(JMS::MapMessage)
-          event = process_map_message(msg)
-        elsif msg.kind_of?(JMS::TextMessage) || msg.kind_of?(JMS::BytesMessage)
-          event = decode_message(msg)
-        else
-          @logger.error( "Unsupported message type #{msg.data.class.to_s}" )
-        end
+  def events(msg, &event_handler)
+    return enum_for(:events, msg).to_a unless block_given?
+
+    if @include_body
+      if msg.kind_of?(JMS::MapMessage)
+        return process_map_message(msg, &event_handler)
+      elsif msg.kind_of?(JMS::TextMessage) || msg.kind_of?(JMS::BytesMessage)
+        return process_string_message(msg, &event_handler)
+      else
+        @logger.error( "Unsupported message type #{msg.data.class.to_s}" )
       end
+    end
 
-      event ||= event_factory.new_event
+    yield event_factory.new_event
+  rescue => e
+    @logger.error("Failed to create event", :message => msg, :exception => e,
+                  :backtrace => e.backtrace)
+  end
 
+  def queue_events(msg, output_queue)
+    events(msg).map do |event|
       # Here, we can use the JMS Enqueue timestamp as the @timestamp
       if @use_jms_timestamp && msg.jms_timestamp
         event.set("@timestamp", LogStash::Timestamp.at(msg.jms_timestamp / 1000, (msg.jms_timestamp % 1000) * 1000))
@@ -327,12 +334,9 @@ class LogStash::Inputs::Jms < LogStash::Inputs::Threadable
         @properties_setter.call(event, properties)
       end
 
-      decorate(event)
-      output_queue << event
-
-    rescue => e # parse or event creation error
-      @logger.error("Failed to create event", :message => msg, :exception => e,
-                    :backtrace => e.backtrace)
+      event
+    end.each do |ready_event|
+      output_queue << ready_event
     end
   end
 
@@ -365,9 +369,17 @@ class LogStash::Inputs::Jms < LogStash::Inputs::Threadable
 
   # @param msg [JMS::MapMessage]
   # @return [LogStash::Event]
-  def process_map_message(msg)
+  def process_map_message(msg, &event_handler)
     data = to_string_keyed_hash(msg.data)
-    do_target_check_once_and_get_event_factory.new_event(data)
+    yield do_target_check_once_and_get_event_factory.new_event(data)
+  end
+
+  def process_string_message(msg, &event_handler)
+    text = msg.to_s # javax.jms.TextMessage#getText (e.g. JSON payload)
+    return event_factory.new_event if text.nil?
+
+    @codec.decode(text, &event_handler)
+    @codec.flush(&event_handler)
   end
 
   def do_target_check_once_and_get_event_factory

data/logstash-input-jms.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
 
   s.name            = 'logstash-input-jms'
-  s.version         = '3.2.2'
+  s.version         = '3.3.0'
   s.licenses        = ['Apache License (2.0)']
   s.summary         = "Reads events from a Jms Broker"
   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"
@@ -32,5 +32,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "jruby-jms", ">= 1.2.0" #(Apache 2.0 license)
   s.add_runtime_dependency 'semantic_logger', '< 4.0.0'
 
+  s.add_development_dependency 'logstash-codec-line', '~> 3.0'
   s.add_development_dependency 'logstash-devutils'
 end

data/spec/inputs/integration/jms_spec.rb

@@ -241,6 +241,19 @@ shared_examples_for "a JMS input" do
 
         end
       end
+
+      context 'when using a multi-event codec' do
+        let(:config) { super().merge('codec' => 'line') }
+        let(:message) { 'one' + "\n" + 'two' + "\n" + 'three' }
+        it 'emits multiple events' do
+          send_message do |session|
+            session.message(message)
+          end
+          expect(queue.size).to eql 3
+          expect(queue.map { |e| e.get('message') }).to contain_exactly("one", "two", "three")
+          expect(queue).to all(have_header_value("jms_destination", destination))
+        end
+      end
     end
 
     context 'when the message is map message', :ecs_compatibility_support do

data/spec/inputs/unit/jms_spec.rb

@@ -291,7 +291,7 @@ describe LogStash::Inputs::Jms do
         allow_any_instance_of(described_class).to receive(:ecs_compatibility).and_return(ecs_compatibility)
 
         plugin.register
-        plugin.queue_event(jms_message_double, queue = [])
+        plugin.queue_events(jms_message_double, queue = [])
         expect(queue.size).to eql 1
         @event = queue.first
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstash-input-jms
 version: !ruby/object:Gem::Version
-  version: 3.2.2
+  version: 3.3.0
 platform: java
 authors:
 - Elasticsearch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-13 00:00:00.000000000 Z
+date: 2025-03-07 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: '3.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: '3.0'
   name: logstash-codec-plain
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -65,8 +65,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
   name: logstash-mixin-ecs_compatibility_support
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -79,8 +79,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
   name: logstash-mixin-event_support
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -93,8 +93,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
   name: logstash-mixin-validator_support
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -107,8 +107,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.2.0
   name: jruby-jms
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -121,13 +121,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.0.0
   name: semantic_logger
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
         version: 4.0.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  name: logstash-codec-line
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   requirement: !ruby/object:Gem::Requirement
     requirements:
@@ -135,8 +149,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
   name: logstash-devutils
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -186,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Reads events from a Jms Broker