logstash-input-sqs 3.0.5 → 3.1.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/CHANGELOG.md +16 -0
- data/Gemfile +4 -0
- data/LICENSE +199 -10
- data/docs/index.asciidoc +40 -6
- data/lib/logstash/inputs/sqs.rb +31 -31
- data/logstash-input-sqs.gemspec +4 -3
- data/spec/inputs/sqs_spec.rb +76 -3
- metadata +23 -7
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
|
-
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 62052e70008ae3f83113fdd4d78bbd83624d357e5efb9ce4767bd724c8442cf2
|
|
4
|
+
data.tar.gz: b04b422569e0105cf038972e235c15280acc6bdca4be8303b05aad56256a6659
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 36f7bae7b415c1fe4b475ffea461a23e8e431d16c082f1c19491c6640a2bc0fdb73e1f1eb230d025b5a8ac2d60cc55bc37cc28ae22055bd92d7e921260c3eff0
|
|
7
|
+
data.tar.gz: 98987e8fa698be674e48b02456f25e72422c78b2148748f0e924e05953c095c59074188e5f17bc124a3b18b7d291f1e2a6f906c24895f96d24fb9b3ecda190ad
|
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,19 @@
|
|
|
1
|
+
## 3.1.3
|
|
2
|
+
- Fix: retry networking errors (with backoff) [#57](https://github.com/logstash-plugins/logstash-input-sqs/pull/57)
|
|
3
|
+
|
|
4
|
+
## 3.1.2
|
|
5
|
+
- Added support for multiple events inside same message from SQS [#48](https://github.com/logstash-plugins/logstash-input-sqs/pull/48/files)
|
|
6
|
+
|
|
7
|
+
## 3.1.1
|
|
8
|
+
- Docs: Set the default_codec doc attribute.
|
|
9
|
+
|
|
10
|
+
## 3.1.0
|
|
11
|
+
- Add documentation for endpoint, role_arn and role_session_name #46
|
|
12
|
+
- Fix sample IAM policy to match to match the documentation #32
|
|
13
|
+
|
|
14
|
+
## 3.0.6
|
|
15
|
+
- Update gemspec summary
|
|
16
|
+
|
|
1
17
|
## 3.0.5
|
|
2
18
|
- Fix some documentation issues
|
|
3
19
|
|
data/Gemfile
CHANGED
|
@@ -9,3 +9,7 @@ if Dir.exist?(logstash_path) && use_logstash_source
|
|
|
9
9
|
gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
|
|
10
10
|
gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
|
|
11
11
|
end
|
|
12
|
+
|
|
13
|
+
if RUBY_VERSION == "1.9.3"
|
|
14
|
+
gem 'rake', '12.2.1'
|
|
15
|
+
end
|
data/LICENSE
CHANGED
|
@@ -1,13 +1,202 @@
|
|
|
1
|
-
Copyright (c) 2012–2016 Elasticsearch <http://www.elastic.co>
|
|
2
1
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
6
5
|
|
|
7
|
-
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
8
7
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2020 Elastic and contributors
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
data/docs/index.asciidoc
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
:plugin: sqs
|
|
2
2
|
:type: input
|
|
3
|
+
:default_codec: json
|
|
3
4
|
|
|
4
5
|
///////////////////////////////////////////
|
|
5
6
|
START - GENERATED VARIABLES, DO NOT EDIT!
|
|
@@ -35,7 +36,7 @@ To use this plugin, you *must*:
|
|
|
35
36
|
|
|
36
37
|
* Have an AWS account
|
|
37
38
|
* Setup an SQS queue
|
|
38
|
-
* Create an
|
|
39
|
+
* Create an identity that has access to consume messages from the queue.
|
|
39
40
|
|
|
40
41
|
The "consumer" identity must have the following permissions on the queue:
|
|
41
42
|
|
|
@@ -57,11 +58,12 @@ A sample policy is as follows:
|
|
|
57
58
|
"Action": [
|
|
58
59
|
"sqs:ChangeMessageVisibility",
|
|
59
60
|
"sqs:ChangeMessageVisibilityBatch",
|
|
61
|
+
"sqs:DeleteMessage",
|
|
62
|
+
"sqs:DeleteMessageBatch",
|
|
60
63
|
"sqs:GetQueueAttributes",
|
|
61
64
|
"sqs:GetQueueUrl",
|
|
62
65
|
"sqs:ListQueues",
|
|
63
|
-
"sqs:
|
|
64
|
-
"sqs:SendMessageBatch"
|
|
66
|
+
"sqs:ReceiveMessage"
|
|
65
67
|
],
|
|
66
68
|
"Effect": "Allow",
|
|
67
69
|
"Resource": [
|
|
@@ -84,12 +86,15 @@ This plugin supports the following configuration options plus the <<plugins-{typ
|
|
|
84
86
|
|Setting |Input type|Required
|
|
85
87
|
| <<plugins-{type}s-{plugin}-access_key_id>> |<<string,string>>|No
|
|
86
88
|
| <<plugins-{type}s-{plugin}-aws_credentials_file>> |<<string,string>>|No
|
|
89
|
+
| <<plugins-{type}s-{plugin}-endpoint>> |<<string,string>>|No
|
|
87
90
|
| <<plugins-{type}s-{plugin}-id_field>> |<<string,string>>|No
|
|
88
91
|
| <<plugins-{type}s-{plugin}-md5_field>> |<<string,string>>|No
|
|
89
92
|
| <<plugins-{type}s-{plugin}-polling_frequency>> |<<number,number>>|No
|
|
90
93
|
| <<plugins-{type}s-{plugin}-proxy_uri>> |<<string,string>>|No
|
|
91
94
|
| <<plugins-{type}s-{plugin}-queue>> |<<string,string>>|Yes
|
|
92
|
-
| <<plugins-{type}s-{plugin}-region>> |<<string,string
|
|
95
|
+
| <<plugins-{type}s-{plugin}-region>> |<<string,string>>|No
|
|
96
|
+
| <<plugins-{type}s-{plugin}-role_arn>> |<<string,string>>|No
|
|
97
|
+
| <<plugins-{type}s-{plugin}-role_session_name>> |<<string,string>>|No
|
|
93
98
|
| <<plugins-{type}s-{plugin}-secret_access_key>> |<<string,string>>|No
|
|
94
99
|
| <<plugins-{type}s-{plugin}-sent_timestamp_field>> |<<string,string>>|No
|
|
95
100
|
| <<plugins-{type}s-{plugin}-session_token>> |<<string,string>>|No
|
|
@@ -132,6 +137,15 @@ file should look like this:
|
|
|
132
137
|
:secret_access_key: "54321"
|
|
133
138
|
----------------------------------
|
|
134
139
|
|
|
140
|
+
[id="plugins-{type}s-{plugin}-endpoint"]
|
|
141
|
+
===== `endpoint`
|
|
142
|
+
|
|
143
|
+
* Value type is <<string,string>>
|
|
144
|
+
* There is no default value for this setting.
|
|
145
|
+
|
|
146
|
+
The endpoint to connect to. By default it is constructed using the value of `region`.
|
|
147
|
+
This is useful when connecting to S3 compatible services, but beware that these aren't
|
|
148
|
+
guaranteed to work correctly with the AWS SDK.
|
|
135
149
|
|
|
136
150
|
[id="plugins-{type}s-{plugin}-id_field"]
|
|
137
151
|
===== `id_field`
|
|
@@ -177,11 +191,29 @@ Name of the SQS Queue name to pull messages from. Note that this is just the nam
|
|
|
177
191
|
[id="plugins-{type}s-{plugin}-region"]
|
|
178
192
|
===== `region`
|
|
179
193
|
|
|
180
|
-
* Value
|
|
194
|
+
* Value type is <<string,string>>
|
|
181
195
|
* Default value is `"us-east-1"`
|
|
182
196
|
|
|
183
197
|
The AWS Region
|
|
184
198
|
|
|
199
|
+
[id="plugins-{type}s-{plugin}-role_arn"]
|
|
200
|
+
===== `role_arn`
|
|
201
|
+
|
|
202
|
+
* Value type is <<string,string>>
|
|
203
|
+
* There is no default value for this setting.
|
|
204
|
+
|
|
205
|
+
The AWS IAM Role to assume, if any.
|
|
206
|
+
This is used to generate temporary credentials, typically for cross-account access.
|
|
207
|
+
See the https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html[AssumeRole API documentation] for more information.
|
|
208
|
+
|
|
209
|
+
[id="plugins-{type}s-{plugin}-role_session_name"]
|
|
210
|
+
===== `role_session_name`
|
|
211
|
+
|
|
212
|
+
* Value type is <<string,string>>
|
|
213
|
+
* Default value is `"logstash"`
|
|
214
|
+
|
|
215
|
+
Session name to use when assuming an IAM role.
|
|
216
|
+
|
|
185
217
|
[id="plugins-{type}s-{plugin}-secret_access_key"]
|
|
186
218
|
===== `secret_access_key`
|
|
187
219
|
|
|
@@ -217,4 +249,6 @@ The AWS Session token for temporary credential
|
|
|
217
249
|
|
|
218
250
|
|
|
219
251
|
[id="plugins-{type}s-{plugin}-common-options"]
|
|
220
|
-
include::{include_path}/{type}.asciidoc[]
|
|
252
|
+
include::{include_path}/{type}.asciidoc[]
|
|
253
|
+
|
|
254
|
+
:default_codec!:
|
data/lib/logstash/inputs/sqs.rb
CHANGED
|
@@ -108,8 +108,8 @@ class LogStash::Inputs::SQS < LogStash::Inputs::Threadable
|
|
|
108
108
|
aws_sqs_client = Aws::SQS::Client.new(aws_options_hash)
|
|
109
109
|
queue_url = aws_sqs_client.get_queue_url(:queue_name => @queue)[:queue_url]
|
|
110
110
|
@poller = Aws::SQS::QueuePoller.new(queue_url, :client => aws_sqs_client)
|
|
111
|
-
rescue Aws::SQS::Errors::ServiceError => e
|
|
112
|
-
@logger.error("Cannot establish connection to Amazon SQS",
|
|
111
|
+
rescue Aws::SQS::Errors::ServiceError, Seahorse::Client::NetworkingError => e
|
|
112
|
+
@logger.error("Cannot establish connection to Amazon SQS", exception_details(e))
|
|
113
113
|
raise LogStash::ConfigurationError, "Verify the SQS queue name and your credentials"
|
|
114
114
|
end
|
|
115
115
|
|
|
@@ -121,25 +121,19 @@ class LogStash::Inputs::SQS < LogStash::Inputs::Threadable
|
|
|
121
121
|
}
|
|
122
122
|
end
|
|
123
123
|
|
|
124
|
-
def decode_event(message)
|
|
125
|
-
@codec.decode(message.body) do |event|
|
|
126
|
-
return event
|
|
127
|
-
end
|
|
128
|
-
end
|
|
129
|
-
|
|
130
124
|
def add_sqs_data(event, message)
|
|
131
125
|
event.set(@id_field, message.message_id) if @id_field
|
|
132
126
|
event.set(@md5_field, message.md5_of_body) if @md5_field
|
|
133
127
|
event.set(@sent_timestamp_field, convert_epoch_to_timestamp(message.attributes[SENT_TIMESTAMP])) if @sent_timestamp_field
|
|
134
|
-
|
|
135
|
-
return event
|
|
128
|
+
event
|
|
136
129
|
end
|
|
137
130
|
|
|
138
|
-
def handle_message(message)
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
131
|
+
def handle_message(message, output_queue)
|
|
132
|
+
@codec.decode(message.body) do |event|
|
|
133
|
+
add_sqs_data(event, message)
|
|
134
|
+
decorate(event)
|
|
135
|
+
output_queue << event
|
|
136
|
+
end
|
|
143
137
|
end
|
|
144
138
|
|
|
145
139
|
def run(output_queue)
|
|
@@ -148,11 +142,7 @@ class LogStash::Inputs::SQS < LogStash::Inputs::Threadable
|
|
|
148
142
|
run_with_backoff do
|
|
149
143
|
poller.poll(polling_options) do |messages, stats|
|
|
150
144
|
break if stop?
|
|
151
|
-
|
|
152
|
-
messages.each do |message|
|
|
153
|
-
output_queue << handle_message(message)
|
|
154
|
-
end
|
|
155
|
-
|
|
145
|
+
messages.each {|message| handle_message(message, output_queue) }
|
|
156
146
|
@logger.debug("SQS Stats:", :request_count => stats.request_count,
|
|
157
147
|
:received_message_count => stats.received_message_count,
|
|
158
148
|
:last_message_received_at => stats.last_message_received_at) if @logger.debug?
|
|
@@ -161,28 +151,38 @@ class LogStash::Inputs::SQS < LogStash::Inputs::Threadable
|
|
|
161
151
|
end
|
|
162
152
|
|
|
163
153
|
private
|
|
154
|
+
|
|
164
155
|
# Runs an AWS request inside a Ruby block with an exponential backoff in case
|
|
165
156
|
# we experience a ServiceError.
|
|
166
157
|
#
|
|
167
|
-
# @param [Integer] max_time maximum amount of time to sleep before giving up.
|
|
168
|
-
# @param [Integer] sleep_time the initial amount of time to sleep before retrying.
|
|
169
158
|
# @param [Block] block Ruby code block to execute.
|
|
170
|
-
def run_with_backoff(
|
|
171
|
-
|
|
172
|
-
|
|
159
|
+
def run_with_backoff(&block)
|
|
160
|
+
sleep_time = BACKOFF_SLEEP_TIME
|
|
173
161
|
begin
|
|
174
162
|
block.call
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
sleep(next_sleep)
|
|
179
|
-
next_sleep = next_sleep > max_time ? sleep_time : sleep_time * BACKOFF_FACTOR
|
|
180
|
-
|
|
163
|
+
rescue Aws::SQS::Errors::ServiceError, Seahorse::Client::NetworkingError => e
|
|
164
|
+
@logger.warn("SQS error ... retrying with exponential backoff", exception_details(e, sleep_time))
|
|
165
|
+
sleep_time = backoff_sleep(sleep_time)
|
|
181
166
|
retry
|
|
182
167
|
end
|
|
183
168
|
end
|
|
184
169
|
|
|
170
|
+
def backoff_sleep(sleep_time)
|
|
171
|
+
sleep(sleep_time)
|
|
172
|
+
sleep_time > MAX_TIME_BEFORE_GIVING_UP ? sleep_time : sleep_time * BACKOFF_FACTOR
|
|
173
|
+
end
|
|
174
|
+
|
|
185
175
|
def convert_epoch_to_timestamp(time)
|
|
186
176
|
LogStash::Timestamp.at(time.to_i / 1000)
|
|
187
177
|
end
|
|
178
|
+
|
|
179
|
+
def exception_details(e, sleep_time = nil)
|
|
180
|
+
details = { :queue => @queue, :exception => e.class, :message => e.message }
|
|
181
|
+
details[:code] = e.code if e.is_a?(Aws::SQS::Errors::ServiceError) && e.code
|
|
182
|
+
details[:cause] = e.original_error if e.respond_to?(:original_error) && e.original_error # Seahorse::Client::NetworkingError
|
|
183
|
+
details[:sleep_time] = sleep_time if sleep_time
|
|
184
|
+
details[:backtrace] = e.backtrace if @logger.debug?
|
|
185
|
+
details
|
|
186
|
+
end
|
|
187
|
+
|
|
188
188
|
end # class LogStash::Inputs::SQS
|
data/logstash-input-sqs.gemspec
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
Gem::Specification.new do |s|
|
|
2
2
|
s.name = 'logstash-input-sqs'
|
|
3
|
-
s.version = '3.
|
|
3
|
+
s.version = '3.1.3'
|
|
4
4
|
s.licenses = ['Apache License (2.0)']
|
|
5
|
-
s.summary = "
|
|
5
|
+
s.summary = "Pulls events from an Amazon Web Services Simple Queue Service queue"
|
|
6
6
|
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"
|
|
7
7
|
s.authors = ["Elastic"]
|
|
8
8
|
s.email = 'info@elastic.co'
|
|
@@ -22,8 +22,9 @@ Gem::Specification.new do |s|
|
|
|
22
22
|
s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
|
|
23
23
|
|
|
24
24
|
s.add_runtime_dependency 'logstash-codec-json'
|
|
25
|
-
s.add_runtime_dependency
|
|
25
|
+
s.add_runtime_dependency 'logstash-mixin-aws', '>= 4.3.0'
|
|
26
26
|
|
|
27
27
|
s.add_development_dependency 'logstash-devutils'
|
|
28
|
+
s.add_development_dependency "logstash-codec-json_lines"
|
|
28
29
|
end
|
|
29
30
|
|
data/spec/inputs/sqs_spec.rb
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
# encoding: utf-8
|
|
2
2
|
require "spec_helper"
|
|
3
|
+
require "logstash/devutils/rspec/shared_examples"
|
|
3
4
|
require "logstash/inputs/sqs"
|
|
4
5
|
require "logstash/errors"
|
|
5
6
|
require "logstash/event"
|
|
@@ -138,7 +139,8 @@ describe LogStash::Inputs::SQS do
|
|
|
138
139
|
subject { LogStash::Inputs::SQS::new(config.merge({ "codec" => "json" })) }
|
|
139
140
|
|
|
140
141
|
it "uses the specified codec" do
|
|
141
|
-
|
|
142
|
+
subject.handle_message(encoded_message, queue)
|
|
143
|
+
expect(queue.pop.get("bonjour")).to eq(decoded_message["bonjour"])
|
|
142
144
|
end
|
|
143
145
|
end
|
|
144
146
|
|
|
@@ -152,6 +154,21 @@ describe LogStash::Inputs::SQS do
|
|
|
152
154
|
subject.run(queue)
|
|
153
155
|
expect(queue.pop.get("bonjour")).to eq(decoded_message["bonjour"])
|
|
154
156
|
end
|
|
157
|
+
|
|
158
|
+
context 'can create multiple events' do
|
|
159
|
+
require "logstash/codecs/json_lines"
|
|
160
|
+
let(:config) { super.merge({ "codec" => "json_lines" }) }
|
|
161
|
+
let(:first_message) { { "sequence" => "first" } }
|
|
162
|
+
let(:second_message) { { "sequence" => "second" } }
|
|
163
|
+
let(:encoded_message) { double("sqs_message", :body => "#{LogStash::Json::dump(first_message)}\n#{LogStash::Json::dump(second_message)}\n") }
|
|
164
|
+
|
|
165
|
+
it 'creates multiple events' do
|
|
166
|
+
expect(mock_sqs).to receive(:poll).with(anything()).and_yield([encoded_message], double("stats"))
|
|
167
|
+
subject.run(queue)
|
|
168
|
+
events = queue.map{ |e|e.get('sequence')}
|
|
169
|
+
expect(events).to match_array([first_message['sequence'], second_message['sequence']])
|
|
170
|
+
end
|
|
171
|
+
end
|
|
155
172
|
end
|
|
156
173
|
|
|
157
174
|
context "on errors" do
|
|
@@ -161,7 +178,7 @@ describe LogStash::Inputs::SQS do
|
|
|
161
178
|
expect(subject).to receive(:poller).and_return(mock_sqs).at_least(:once)
|
|
162
179
|
end
|
|
163
180
|
|
|
164
|
-
context "SQS
|
|
181
|
+
context "SQS error" do
|
|
165
182
|
it "retry to fetch messages" do
|
|
166
183
|
# change the poller implementation to raise SQS errors.
|
|
167
184
|
had_error = false
|
|
@@ -184,7 +201,63 @@ describe LogStash::Inputs::SQS do
|
|
|
184
201
|
end
|
|
185
202
|
end
|
|
186
203
|
|
|
187
|
-
context "
|
|
204
|
+
context "SQS error (retries)" do
|
|
205
|
+
|
|
206
|
+
it "retry to fetch messages" do
|
|
207
|
+
sleep_time = LogStash::Inputs::SQS::BACKOFF_SLEEP_TIME
|
|
208
|
+
expect(subject).to receive(:sleep).with(sleep_time)
|
|
209
|
+
expect(subject).to receive(:sleep).with(sleep_time * 2)
|
|
210
|
+
expect(subject).to receive(:sleep).with(sleep_time * 4)
|
|
211
|
+
|
|
212
|
+
error_count = 0
|
|
213
|
+
expect(mock_sqs).to receive(:poll).with(anything()).at_most(4) do
|
|
214
|
+
error_count += 1
|
|
215
|
+
if error_count <= 3
|
|
216
|
+
raise Aws::SQS::Errors::QueueDoesNotExist.new("testing", "testing exception (#{error_count})")
|
|
217
|
+
end
|
|
218
|
+
|
|
219
|
+
queue << payload
|
|
220
|
+
end
|
|
221
|
+
|
|
222
|
+
subject.run(queue)
|
|
223
|
+
|
|
224
|
+
expect(queue.size).to eq(1)
|
|
225
|
+
expect(queue.pop).to eq(payload)
|
|
226
|
+
end
|
|
227
|
+
|
|
228
|
+
end
|
|
229
|
+
|
|
230
|
+
context "networking error" do
|
|
231
|
+
|
|
232
|
+
before(:all) { require 'seahorse/client/networking_error' }
|
|
233
|
+
|
|
234
|
+
it "retry to fetch messages" do
|
|
235
|
+
sleep_time = LogStash::Inputs::SQS::BACKOFF_SLEEP_TIME
|
|
236
|
+
expect(subject).to receive(:sleep).with(sleep_time).twice
|
|
237
|
+
|
|
238
|
+
error_count = 0
|
|
239
|
+
expect(mock_sqs).to receive(:poll).with(anything()).at_most(5) do
|
|
240
|
+
error_count += 1
|
|
241
|
+
if error_count == 1
|
|
242
|
+
raise Seahorse::Client::NetworkingError.new(Net::OpenTimeout.new, 'timeout')
|
|
243
|
+
end
|
|
244
|
+
if error_count == 3
|
|
245
|
+
raise Seahorse::Client::NetworkingError.new(SocketError.new('spec-error'))
|
|
246
|
+
end
|
|
247
|
+
|
|
248
|
+
queue << payload
|
|
249
|
+
end
|
|
250
|
+
|
|
251
|
+
subject.run(queue)
|
|
252
|
+
subject.run(queue)
|
|
253
|
+
|
|
254
|
+
expect(queue.size).to eq(2)
|
|
255
|
+
expect(queue.pop).to eq(payload)
|
|
256
|
+
end
|
|
257
|
+
|
|
258
|
+
end
|
|
259
|
+
|
|
260
|
+
context "other error" do
|
|
188
261
|
it "stops executing the code and raise the exception" do
|
|
189
262
|
expect(mock_sqs).to receive(:poll).with(anything()).at_most(2) do
|
|
190
263
|
raise RuntimeError
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: logstash-input-sqs
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 3.
|
|
4
|
+
version: 3.1.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Elastic
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2020-11-19 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -49,7 +49,7 @@ dependencies:
|
|
|
49
49
|
requirements:
|
|
50
50
|
- - ">="
|
|
51
51
|
- !ruby/object:Gem::Version
|
|
52
|
-
version:
|
|
52
|
+
version: 4.3.0
|
|
53
53
|
name: logstash-mixin-aws
|
|
54
54
|
prerelease: false
|
|
55
55
|
type: :runtime
|
|
@@ -57,7 +57,7 @@ dependencies:
|
|
|
57
57
|
requirements:
|
|
58
58
|
- - ">="
|
|
59
59
|
- !ruby/object:Gem::Version
|
|
60
|
-
version:
|
|
60
|
+
version: 4.3.0
|
|
61
61
|
- !ruby/object:Gem::Dependency
|
|
62
62
|
requirement: !ruby/object:Gem::Requirement
|
|
63
63
|
requirements:
|
|
@@ -72,7 +72,23 @@ dependencies:
|
|
|
72
72
|
- - ">="
|
|
73
73
|
- !ruby/object:Gem::Version
|
|
74
74
|
version: '0'
|
|
75
|
-
|
|
75
|
+
- !ruby/object:Gem::Dependency
|
|
76
|
+
requirement: !ruby/object:Gem::Requirement
|
|
77
|
+
requirements:
|
|
78
|
+
- - ">="
|
|
79
|
+
- !ruby/object:Gem::Version
|
|
80
|
+
version: '0'
|
|
81
|
+
name: logstash-codec-json_lines
|
|
82
|
+
prerelease: false
|
|
83
|
+
type: :development
|
|
84
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
85
|
+
requirements:
|
|
86
|
+
- - ">="
|
|
87
|
+
- !ruby/object:Gem::Version
|
|
88
|
+
version: '0'
|
|
89
|
+
description: This gem is a Logstash plugin required to be installed on top of the
|
|
90
|
+
Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
|
|
91
|
+
gem is not a stand-alone program
|
|
76
92
|
email: info@elastic.co
|
|
77
93
|
executables: []
|
|
78
94
|
extensions: []
|
|
@@ -114,10 +130,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
114
130
|
version: '0'
|
|
115
131
|
requirements: []
|
|
116
132
|
rubyforge_project:
|
|
117
|
-
rubygems_version: 2.
|
|
133
|
+
rubygems_version: 2.6.13
|
|
118
134
|
signing_key:
|
|
119
135
|
specification_version: 4
|
|
120
|
-
summary:
|
|
136
|
+
summary: Pulls events from an Amazon Web Services Simple Queue Service queue
|
|
121
137
|
test_files:
|
|
122
138
|
- spec/inputs/sqs_spec.rb
|
|
123
139
|
- spec/integration/sqs_spec.rb
|