logstash-input-jms 3.0.5-java → 3.0.6-java

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 1281f6e58680967a0df02a1bd0f9044b2dae7cab4ec64c32f257bbaa3f6e71f4
4
- data.tar.gz: 8f7b6f26183b29766ce7b9abef8b02c943e6ec1b616e642bf12fe4cc5f0bd2b0
3
+ metadata.gz: 4e0b7da08d783aaa34842119cb780c5f52b00483b09c652d779da9c1f1ba24d0
4
+ data.tar.gz: 4c96668a804e020bb50c57fd6258cf4cfddb136fc0fde1ff81f8dbdc95dca74b
5
5
  SHA512:
6
- metadata.gz: bf071ee72b2ad658767a79702dd40f180d5fc2e7a70c55ca8585874b406e4eb8089282fc41c44daee3de7881198c813244d819a8dc6977850037fcef446efc56
7
- data.tar.gz: 80c078c0313b6bf5837789e97b82348e92941c9761b1c60caf5d2a71d9132c9cd08f51985efb90a42bae548bf8ac9456c7e1eea39d1b7ed96d4871252db95e9f
6
+ metadata.gz: 9261b580965f2c5f0ba2ad29966ef9a47b2302652da035c6f917c81742c02954ac05cf49a0d164a6740f704e93448b6e388f5c9004fbfd6af1ad490eff2a6929
7
+ data.tar.gz: 0ddc3508282986ea0ffec41e4a49b07ba6f24a7ea7b2ee67b043370442190130ed92b3f47bf3f77f89bcecea0f14c9485b8377e9a33796eaafb8b9f702d107cf
data/CHANGELOG.md CHANGED
@@ -1,3 +1,6 @@
1
+ ## 3.0.6
2
+ - Fixed formatting issues in documentation [#32](https://github.com/logstash-plugins/logstash-input-jms/pull/32) and [#33](https://github.com/logstash-plugins/logstash-input-jms/pull/33]
3
+
1
4
  ## 3.0.5
2
5
  - Docs: Set the default_codec doc attribute.
3
6
 
data/docs/index.asciidoc CHANGED
@@ -23,9 +23,12 @@ include::{include_path}/plugin_header.asciidoc[]
23
23
 
24
24
  Read events from a Jms Broker. Supports both Jms Queues and Topics.
25
25
 
26
- For more information about Jms, see <http://docs.oracle.com/javaee/6/tutorial/doc/bncdq.html>
27
- For more information about the Ruby Gem used, see <http://github.com/reidmorrison/jruby-jms>
26
+ For more information about Jms, see <http://docs.oracle.com/javaee/6/tutorial/doc/bncdq.html>.
27
+ For more information about the Ruby Gem used, see <http://github.com/reidmorrison/jruby-jms>.
28
28
  Here is a config example to pull from a queue:
29
+
30
+ [source,ruby]
31
+ ----
29
32
  jms {
30
33
  include_header => false
31
34
  include_properties => false
@@ -37,7 +40,7 @@ Here is a config example to pull from a queue:
37
40
  yaml_file => "~/jms.yml"
38
41
  yaml_section => "mybroker"
39
42
  }
40
-
43
+ ----
41
44
 
42
45
 
43
46
  [id="plugins-{type}s-{plugin}-options"]
@@ -57,6 +60,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
57
60
  | <<plugins-{type}s-{plugin}-interval>> |<<number,number>>|No
58
61
  | <<plugins-{type}s-{plugin}-jndi_context>> |<<hash,hash>>|No
59
62
  | <<plugins-{type}s-{plugin}-jndi_name>> |<<string,string>>|No
63
+ | <<plugins-{type}s-{plugin}-oracle_aq_buffered_messages>> |<<boolean,boolean>>|No
60
64
  | <<plugins-{type}s-{plugin}-password>> |<<string,string>>|No
61
65
  | <<plugins-{type}s-{plugin}-pub_sub>> |<<boolean,boolean>>|No
62
66
  | <<plugins-{type}s-{plugin}-require_jars>> |<<array,array>>|No
@@ -81,7 +85,7 @@ input plugins.
81
85
  * Value type is <<string,string>>
82
86
  * There is no default value for this setting.
83
87
 
84
- Url to use when connecting to the JMS provider
88
+ Url to use when connecting to the JMS provider.
85
89
 
86
90
  [id="plugins-{type}s-{plugin}-destination"]
87
91
  ===== `destination`
@@ -98,7 +102,7 @@ Name of the destination queue or topic to use.
98
102
  * Value type is <<string,string>>
99
103
  * There is no default value for this setting.
100
104
 
101
- Name of JMS Provider Factory class
105
+ Name of JMS Provider Factory class.
102
106
 
103
107
  [id="plugins-{type}s-{plugin}-include_body"]
104
108
  ===== `include_body`
@@ -106,11 +110,14 @@ Name of JMS Provider Factory class
106
110
  * Value type is <<boolean,boolean>>
107
111
  * Default value is `true`
108
112
 
109
- Include JMS Message Body in the event
110
- Supports TextMessage, MapMessage and ByteMessage
111
- If the JMS Message is a TextMessage or ByteMessage, then the value will be in the "message" field of the event
112
- If the JMS Message is a MapMessage, then all the key/value pairs will be added in the Hashmap of the event
113
- StreamMessage and ObjectMessage are not supported
113
+ Include JMS Message Body in the event.
114
+ Supports TextMessage, MapMessage and ByteMessage.
115
+
116
+ If the JMS Message is a TextMessage or ByteMessage, then the value will be in
117
+ the "message" field of the event. If the JMS Message is a MapMessage, then all
118
+ the key/value pairs will be added in the Hashmap of the event.
119
+
120
+ StreamMessage and ObjectMessage are not supported.
114
121
 
115
122
  [id="plugins-{type}s-{plugin}-include_header"]
116
123
  ===== `include_header`
@@ -118,13 +125,15 @@ StreamMessage and ObjectMessage are not supported
118
125
  * Value type is <<boolean,boolean>>
119
126
  * Default value is `true`
120
127
 
121
- A JMS message has three parts :
122
- Message Headers (required)
123
- Message Properties (optional)
124
- Message Bodies (optional)
125
- You can tell the input plugin which parts should be included in the event produced by Logstash
128
+ A JMS message has three parts:
126
129
 
127
- Include JMS Message Header Field values in the event
130
+ * Message Headers (required)
131
+ * Message Properties (optional)
132
+ * Message Bodies (optional)
133
+
134
+ You can tell the input plugin which parts should be included in the event produced by Logstash.
135
+
136
+ Include JMS Message Header Field values in the event.
128
137
 
129
138
  [id="plugins-{type}s-{plugin}-include_properties"]
130
139
  ===== `include_properties`
@@ -132,7 +141,7 @@ Include JMS Message Header Field values in the event
132
141
  * Value type is <<boolean,boolean>>
133
142
  * Default value is `true`
134
143
 
135
- Include JMS Message Properties Field values in the event
144
+ Include JMS Message Properties Field values in the event.
136
145
 
137
146
  [id="plugins-{type}s-{plugin}-interval"]
138
147
  ===== `interval`
@@ -150,8 +159,8 @@ This parameter has non influence in the case of a subcribed Topic.
150
159
  * Value type is <<hash,hash>>
151
160
  * There is no default value for this setting.
152
161
 
153
- Mandatory if jndi lookup is being used,
154
- contains details on how to connect to JNDI server
162
+ Mandatory if jndi lookup is being used.
163
+ Contains details on how to connect to JNDI server.
155
164
 
156
165
  [id="plugins-{type}s-{plugin}-jndi_name"]
157
166
  ===== `jndi_name`
@@ -159,7 +168,16 @@ contains details on how to connect to JNDI server
159
168
  * Value type is <<string,string>>
160
169
  * There is no default value for this setting.
161
170
 
162
- Name of JNDI entry at which the Factory can be found
171
+ Name of JNDI entry at which the Factory can be found.
172
+
173
+ [id="plugins-{type}s-{plugin}-oracle_aq_buffered_messages"]
174
+ ===== `oracle_aq_buffered_messages`
175
+
176
+ * Value type is <<boolean,boolean>>
177
+ * Default value is `false`
178
+
179
+ Receive Oracle AQ buffered messages.
180
+ In this mode persistent Oracle AQ JMS messages will not be received.
163
181
 
164
182
  [id="plugins-{type}s-{plugin}-password"]
165
183
  ===== `password`
@@ -167,7 +185,7 @@ Name of JNDI entry at which the Factory can be found
167
185
  * Value type is <<string,string>>
168
186
  * There is no default value for this setting.
169
187
 
170
- Password to use when connecting to the JMS provider
188
+ Password to use when connecting to the JMS provider.
171
189
 
172
190
  [id="plugins-{type}s-{plugin}-pub_sub"]
173
191
  ===== `pub_sub`
@@ -195,7 +213,7 @@ java CLASSPATH prior to starting Logstash.
195
213
  * Value can be any of: `consumer`, `async`, `thread`
196
214
  * Default value is `"consumer"`
197
215
 
198
- Choose an implementation of the run block. Value can be either consumer, async or thread
216
+ Choose an implementation of the run block. Value can be `consumer`, `async` or `thread`.
199
217
 
200
218
  [id="plugins-{type}s-{plugin}-selector"]
201
219
  ===== `selector`
@@ -203,7 +221,7 @@ Choose an implementation of the run block. Value can be either consumer, async o
203
221
  * Value type is <<string,string>>
204
222
  * There is no default value for this setting.
205
223
 
206
- Set the selector to use to get messages off the queue or topic
224
+ Set the selector to use to get messages off the queue or topic.
207
225
 
208
226
  [id="plugins-{type}s-{plugin}-threads"]
209
227
  ===== `threads`
@@ -211,8 +229,6 @@ Set the selector to use to get messages off the queue or topic
211
229
  * Value type is <<number,number>>
212
230
  * Default value is `1`
213
231
 
214
-
215
-
216
232
  [id="plugins-{type}s-{plugin}-timeout"]
217
233
  ===== `timeout`
218
234
 
@@ -227,7 +243,7 @@ Initial connection timeout in seconds.
227
243
  * Value type is <<boolean,boolean>>
228
244
  * Default value is `false`
229
245
 
230
- Convert the JMSTimestamp header field to the @timestamp value of the event
246
+ Convert the JMSTimestamp header field to the @timestamp value of the event.
231
247
 
232
248
  [id="plugins-{type}s-{plugin}-username"]
233
249
  ===== `username`
@@ -235,7 +251,7 @@ Convert the JMSTimestamp header field to the @timestamp value of the event
235
251
  * Value type is <<string,string>>
236
252
  * There is no default value for this setting.
237
253
 
238
- Username to connect to JMS provider with
254
+ Username to use for connecting to JMS provider.
239
255
 
240
256
  [id="plugins-{type}s-{plugin}-yaml_file"]
241
257
  ===== `yaml_file`
@@ -252,11 +268,11 @@ Yaml config file
252
268
  * There is no default value for this setting.
253
269
 
254
270
  Yaml config file section name
255
- For some known examples, see: [Example jms.yml](https://github.com/reidmorrison/jruby-jms/blob/master/examples/jms.yml)
271
+ For some known examples, see https://github.com/reidmorrison/jruby-jms/blob/master/examples/jms.yml[jms.yml examples].
256
272
 
257
273
 
258
274
 
259
275
  [id="plugins-{type}s-{plugin}-common-options"]
260
276
  include::{include_path}/{type}.asciidoc[]
261
277
 
262
- :default_codec!:
278
+ :default_codec!:
@@ -39,6 +39,11 @@ class LogStash::Inputs::Jms < LogStash::Inputs::Threadable
39
39
  # If the JMS Message is a TextMessage or ByteMessage, then the value will be in the "message" field of the event
40
40
  # If the JMS Message is a MapMessage, then all the key/value pairs will be added in the Hashmap of the event
41
41
  # StreamMessage and ObjectMessage are not supported
42
+
43
+ # Receive Oracle AQ buffered messages.
44
+ # In this mode persistent Oracle AQ JMS messages will not be received.
45
+ config :oracle_aq_buffered_messages, :validate => :boolean, :default => false
46
+
42
47
  config :include_body, :validate => :boolean, :default => true
43
48
 
44
49
  # Convert the JMSTimestamp header field to the @timestamp value of the event
@@ -186,7 +191,7 @@ class LogStash::Inputs::Jms < LogStash::Inputs::Threadable
186
191
  JMS::Connection.session(@jms_config) do |session|
187
192
  destination_key = @pub_sub ? :topic_name : :queue_name
188
193
  while !stop?
189
- session.consume(destination_key => @destination, :timeout=>@timeout, :selector => @selector) do |message|
194
+ session.consume(destination_key => @destination, :timeout=>@timeout, :selector => @selector, :buffered_message => @oracle_aq_buffered_messages) do |message|
190
195
  queue_event message, output_queue
191
196
  break if stop?
192
197
  end
@@ -1,7 +1,7 @@
1
1
  Gem::Specification.new do |s|
2
2
 
3
3
  s.name = 'logstash-input-jms'
4
- s.version = '3.0.5'
4
+ s.version = '3.0.6'
5
5
  s.licenses = ['Apache License (2.0)']
6
6
  s.summary = "Reads events from a Jms Broker"
7
7
  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"
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: logstash-input-jms
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.5
4
+ version: 3.0.6
5
5
  platform: java
6
6
  authors:
7
7
  - Elasticsearch
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-04-06 00:00:00.000000000 Z
11
+ date: 2019-05-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  requirement: !ruby/object:Gem::Requirement
@@ -139,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
139
139
  version: '0'
140
140
  requirements: []
141
141
  rubyforge_project:
142
- rubygems_version: 2.6.11
142
+ rubygems_version: 2.6.13
143
143
  signing_key:
144
144
  specification_version: 4
145
145
  summary: Reads events from a Jms Broker