logstash-input-jms 3.0.1-java → 3.0.2-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 +4 -4
- data/Gemfile +9 -0
- data/docs/index.asciidoc +259 -0
- data/logstash-input-jms.gemspec +2 -2
- metadata +4 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 538e55695a5feb8466d82128a3c0ba25ab29ca2a
|
4
|
+
data.tar.gz: b2d3063c325badf9d05aa7066305daf8d08b421d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9d8800e40a80b7a4b17babb6c0cb6c27d5224f0d047ececb3473ed9caed068c131164e3a73757a4af5c80a2e3d95dffdb4c629d63d247a9397667524f2074606
|
7
|
+
data.tar.gz: 4315879d002e4ffab5689f79b389d17fbc696ea542e3a147537b4e3f53451644027af53c9badef6641349c84e16952430b9ddbb6b34bdf1c987970caca7aaeeb
|
data/Gemfile
CHANGED
@@ -1,2 +1,11 @@
|
|
1
1
|
source 'https://rubygems.org'
|
2
|
+
|
2
3
|
gemspec
|
4
|
+
|
5
|
+
logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
|
6
|
+
use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
|
7
|
+
|
8
|
+
if Dir.exist?(logstash_path) && use_logstash_source
|
9
|
+
gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
|
10
|
+
gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
|
11
|
+
end
|
data/docs/index.asciidoc
ADDED
@@ -0,0 +1,259 @@
|
|
1
|
+
:plugin: jms
|
2
|
+
:type: input
|
3
|
+
|
4
|
+
///////////////////////////////////////////
|
5
|
+
START - GENERATED VARIABLES, DO NOT EDIT!
|
6
|
+
///////////////////////////////////////////
|
7
|
+
:version: %VERSION%
|
8
|
+
:release_date: %RELEASE_DATE%
|
9
|
+
:changelog_url: %CHANGELOG_URL%
|
10
|
+
:include_path: ../../../../logstash/docs/include
|
11
|
+
///////////////////////////////////////////
|
12
|
+
END - GENERATED VARIABLES, DO NOT EDIT!
|
13
|
+
///////////////////////////////////////////
|
14
|
+
|
15
|
+
[id="plugins-{type}-{plugin}"]
|
16
|
+
|
17
|
+
=== Jms input plugin
|
18
|
+
|
19
|
+
include::{include_path}/plugin_header.asciidoc[]
|
20
|
+
|
21
|
+
==== Description
|
22
|
+
|
23
|
+
Read events from a Jms Broker. Supports both Jms Queues and Topics.
|
24
|
+
|
25
|
+
For more information about Jms, see <http://docs.oracle.com/javaee/6/tutorial/doc/bncdq.html>
|
26
|
+
For more information about the Ruby Gem used, see <http://github.com/reidmorrison/jruby-jms>
|
27
|
+
Here is a config example to pull from a queue:
|
28
|
+
jms {
|
29
|
+
include_header => false
|
30
|
+
include_properties => false
|
31
|
+
include_body => true
|
32
|
+
use_jms_timestamp => false
|
33
|
+
interval => 10
|
34
|
+
destination => "myqueue"
|
35
|
+
pub-sub => false
|
36
|
+
yaml_file => "~/jms.yml"
|
37
|
+
yaml_section => "mybroker"
|
38
|
+
}
|
39
|
+
|
40
|
+
|
41
|
+
|
42
|
+
[id="plugins-{type}s-{plugin}-options"]
|
43
|
+
==== Jms Input Configuration Options
|
44
|
+
|
45
|
+
This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.
|
46
|
+
|
47
|
+
[cols="<,<,<",options="header",]
|
48
|
+
|=======================================================================
|
49
|
+
|Setting |Input type|Required
|
50
|
+
| <<plugins-{type}s-{plugin}-broker_url>> |<<string,string>>|No
|
51
|
+
| <<plugins-{type}s-{plugin}-destination>> |<<string,string>>|Yes
|
52
|
+
| <<plugins-{type}s-{plugin}-factory>> |<<string,string>>|No
|
53
|
+
| <<plugins-{type}s-{plugin}-include_body>> |<<boolean,boolean>>|No
|
54
|
+
| <<plugins-{type}s-{plugin}-include_header>> |<<boolean,boolean>>|No
|
55
|
+
| <<plugins-{type}s-{plugin}-include_properties>> |<<boolean,boolean>>|No
|
56
|
+
| <<plugins-{type}s-{plugin}-interval>> |<<number,number>>|No
|
57
|
+
| <<plugins-{type}s-{plugin}-jndi_context>> |<<hash,hash>>|No
|
58
|
+
| <<plugins-{type}s-{plugin}-jndi_name>> |<<string,string>>|No
|
59
|
+
| <<plugins-{type}s-{plugin}-password>> |<<string,string>>|No
|
60
|
+
| <<plugins-{type}s-{plugin}-pub_sub>> |<<boolean,boolean>>|No
|
61
|
+
| <<plugins-{type}s-{plugin}-require_jars>> |<<array,array>>|No
|
62
|
+
| <<plugins-{type}s-{plugin}-runner>> |<<string,string>>, one of `["consumer", "async", "thread"]`|No
|
63
|
+
| <<plugins-{type}s-{plugin}-selector>> |<<string,string>>|No
|
64
|
+
| <<plugins-{type}s-{plugin}-threads>> |<<number,number>>|No
|
65
|
+
| <<plugins-{type}s-{plugin}-timeout>> |<<number,number>>|No
|
66
|
+
| <<plugins-{type}s-{plugin}-use_jms_timestamp>> |<<boolean,boolean>>|No
|
67
|
+
| <<plugins-{type}s-{plugin}-username>> |<<string,string>>|No
|
68
|
+
| <<plugins-{type}s-{plugin}-yaml_file>> |<<string,string>>|No
|
69
|
+
| <<plugins-{type}s-{plugin}-yaml_section>> |<<string,string>>|No
|
70
|
+
|=======================================================================
|
71
|
+
|
72
|
+
Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
|
73
|
+
input plugins.
|
74
|
+
|
75
|
+
|
76
|
+
|
77
|
+
[id="plugins-{type}s-{plugin}-broker_url"]
|
78
|
+
===== `broker_url`
|
79
|
+
|
80
|
+
* Value type is <<string,string>>
|
81
|
+
* There is no default value for this setting.
|
82
|
+
|
83
|
+
Url to use when connecting to the JMS provider
|
84
|
+
|
85
|
+
[id="plugins-{type}s-{plugin}-destination"]
|
86
|
+
===== `destination`
|
87
|
+
|
88
|
+
* This is a required setting.
|
89
|
+
* Value type is <<string,string>>
|
90
|
+
* There is no default value for this setting.
|
91
|
+
|
92
|
+
Name of the destination queue or topic to use.
|
93
|
+
|
94
|
+
[id="plugins-{type}s-{plugin}-factory"]
|
95
|
+
===== `factory`
|
96
|
+
|
97
|
+
* Value type is <<string,string>>
|
98
|
+
* There is no default value for this setting.
|
99
|
+
|
100
|
+
Name of JMS Provider Factory class
|
101
|
+
|
102
|
+
[id="plugins-{type}s-{plugin}-include_body"]
|
103
|
+
===== `include_body`
|
104
|
+
|
105
|
+
* Value type is <<boolean,boolean>>
|
106
|
+
* Default value is `true`
|
107
|
+
|
108
|
+
Include JMS Message Body in the event
|
109
|
+
Supports TextMessage, MapMessage and ByteMessage
|
110
|
+
If the JMS Message is a TextMessage or ByteMessage, then the value will be in the "message" field of the event
|
111
|
+
If the JMS Message is a MapMessage, then all the key/value pairs will be added in the Hashmap of the event
|
112
|
+
StreamMessage and ObjectMessage are not supported
|
113
|
+
|
114
|
+
[id="plugins-{type}s-{plugin}-include_header"]
|
115
|
+
===== `include_header`
|
116
|
+
|
117
|
+
* Value type is <<boolean,boolean>>
|
118
|
+
* Default value is `true`
|
119
|
+
|
120
|
+
A JMS message has three parts :
|
121
|
+
Message Headers (required)
|
122
|
+
Message Properties (optional)
|
123
|
+
Message Bodies (optional)
|
124
|
+
You can tell the input plugin which parts should be included in the event produced by Logstash
|
125
|
+
|
126
|
+
Include JMS Message Header Field values in the event
|
127
|
+
|
128
|
+
[id="plugins-{type}s-{plugin}-include_properties"]
|
129
|
+
===== `include_properties`
|
130
|
+
|
131
|
+
* Value type is <<boolean,boolean>>
|
132
|
+
* Default value is `true`
|
133
|
+
|
134
|
+
Include JMS Message Properties Field values in the event
|
135
|
+
|
136
|
+
[id="plugins-{type}s-{plugin}-interval"]
|
137
|
+
===== `interval`
|
138
|
+
|
139
|
+
* Value type is <<number,number>>
|
140
|
+
* Default value is `10`
|
141
|
+
|
142
|
+
Polling interval in seconds.
|
143
|
+
This is the time sleeping between asks to a consumed Queue.
|
144
|
+
This parameter has non influence in the case of a subcribed Topic.
|
145
|
+
|
146
|
+
[id="plugins-{type}s-{plugin}-jndi_context"]
|
147
|
+
===== `jndi_context`
|
148
|
+
|
149
|
+
* Value type is <<hash,hash>>
|
150
|
+
* There is no default value for this setting.
|
151
|
+
|
152
|
+
Mandatory if jndi lookup is being used,
|
153
|
+
contains details on how to connect to JNDI server
|
154
|
+
|
155
|
+
[id="plugins-{type}s-{plugin}-jndi_name"]
|
156
|
+
===== `jndi_name`
|
157
|
+
|
158
|
+
* Value type is <<string,string>>
|
159
|
+
* There is no default value for this setting.
|
160
|
+
|
161
|
+
Name of JNDI entry at which the Factory can be found
|
162
|
+
|
163
|
+
[id="plugins-{type}s-{plugin}-password"]
|
164
|
+
===== `password`
|
165
|
+
|
166
|
+
* Value type is <<string,string>>
|
167
|
+
* There is no default value for this setting.
|
168
|
+
|
169
|
+
Password to use when connecting to the JMS provider
|
170
|
+
|
171
|
+
[id="plugins-{type}s-{plugin}-pub_sub"]
|
172
|
+
===== `pub_sub`
|
173
|
+
|
174
|
+
* Value type is <<boolean,boolean>>
|
175
|
+
* Default value is `false`
|
176
|
+
|
177
|
+
If pub-sub (topic) style should be used.
|
178
|
+
|
179
|
+
[id="plugins-{type}s-{plugin}-require_jars"]
|
180
|
+
===== `require_jars`
|
181
|
+
|
182
|
+
* Value type is <<array,array>>
|
183
|
+
* There is no default value for this setting.
|
184
|
+
|
185
|
+
If you do not use an yaml configuration use either the factory or jndi_name.
|
186
|
+
An optional array of Jar file names to load for the specified
|
187
|
+
JMS provider. By using this option it is not necessary
|
188
|
+
to put all the JMS Provider specific jar files into the
|
189
|
+
java CLASSPATH prior to starting Logstash.
|
190
|
+
|
191
|
+
[id="plugins-{type}s-{plugin}-runner"]
|
192
|
+
===== `runner`
|
193
|
+
|
194
|
+
* Value can be any of: `consumer`, `async`, `thread`
|
195
|
+
* Default value is `"consumer"`
|
196
|
+
|
197
|
+
Choose an implementation of the run block. Value can be either consumer, async or thread
|
198
|
+
|
199
|
+
[id="plugins-{type}s-{plugin}-selector"]
|
200
|
+
===== `selector`
|
201
|
+
|
202
|
+
* Value type is <<string,string>>
|
203
|
+
* There is no default value for this setting.
|
204
|
+
|
205
|
+
Set the selector to use to get messages off the queue or topic
|
206
|
+
|
207
|
+
[id="plugins-{type}s-{plugin}-threads"]
|
208
|
+
===== `threads`
|
209
|
+
|
210
|
+
* Value type is <<number,number>>
|
211
|
+
* Default value is `1`
|
212
|
+
|
213
|
+
|
214
|
+
|
215
|
+
[id="plugins-{type}s-{plugin}-timeout"]
|
216
|
+
===== `timeout`
|
217
|
+
|
218
|
+
* Value type is <<number,number>>
|
219
|
+
* Default value is `60`
|
220
|
+
|
221
|
+
Initial connection timeout in seconds.
|
222
|
+
|
223
|
+
[id="plugins-{type}s-{plugin}-use_jms_timestamp"]
|
224
|
+
===== `use_jms_timestamp`
|
225
|
+
|
226
|
+
* Value type is <<boolean,boolean>>
|
227
|
+
* Default value is `false`
|
228
|
+
|
229
|
+
Convert the JMSTimestamp header field to the @timestamp value of the event
|
230
|
+
|
231
|
+
[id="plugins-{type}s-{plugin}-username"]
|
232
|
+
===== `username`
|
233
|
+
|
234
|
+
* Value type is <<string,string>>
|
235
|
+
* There is no default value for this setting.
|
236
|
+
|
237
|
+
Username to connect to JMS provider with
|
238
|
+
|
239
|
+
[id="plugins-{type}s-{plugin}-yaml_file"]
|
240
|
+
===== `yaml_file`
|
241
|
+
|
242
|
+
* Value type is <<string,string>>
|
243
|
+
* There is no default value for this setting.
|
244
|
+
|
245
|
+
Yaml config file
|
246
|
+
|
247
|
+
[id="plugins-{type}s-{plugin}-yaml_section"]
|
248
|
+
===== `yaml_section`
|
249
|
+
|
250
|
+
* Value type is <<string,string>>
|
251
|
+
* There is no default value for this setting.
|
252
|
+
|
253
|
+
Yaml config file section name
|
254
|
+
For some known examples, see: [Example jms.yml](https://github.com/reidmorrison/jruby-jms/blob/master/examples/jms.yml)
|
255
|
+
|
256
|
+
|
257
|
+
|
258
|
+
[id="plugins-{type}s-{plugin}-common-options"]
|
259
|
+
include::{include_path}/{type}.asciidoc[]
|
data/logstash-input-jms.gemspec
CHANGED
@@ -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.
|
4
|
+
s.version = '3.0.2'
|
5
5
|
s.licenses = ['Apache License (2.0)']
|
6
6
|
s.summary = "Pull events from a JMS topic or queue."
|
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"
|
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
|
|
11
11
|
s.require_paths = ["lib"]
|
12
12
|
|
13
13
|
# Files
|
14
|
-
s.files = Dir[
|
14
|
+
s.files = Dir["lib/**/*","spec/**/*","*.gemspec","*.md","CONTRIBUTORS","Gemfile","LICENSE","NOTICE.TXT", "vendor/jar-dependencies/**/*.jar", "vendor/jar-dependencies/**/*.rb", "VERSION", "docs/**/*"]
|
15
15
|
|
16
16
|
# Tests
|
17
17
|
s.test_files = s.files.grep(%r{^(test|spec|features)/})
|
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.
|
4
|
+
version: 3.0.2
|
5
5
|
platform: java
|
6
6
|
authors:
|
7
7
|
- Elasticsearch
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2017-
|
11
|
+
date: 2017-06-23 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
requirement: !ruby/object:Gem::Requirement
|
@@ -110,6 +110,7 @@ files:
|
|
110
110
|
- Gemfile
|
111
111
|
- NOTICE.TXT
|
112
112
|
- README.md
|
113
|
+
- docs/index.asciidoc
|
113
114
|
- lib/logstash/inputs/jms.rb
|
114
115
|
- logstash-input-jms.gemspec
|
115
116
|
- spec/inputs/jms.yml
|
@@ -136,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
136
137
|
version: '0'
|
137
138
|
requirements: []
|
138
139
|
rubyforge_project:
|
139
|
-
rubygems_version: 2.
|
140
|
+
rubygems_version: 2.4.8
|
140
141
|
signing_key:
|
141
142
|
specification_version: 4
|
142
143
|
summary: Pull events from a JMS topic or queue.
|