logstash-input-sqs 3.1.1 → 3.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +12 -0
- data/Gemfile +4 -0
- data/LICENSE +199 -10
- data/README.md +1 -1
- data/docs/index.asciidoc +34 -2
- data/lib/logstash/inputs/sqs.rb +67 -35
- data/logstash-input-sqs.gemspec +3 -2
- data/spec/inputs/sqs_spec.rb +130 -3
- metadata +18 -5
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: bbca33a52d6cff51cbe851d9cba61a874804d15dc8675866936740586478751f
|
|
4
|
+
data.tar.gz: '08c907ba377fa84416e7ae49f161b39909fd361cc710f4ebdd51ae97bd94e852'
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 7fd07bb9d70f3a564a878fb42ba8a17421ea5718890ce1b125958280d5d0f2ce7943b7285d7edcec778fdbe0b421e010e5783d8e3aae3617fee0a7d3a0762db7
|
|
7
|
+
data.tar.gz: '087aff018b51eb2f7eaa233dc730ee817719aa89d4b877fff7b0557a189fe6ca48006a3b753efcac35712d1dbf442881dfb7c33127ee6b031393b8f12f3c58c0'
|
data/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,15 @@
|
|
|
1
|
+
## 3.3.0
|
|
2
|
+
- Feature: Add `additional_settings` option to fine-grain configuration of AWS client [#61](https://github.com/logstash-plugins/logstash-input-sqs/pull/61)
|
|
3
|
+
|
|
4
|
+
## 3.2.0
|
|
5
|
+
- Feature: Add `queue_owner_aws_account_id` parameter for cross-account queues [#60](https://github.com/logstash-plugins/logstash-input-sqs/pull/60)
|
|
6
|
+
|
|
7
|
+
## 3.1.3
|
|
8
|
+
- Fix: retry networking errors (with backoff) [#57](https://github.com/logstash-plugins/logstash-input-sqs/pull/57)
|
|
9
|
+
|
|
10
|
+
## 3.1.2
|
|
11
|
+
- Added support for multiple events inside same message from SQS [#48](https://github.com/logstash-plugins/logstash-input-sqs/pull/48/files)
|
|
12
|
+
|
|
1
13
|
## 3.1.1
|
|
2
14
|
- Docs: Set the default_codec doc attribute.
|
|
3
15
|
|
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-2018 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/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Logstash Plugin
|
|
2
2
|
|
|
3
|
-
[](https://travis-ci.com/logstash-plugins/logstash-input-sqs)
|
|
4
4
|
|
|
5
5
|
This is a plugin for [Logstash](https://github.com/elastic/logstash).
|
|
6
6
|
|
data/docs/index.asciidoc
CHANGED
|
@@ -36,7 +36,7 @@ To use this plugin, you *must*:
|
|
|
36
36
|
|
|
37
37
|
* Have an AWS account
|
|
38
38
|
* Setup an SQS queue
|
|
39
|
-
* Create an
|
|
39
|
+
* Create an identity that has access to consume messages from the queue.
|
|
40
40
|
|
|
41
41
|
The "consumer" identity must have the following permissions on the queue:
|
|
42
42
|
|
|
@@ -85,6 +85,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
|
|
|
85
85
|
|=======================================================================
|
|
86
86
|
|Setting |Input type|Required
|
|
87
87
|
| <<plugins-{type}s-{plugin}-access_key_id>> |<<string,string>>|No
|
|
88
|
+
| <<plugins-{type}s-{plugin}-additional_settings>> |<<hash,hash>>|No
|
|
88
89
|
| <<plugins-{type}s-{plugin}-aws_credentials_file>> |<<string,string>>|No
|
|
89
90
|
| <<plugins-{type}s-{plugin}-endpoint>> |<<string,string>>|No
|
|
90
91
|
| <<plugins-{type}s-{plugin}-id_field>> |<<string,string>>|No
|
|
@@ -92,6 +93,7 @@ This plugin supports the following configuration options plus the <<plugins-{typ
|
|
|
92
93
|
| <<plugins-{type}s-{plugin}-polling_frequency>> |<<number,number>>|No
|
|
93
94
|
| <<plugins-{type}s-{plugin}-proxy_uri>> |<<string,string>>|No
|
|
94
95
|
| <<plugins-{type}s-{plugin}-queue>> |<<string,string>>|Yes
|
|
96
|
+
| <<plugins-{type}s-{plugin}-queue_owner_aws_account_id>> |<<string,string>>|No
|
|
95
97
|
| <<plugins-{type}s-{plugin}-region>> |<<string,string>>|No
|
|
96
98
|
| <<plugins-{type}s-{plugin}-role_arn>> |<<string,string>>|No
|
|
97
99
|
| <<plugins-{type}s-{plugin}-role_session_name>> |<<string,string>>|No
|
|
@@ -120,6 +122,28 @@ This plugin uses the AWS SDK and supports several ways to get credentials, which
|
|
|
120
122
|
4. Environment variables `AMAZON_ACCESS_KEY_ID` and `AMAZON_SECRET_ACCESS_KEY`
|
|
121
123
|
5. IAM Instance Profile (available when running inside EC2)
|
|
122
124
|
|
|
125
|
+
[id="plugins-{type}s-{plugin}-additional_settings"]
|
|
126
|
+
===== `additional_settings`
|
|
127
|
+
|
|
128
|
+
* Value type is <<hash,hash>>
|
|
129
|
+
* Default value is `{}`
|
|
130
|
+
|
|
131
|
+
Key-value pairs of settings and corresponding values used to parametrize
|
|
132
|
+
the connection to SQS. See full list in https://docs.aws.amazon.com/sdk-for-ruby/v2/api/Aws/SQS/Client.html[the AWS SDK documentation]. Example:
|
|
133
|
+
|
|
134
|
+
[source,ruby]
|
|
135
|
+
input {
|
|
136
|
+
sqs {
|
|
137
|
+
access_key_id => "1234"
|
|
138
|
+
secret_access_key => "secret"
|
|
139
|
+
queue => "logstash-test-queue"
|
|
140
|
+
additional_settings => {
|
|
141
|
+
force_path_style => true
|
|
142
|
+
follow_redirects => false
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
|
|
123
147
|
[id="plugins-{type}s-{plugin}-aws_credentials_file"]
|
|
124
148
|
===== `aws_credentials_file`
|
|
125
149
|
|
|
@@ -188,6 +212,14 @@ URI to proxy server if required
|
|
|
188
212
|
|
|
189
213
|
Name of the SQS Queue name to pull messages from. Note that this is just the name of the queue, not the URL or ARN.
|
|
190
214
|
|
|
215
|
+
[id="plugins-{type}s-{plugin}-queue_owner_aws_account_id"]
|
|
216
|
+
===== `queue_owner_aws_account_id`
|
|
217
|
+
|
|
218
|
+
* Value type is <<string,string>>
|
|
219
|
+
* There is no default value for this setting.
|
|
220
|
+
|
|
221
|
+
ID of the AWS account owning the queue if you want to use a https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-basic-examples-of-sqs-policies.html#grant-two-permissions-to-one-account[cross-account queue] with embedded policy. Note that AWS SDK only support numerical account ID and not account aliases.
|
|
222
|
+
|
|
191
223
|
[id="plugins-{type}s-{plugin}-region"]
|
|
192
224
|
===== `region`
|
|
193
225
|
|
|
@@ -251,4 +283,4 @@ The AWS Session token for temporary credential
|
|
|
251
283
|
[id="plugins-{type}s-{plugin}-common-options"]
|
|
252
284
|
include::{include_path}/{type}.asciidoc[]
|
|
253
285
|
|
|
254
|
-
:default_codec!:
|
|
286
|
+
:default_codec!:
|
data/lib/logstash/inputs/sqs.rb
CHANGED
|
@@ -80,9 +80,14 @@ class LogStash::Inputs::SQS < LogStash::Inputs::Threadable
|
|
|
80
80
|
|
|
81
81
|
default :codec, "json"
|
|
82
82
|
|
|
83
|
+
config :additional_settings, :validate => :hash, :default => {}
|
|
84
|
+
|
|
83
85
|
# Name of the SQS Queue name to pull messages from. Note that this is just the name of the queue, not the URL or ARN.
|
|
84
86
|
config :queue, :validate => :string, :required => true
|
|
85
87
|
|
|
88
|
+
# Account ID of the AWS account which owns the queue.
|
|
89
|
+
config :queue_owner_aws_account_id, :validate => :string, :required => false
|
|
90
|
+
|
|
86
91
|
# Name of the event field in which to store the SQS message ID
|
|
87
92
|
config :id_field, :validate => :string
|
|
88
93
|
|
|
@@ -99,17 +104,25 @@ class LogStash::Inputs::SQS < LogStash::Inputs::Threadable
|
|
|
99
104
|
|
|
100
105
|
def register
|
|
101
106
|
require "aws-sdk"
|
|
102
|
-
@logger.info("Registering SQS input", :queue => @queue)
|
|
107
|
+
@logger.info("Registering SQS input", :queue => @queue, :queue_owner_aws_account_id => @queue_owner_aws_account_id)
|
|
103
108
|
|
|
104
109
|
setup_queue
|
|
105
110
|
end
|
|
106
111
|
|
|
112
|
+
def queue_url(aws_sqs_client)
|
|
113
|
+
if @queue_owner_aws_account_id
|
|
114
|
+
return aws_sqs_client.get_queue_url({:queue_name => @queue, :queue_owner_aws_account_id => @queue_owner_aws_account_id})[:queue_url]
|
|
115
|
+
else
|
|
116
|
+
return aws_sqs_client.get_queue_url(:queue_name => @queue)[:queue_url]
|
|
117
|
+
end
|
|
118
|
+
end
|
|
119
|
+
|
|
107
120
|
def setup_queue
|
|
108
|
-
|
|
109
|
-
|
|
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",
|
|
121
|
+
options = symbolized_settings.merge(aws_options_hash || {})
|
|
122
|
+
aws_sqs_client = Aws::SQS::Client.new(options)
|
|
123
|
+
@poller = Aws::SQS::QueuePoller.new(queue_url(aws_sqs_client), :client => aws_sqs_client)
|
|
124
|
+
rescue Aws::SQS::Errors::ServiceError, Seahorse::Client::NetworkingError => e
|
|
125
|
+
@logger.error("Cannot establish connection to Amazon SQS", exception_details(e))
|
|
113
126
|
raise LogStash::ConfigurationError, "Verify the SQS queue name and your credentials"
|
|
114
127
|
end
|
|
115
128
|
|
|
@@ -121,25 +134,19 @@ class LogStash::Inputs::SQS < LogStash::Inputs::Threadable
|
|
|
121
134
|
}
|
|
122
135
|
end
|
|
123
136
|
|
|
124
|
-
def decode_event(message)
|
|
125
|
-
@codec.decode(message.body) do |event|
|
|
126
|
-
return event
|
|
127
|
-
end
|
|
128
|
-
end
|
|
129
|
-
|
|
130
137
|
def add_sqs_data(event, message)
|
|
131
138
|
event.set(@id_field, message.message_id) if @id_field
|
|
132
139
|
event.set(@md5_field, message.md5_of_body) if @md5_field
|
|
133
140
|
event.set(@sent_timestamp_field, convert_epoch_to_timestamp(message.attributes[SENT_TIMESTAMP])) if @sent_timestamp_field
|
|
134
|
-
|
|
135
|
-
return event
|
|
141
|
+
event
|
|
136
142
|
end
|
|
137
143
|
|
|
138
|
-
def handle_message(message)
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
144
|
+
def handle_message(message, output_queue)
|
|
145
|
+
@codec.decode(message.body) do |event|
|
|
146
|
+
add_sqs_data(event, message)
|
|
147
|
+
decorate(event)
|
|
148
|
+
output_queue << event
|
|
149
|
+
end
|
|
143
150
|
end
|
|
144
151
|
|
|
145
152
|
def run(output_queue)
|
|
@@ -148,11 +155,7 @@ class LogStash::Inputs::SQS < LogStash::Inputs::Threadable
|
|
|
148
155
|
run_with_backoff do
|
|
149
156
|
poller.poll(polling_options) do |messages, stats|
|
|
150
157
|
break if stop?
|
|
151
|
-
|
|
152
|
-
messages.each do |message|
|
|
153
|
-
output_queue << handle_message(message)
|
|
154
|
-
end
|
|
155
|
-
|
|
158
|
+
messages.each {|message| handle_message(message, output_queue) }
|
|
156
159
|
@logger.debug("SQS Stats:", :request_count => stats.request_count,
|
|
157
160
|
:received_message_count => stats.received_message_count,
|
|
158
161
|
:last_message_received_at => stats.last_message_received_at) if @logger.debug?
|
|
@@ -161,28 +164,57 @@ class LogStash::Inputs::SQS < LogStash::Inputs::Threadable
|
|
|
161
164
|
end
|
|
162
165
|
|
|
163
166
|
private
|
|
167
|
+
|
|
164
168
|
# Runs an AWS request inside a Ruby block with an exponential backoff in case
|
|
165
169
|
# we experience a ServiceError.
|
|
166
170
|
#
|
|
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
171
|
# @param [Block] block Ruby code block to execute.
|
|
170
|
-
def run_with_backoff(
|
|
171
|
-
|
|
172
|
-
|
|
172
|
+
def run_with_backoff(&block)
|
|
173
|
+
sleep_time = BACKOFF_SLEEP_TIME
|
|
173
174
|
begin
|
|
174
175
|
block.call
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
sleep(next_sleep)
|
|
179
|
-
next_sleep = next_sleep > max_time ? sleep_time : sleep_time * BACKOFF_FACTOR
|
|
180
|
-
|
|
176
|
+
rescue Aws::SQS::Errors::ServiceError, Seahorse::Client::NetworkingError => e
|
|
177
|
+
@logger.warn("SQS error ... retrying with exponential backoff", exception_details(e, sleep_time))
|
|
178
|
+
sleep_time = backoff_sleep(sleep_time)
|
|
181
179
|
retry
|
|
182
180
|
end
|
|
183
181
|
end
|
|
184
182
|
|
|
183
|
+
def backoff_sleep(sleep_time)
|
|
184
|
+
sleep(sleep_time)
|
|
185
|
+
sleep_time > MAX_TIME_BEFORE_GIVING_UP ? sleep_time : sleep_time * BACKOFF_FACTOR
|
|
186
|
+
end
|
|
187
|
+
|
|
185
188
|
def convert_epoch_to_timestamp(time)
|
|
186
189
|
LogStash::Timestamp.at(time.to_i / 1000)
|
|
187
190
|
end
|
|
191
|
+
|
|
192
|
+
def exception_details(e, sleep_time = nil)
|
|
193
|
+
details = { :queue => @queue, :exception => e.class, :message => e.message }
|
|
194
|
+
details[:code] = e.code if e.is_a?(Aws::SQS::Errors::ServiceError) && e.code
|
|
195
|
+
details[:cause] = e.original_error if e.respond_to?(:original_error) && e.original_error # Seahorse::Client::NetworkingError
|
|
196
|
+
details[:sleep_time] = sleep_time if sleep_time
|
|
197
|
+
details[:backtrace] = e.backtrace if @logger.debug?
|
|
198
|
+
details
|
|
199
|
+
end
|
|
200
|
+
|
|
201
|
+
def symbolized_settings
|
|
202
|
+
@symbolized_settings ||= symbolize_keys_and_cast_true_false(@additional_settings)
|
|
203
|
+
end
|
|
204
|
+
|
|
205
|
+
def symbolize_keys_and_cast_true_false(hash)
|
|
206
|
+
case hash
|
|
207
|
+
when Hash
|
|
208
|
+
symbolized = {}
|
|
209
|
+
hash.each { |key, value| symbolized[key.to_sym] = symbolize_keys_and_cast_true_false(value) }
|
|
210
|
+
symbolized
|
|
211
|
+
when 'true'
|
|
212
|
+
true
|
|
213
|
+
when 'false'
|
|
214
|
+
false
|
|
215
|
+
else
|
|
216
|
+
hash
|
|
217
|
+
end
|
|
218
|
+
end
|
|
219
|
+
|
|
188
220
|
end # class LogStash::Inputs::SQS
|
data/logstash-input-sqs.gemspec
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
Gem::Specification.new do |s|
|
|
2
2
|
s.name = 'logstash-input-sqs'
|
|
3
|
-
s.version = '3.
|
|
4
|
-
s.licenses = ['Apache
|
|
3
|
+
s.version = '3.3.0'
|
|
4
|
+
s.licenses = ['Apache-2.0']
|
|
5
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"]
|
|
@@ -25,5 +25,6 @@ Gem::Specification.new do |s|
|
|
|
25
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"
|
|
@@ -48,6 +49,60 @@ describe LogStash::Inputs::SQS do
|
|
|
48
49
|
expect { subject.register }.not_to raise_error
|
|
49
50
|
end
|
|
50
51
|
|
|
52
|
+
context "when queue_aws_account_id option is specified" do
|
|
53
|
+
let(:queue_account_id) { "123456789012" }
|
|
54
|
+
let(:config) do
|
|
55
|
+
{
|
|
56
|
+
"region" => "us-east-1",
|
|
57
|
+
"access_key_id" => "123",
|
|
58
|
+
"secret_access_key" => "secret",
|
|
59
|
+
"queue" => queue_name,
|
|
60
|
+
"queue_owner_aws_account_id" => queue_account_id
|
|
61
|
+
}
|
|
62
|
+
end
|
|
63
|
+
it "passes the option to sqs client" do
|
|
64
|
+
expect(Aws::SQS::Client).to receive(:new).and_return(mock_sqs)
|
|
65
|
+
expect(mock_sqs).to receive(:get_queue_url).with({ :queue_name => queue_name, :queue_owner_aws_account_id => queue_account_id }).and_return({:queue_url => queue_url })
|
|
66
|
+
expect { subject.register }.not_to raise_error
|
|
67
|
+
end
|
|
68
|
+
end
|
|
69
|
+
|
|
70
|
+
describe "additional_settings" do
|
|
71
|
+
context "supported settings" do
|
|
72
|
+
let(:config) {
|
|
73
|
+
{
|
|
74
|
+
"additional_settings" => { "force_path_style" => 'true', "ssl_verify_peer" => 'false', "profile" => 'logstash' },
|
|
75
|
+
"queue" => queue_name
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
it 'should instantiate Aws::SQS clients with force_path_style set' do
|
|
80
|
+
expect(Aws::SQS::Client).to receive(:new).and_return(mock_sqs)
|
|
81
|
+
# mock a remote call to retrieve the queue URL
|
|
82
|
+
expect(mock_sqs).to receive(:get_queue_url).with({ :queue_name => queue_name }).and_return({:queue_url => queue_url })
|
|
83
|
+
expect(subject).to receive(:symbolized_settings) do |arg|
|
|
84
|
+
expect(arg).to include({:force_path_style => true, :ssl_verify_peer => false, :profile => 'logstash'})
|
|
85
|
+
end.and_call_original
|
|
86
|
+
|
|
87
|
+
expect { subject.register }.not_to raise_error
|
|
88
|
+
end
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
context "unsupported settings" do
|
|
92
|
+
let(:config) {
|
|
93
|
+
{
|
|
94
|
+
"additional_settings" => { "stub_responses" => 'true', "invalid_option" => "invalid" },
|
|
95
|
+
"queue" => queue_name
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
it 'must fail with ArgumentError' do
|
|
100
|
+
expect {subject.register}.to raise_error(ArgumentError, /invalid_option/)
|
|
101
|
+
end
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
end
|
|
105
|
+
|
|
51
106
|
context "when interrupting the plugin" do
|
|
52
107
|
before do
|
|
53
108
|
expect(Aws::SQS::Client).to receive(:new).and_return(mock_sqs)
|
|
@@ -138,7 +193,8 @@ describe LogStash::Inputs::SQS do
|
|
|
138
193
|
subject { LogStash::Inputs::SQS::new(config.merge({ "codec" => "json" })) }
|
|
139
194
|
|
|
140
195
|
it "uses the specified codec" do
|
|
141
|
-
|
|
196
|
+
subject.handle_message(encoded_message, queue)
|
|
197
|
+
expect(queue.pop.get("bonjour")).to eq(decoded_message["bonjour"])
|
|
142
198
|
end
|
|
143
199
|
end
|
|
144
200
|
|
|
@@ -152,6 +208,21 @@ describe LogStash::Inputs::SQS do
|
|
|
152
208
|
subject.run(queue)
|
|
153
209
|
expect(queue.pop.get("bonjour")).to eq(decoded_message["bonjour"])
|
|
154
210
|
end
|
|
211
|
+
|
|
212
|
+
context 'can create multiple events' do
|
|
213
|
+
require "logstash/codecs/json_lines"
|
|
214
|
+
let(:config) { super().merge({ "codec" => "json_lines" }) }
|
|
215
|
+
let(:first_message) { { "sequence" => "first" } }
|
|
216
|
+
let(:second_message) { { "sequence" => "second" } }
|
|
217
|
+
let(:encoded_message) { double("sqs_message", :body => "#{LogStash::Json::dump(first_message)}\n#{LogStash::Json::dump(second_message)}\n") }
|
|
218
|
+
|
|
219
|
+
it 'creates multiple events' do
|
|
220
|
+
expect(mock_sqs).to receive(:poll).with(anything()).and_yield([encoded_message], double("stats"))
|
|
221
|
+
subject.run(queue)
|
|
222
|
+
events = queue.map{ |e|e.get('sequence')}
|
|
223
|
+
expect(events).to match_array([first_message['sequence'], second_message['sequence']])
|
|
224
|
+
end
|
|
225
|
+
end
|
|
155
226
|
end
|
|
156
227
|
|
|
157
228
|
context "on errors" do
|
|
@@ -161,7 +232,7 @@ describe LogStash::Inputs::SQS do
|
|
|
161
232
|
expect(subject).to receive(:poller).and_return(mock_sqs).at_least(:once)
|
|
162
233
|
end
|
|
163
234
|
|
|
164
|
-
context "SQS
|
|
235
|
+
context "SQS error" do
|
|
165
236
|
it "retry to fetch messages" do
|
|
166
237
|
# change the poller implementation to raise SQS errors.
|
|
167
238
|
had_error = false
|
|
@@ -184,7 +255,63 @@ describe LogStash::Inputs::SQS do
|
|
|
184
255
|
end
|
|
185
256
|
end
|
|
186
257
|
|
|
187
|
-
context "
|
|
258
|
+
context "SQS error (retries)" do
|
|
259
|
+
|
|
260
|
+
it "retry to fetch messages" do
|
|
261
|
+
sleep_time = LogStash::Inputs::SQS::BACKOFF_SLEEP_TIME
|
|
262
|
+
expect(subject).to receive(:sleep).with(sleep_time)
|
|
263
|
+
expect(subject).to receive(:sleep).with(sleep_time * 2)
|
|
264
|
+
expect(subject).to receive(:sleep).with(sleep_time * 4)
|
|
265
|
+
|
|
266
|
+
error_count = 0
|
|
267
|
+
expect(mock_sqs).to receive(:poll).with(anything()).at_most(4) do
|
|
268
|
+
error_count += 1
|
|
269
|
+
if error_count <= 3
|
|
270
|
+
raise Aws::SQS::Errors::QueueDoesNotExist.new("testing", "testing exception (#{error_count})")
|
|
271
|
+
end
|
|
272
|
+
|
|
273
|
+
queue << payload
|
|
274
|
+
end
|
|
275
|
+
|
|
276
|
+
subject.run(queue)
|
|
277
|
+
|
|
278
|
+
expect(queue.size).to eq(1)
|
|
279
|
+
expect(queue.pop).to eq(payload)
|
|
280
|
+
end
|
|
281
|
+
|
|
282
|
+
end
|
|
283
|
+
|
|
284
|
+
context "networking error" do
|
|
285
|
+
|
|
286
|
+
before(:all) { require 'seahorse/client/networking_error' }
|
|
287
|
+
|
|
288
|
+
it "retry to fetch messages" do
|
|
289
|
+
sleep_time = LogStash::Inputs::SQS::BACKOFF_SLEEP_TIME
|
|
290
|
+
expect(subject).to receive(:sleep).with(sleep_time).twice
|
|
291
|
+
|
|
292
|
+
error_count = 0
|
|
293
|
+
expect(mock_sqs).to receive(:poll).with(anything()).at_most(5) do
|
|
294
|
+
error_count += 1
|
|
295
|
+
if error_count == 1
|
|
296
|
+
raise Seahorse::Client::NetworkingError.new(Net::OpenTimeout.new, 'timeout')
|
|
297
|
+
end
|
|
298
|
+
if error_count == 3
|
|
299
|
+
raise Seahorse::Client::NetworkingError.new(SocketError.new('spec-error'))
|
|
300
|
+
end
|
|
301
|
+
|
|
302
|
+
queue << payload
|
|
303
|
+
end
|
|
304
|
+
|
|
305
|
+
subject.run(queue)
|
|
306
|
+
subject.run(queue)
|
|
307
|
+
|
|
308
|
+
expect(queue.size).to eq(2)
|
|
309
|
+
expect(queue.pop).to eq(payload)
|
|
310
|
+
end
|
|
311
|
+
|
|
312
|
+
end
|
|
313
|
+
|
|
314
|
+
context "other error" do
|
|
188
315
|
it "stops executing the code and raise the exception" do
|
|
189
316
|
expect(mock_sqs).to receive(:poll).with(anything()).at_most(2) do
|
|
190
317
|
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.3.0
|
|
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: 2022-02-14 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -72,6 +72,20 @@ dependencies:
|
|
|
72
72
|
- - ">="
|
|
73
73
|
- !ruby/object:Gem::Version
|
|
74
74
|
version: '0'
|
|
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'
|
|
75
89
|
description: This gem is a Logstash plugin required to be installed on top of the
|
|
76
90
|
Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This
|
|
77
91
|
gem is not a stand-alone program
|
|
@@ -96,7 +110,7 @@ files:
|
|
|
96
110
|
- spec/support/helpers.rb
|
|
97
111
|
homepage: http://www.elastic.co/guide/en/logstash/current/index.html
|
|
98
112
|
licenses:
|
|
99
|
-
- Apache
|
|
113
|
+
- Apache-2.0
|
|
100
114
|
metadata:
|
|
101
115
|
logstash_plugin: 'true'
|
|
102
116
|
logstash_group: input
|
|
@@ -115,8 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
115
129
|
- !ruby/object:Gem::Version
|
|
116
130
|
version: '0'
|
|
117
131
|
requirements: []
|
|
118
|
-
|
|
119
|
-
rubygems_version: 2.6.11
|
|
132
|
+
rubygems_version: 3.1.6
|
|
120
133
|
signing_key:
|
|
121
134
|
specification_version: 4
|
|
122
135
|
summary: Pulls events from an Amazon Web Services Simple Queue Service queue
|