logstash-output-s3 4.1.9 → 4.3.2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7653884bdf554ea5da088fff8ccedf6e4371d55bab768276f887043fc1951d61
4
- data.tar.gz: b972c14f15fef7b7b088db17d521c1255832280b005e35060948ee27c98b0b2e
3
+ metadata.gz: 949b68aa82c6d619d3f9d6d75615db87f50cc3529169a5980f63ec4592a672af
4
+ data.tar.gz: 43b9bd9c245b19a2bc5e116294770bddd896c012cc3b24085623e3c44f634dcb
5
5
  SHA512:
6
- metadata.gz: de5e04e1f51a90c62b14992a4aba4fc2f05ba7be30ea697bbd21747a376d13a5dd9a4e6dc773cc727f773f16541ba35a58fb3ab1147e37e0e757cdb8487eef13
7
- data.tar.gz: 77e29b0995184da283de1ea27122ab6ac343e22a337a35c617cbd1005657c44ef00616a7687672f543e799f89911ecf03a651d8184d5988ea7fa2d1680686b2f
6
+ metadata.gz: 9c69eec68547b76c7fea7a668178a19319d09978ecef913f64be1c936e9c9f246f9194381128db9ca28779192abdf209211531a94bda53f0bd84affb7ac71318
7
+ data.tar.gz: 27bec629b16aaa8d6503b0b9931ec0170c35afb4f028118557665f4d554d0535e3448aac7c55860d3d70ec7f0eedef662612d8616e894326b2240ddbfbb7d45e
@@ -1,3 +1,18 @@
1
+ ## 4.3.2
2
+ - [DOC]Added note that only AWS S3 is supported. No other S3 compatible storage solutions are supported. [#223](https://github.com/logstash-plugins/logstash-output-s3/pull/223)
3
+
4
+ ## 4.3.1
5
+ - [DOC] Updated setting descriptions for clarity [#219](https://github.com/logstash-plugins/logstash-output-s3/pull/219) and [#220](https://github.com/logstash-plugins/logstash-output-s3/pull/220)
6
+
7
+ ## 4.3.0
8
+ - Feat: Added retry_count and retry_delay config [#218](https://github.com/logstash-plugins/logstash-output-s3/pull/218)
9
+
10
+ ## 4.2.0
11
+ - Added ability to specify [ONEZONE_IA](https://aws.amazon.com/s3/storage-classes/#__) as storage_class
12
+
13
+ ## 4.1.10
14
+ - Added clarification for endpoint in documentation [#198](https://github.com/logstash-plugins/logstash-output-s3/pull/198)
15
+
1
16
  ## 4.1.9
2
17
  - Added configuration information for multiple s3 outputs to documentation [#196](https://github.com/logstash-plugins/logstash-output-s3/pull/196)
3
18
  - Fixed formatting problems and typographical errors [#194](https://github.com/logstash-plugins/logstash-output-s3/pull/194), [#201](https://github.com/logstash-plugins/logstash-output-s3/pull/201), and [#204](https://github.com/logstash-plugins/logstash-output-s3/pull/204)
data/LICENSE CHANGED
@@ -1,13 +1,202 @@
1
- Copyright (c) 2012-2018 Elasticsearch <http://www.elastic.co>
2
1
 
3
- Licensed under the Apache License, Version 2.0 (the "License");
4
- you may not use this file except in compliance with the License.
5
- You may obtain a copy of the License at
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
6
5
 
7
- http://www.apache.org/licenses/LICENSE-2.0
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
7
 
9
- Unless required by applicable law or agreed to in writing, software
10
- distributed under the License is distributed on an "AS IS" BASIS,
11
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- See the License for the specific language governing permissions and
13
- limitations under the License.
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.
@@ -21,7 +21,11 @@ include::{include_path}/plugin_header.asciidoc[]
21
21
 
22
22
  ==== Description
23
23
 
24
- This plugin batches and uploads logstash events into Amazon Simple Storage Service (Amazon S3).
24
+ This plugin batches and uploads logstash events into Amazon Simple Storage
25
+ Service (Amazon S3).
26
+
27
+ IMPORTANT: The S3 output plugin only supports AWS S3.
28
+ Other S3 compatible storage solutions are not supported.
25
29
 
26
30
  S3 outputs create temporary files into the OS' temporary directory.
27
31
  You can specify where to save them using the `temporary_directory` option.
@@ -90,6 +94,8 @@ This plugin supports the following configuration options plus the <
90
94
  | <<plugins-{type}s-{plugin}-proxy_uri>> |<<string,string>>|No
91
95
  | <<plugins-{type}s-{plugin}-region>> |<<string,string>>|No
92
96
  | <<plugins-{type}s-{plugin}-restore>> |<<boolean,boolean>>|No
97
+ | <<plugins-{type}s-{plugin}-retry_count>> |<<number,number>>|No
98
+ | <<plugins-{type}s-{plugin}-retry_delay>> |<<number,number>>|No
93
99
  | <<plugins-{type}s-{plugin}-role_arn>> |<<string,string>>|No
94
100
  | <<plugins-{type}s-{plugin}-role_session_name>> |<<string,string>>|No
95
101
  | <<plugins-{type}s-{plugin}-rotation_strategy>> |<<string,string>>, one of `["size_and_time", "size", "time"]`|No
@@ -100,7 +106,7 @@ This plugin supports the following configuration options plus the <
100
106
  | <<plugins-{type}s-{plugin}-signature_version>> |<<string,string>>, one of `["v2", "v4"]`|No
101
107
  | <<plugins-{type}s-{plugin}-size_file>> |<<number,number>>|No
102
108
  | <<plugins-{type}s-{plugin}-ssekms_key_id>> |<<string,string>>|No
103
- | <<plugins-{type}s-{plugin}-storage_class>> |<<string,string>>, one of `["STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA"]`|No
109
+ | <<plugins-{type}s-{plugin}-storage_class>> |<<string,string>>, one of `["STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA"]`|No
104
110
  | <<plugins-{type}s-{plugin}-temporary_directory>> |<<string,string>>|No
105
111
  | <<plugins-{type}s-{plugin}-time_file>> |<<number,number>>|No
106
112
  | <<plugins-{type}s-{plugin}-upload_multipart_threshold>> |<<number,number>>|No
@@ -203,6 +209,7 @@ Specify the content encoding. Supports ("gzip"). Defaults to "none"
203
209
  The endpoint to connect to. By default it is constructed using the value of `region`.
204
210
  This is useful when connecting to S3 compatible services, but beware that these aren't
205
211
  guaranteed to work correctly with the AWS SDK.
212
+ The endpoint should be an HTTP or HTTPS URL, e.g. https://example.com
206
213
 
207
214
  [id="plugins-{type}s-{plugin}-prefix"]
208
215
  ===== `prefix`
@@ -240,6 +247,22 @@ The AWS Region
240
247
  Used to enable recovery after crash/abnormal termination.
241
248
  Temporary log files will be recovered and uploaded.
242
249
 
250
+ [id="plugins-{type}s-{plugin}-retry_count"]
251
+ ===== `retry_count`
252
+
253
+ * Value type is <<number,number>>
254
+ * Default value is `Infinity`
255
+
256
+ Allows to limit number of retries when S3 uploading fails.
257
+
258
+ [id="plugins-{type}s-{plugin}-retry_delay"]
259
+ ===== `retry_delay`
260
+
261
+ * Value type is <<number,number>>
262
+ * Default value is `1`
263
+
264
+ Delay (in seconds) to wait between consecutive retries on upload failures.
265
+
243
266
  [id="plugins-{type}s-{plugin}-role_arn"]
244
267
  ===== `role_arn`
245
268
 
@@ -264,8 +287,19 @@ Session name to use when assuming an IAM role.
264
287
  * Value can be any of: `size_and_time`, `size`, `time`
265
288
  * Default value is `"size_and_time"`
266
289
 
267
- Define the strategy to use to decide when we need to rotate the file and push it to S3,
268
- The default strategy is to check for both size and time, the first one to match will rotate the file.
290
+ Controls when to close the file and push it to S3.
291
+
292
+ If you set this value to `size`, it uses the value set in
293
+ <<plugins-{type}s-{plugin}-size_file,`size_file`>>.
294
+ If you set this value to `time`, it uses the value set in
295
+ <<plugins-{type}s-{plugin}-time_file,`time_file`>>.
296
+ If you set this value to `size_and_time`, it uses the values from
297
+ <<plugins-{type}s-{plugin}-size_file,`size_file`>> and
298
+ <<plugins-{type}s-{plugin}-time_file,`time_file`>>, and splits the file when
299
+ either one matches.
300
+
301
+ The default strategy checks both size and time. The first value to
302
+ match triggers file rotation.
269
303
 
270
304
  [id="plugins-{type}s-{plugin}-secret_access_key"]
271
305
  ===== `secret_access_key`
@@ -314,8 +348,9 @@ specified here
314
348
  * Value type is <<number,number>>
315
349
  * Default value is `5242880`
316
350
 
317
- Set the size of file in bytes, this means that files on bucket when have dimension > file_size, they are stored in two or more file.
318
- If you have tags then it will generate a specific size file for every tags
351
+ Set the file size in bytes. When the number of bytes exceeds the `size_file`
352
+ value, a new file is created. If you use tags, Logstash generates a specific size
353
+ file for every tag.
319
354
 
320
355
  [id="plugins-{type}s-{plugin}-ssekms_key_id"]
321
356
  ===== `ssekms_key_id`
@@ -330,7 +365,7 @@ http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html
330
365
  [id="plugins-{type}s-{plugin}-storage_class"]
331
366
  ===== `storage_class`
332
367
 
333
- * Value can be any of: `STANDARD`, `REDUCED_REDUNDANCY`, `STANDARD_IA`
368
+ * Value can be any of: `STANDARD`, `REDUCED_REDUNDANCY`, `STANDARD_IA`, `ONEZONE_IA`
334
369
  * Default value is `"STANDARD"`
335
370
 
336
371
  Specifies what S3 storage class to use when uploading the file.
@@ -354,9 +389,8 @@ default to the current OS temporary directory in linux /tmp/logstash
354
389
  * Default value is `15`
355
390
 
356
391
  Set the time, in MINUTES, to close the current sub_time_section of bucket.
357
- If you define file_size you have a number of files in consideration of the section and the current tag.
358
- 0 stay all time on listener, beware if you specific 0 and size_file 0, because you will not put the file on bucket,
359
- for now the only thing this plugin can do is to put the file when logstash restart.
392
+ If <<plugins-{type}s-{plugin}-rotation_strategy,`rotation_strategy`>> is set to `time` or `size_and_time`, then `time_file` cannot be set to 0.
393
+ Otherwise, the plugin raises a configuration error.
360
394
 
361
395
  [id="plugins-{type}s-{plugin}-upload_multipart_threshold"]
362
396
  ===== `upload_multipart_threshold`
@@ -388,8 +422,10 @@ Specify how many workers to use to upload the files to S3
388
422
  * Value type is <<boolean,boolean>>
389
423
  * Default value is `true`
390
424
 
391
- The common use case is to define permission on the root bucket and give Logstash full access to write its logs.
392
- In some circumstances you need finer grained permission on subfolder, this allow you to disable the check at startup.
425
+ The common use case is to define permissions on the root bucket and give Logstash
426
+ full access to write logs.
427
+ In some circumstances, you need more granular permissions on the subfolder. This
428
+ allows you to disable the check at startup.
393
429
 
394
430
  [id="plugins-{type}s-{plugin}-common-options"]
395
431
  include::{include_path}/{type}.asciidoc[]
@@ -114,9 +114,8 @@ class LogStash::Outputs::S3 < LogStash::Outputs::Base
114
114
  config :size_file, :validate => :number, :default => 1024 * 1024 * 5
115
115
 
116
116
  # Set the time, in MINUTES, to close the current sub_time_section of bucket.
117
- # If you define file_size you have a number of files in consideration of the section and the current tag.
118
- # 0 stay all time on listerner, beware if you specific 0 and size_file 0, because you will not put the file on bucket,
119
- # for now the only thing this plugin can do is to put the file when logstash restart.
117
+ # If you also define file_size you have a number of files related to the section and the current tag.
118
+ # If it's valued 0 and rotation_strategy is 'time' or 'size_and_time' then the plugin reaise a configuration error.
120
119
  config :time_file, :validate => :number, :default => 15
121
120
 
122
121
  ## IMPORTANT: if you use multiple instance of s3, you should specify on one of them the "restore=> true" and on the others "restore => false".
@@ -144,7 +143,7 @@ class LogStash::Outputs::S3 < LogStash::Outputs::Base
144
143
  # More information about the different storage classes can be found:
145
144
  # http://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html
146
145
  # Defaults to STANDARD.
147
- config :storage_class, :validate => ["STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA"], :default => "STANDARD"
146
+ config :storage_class, :validate => ["STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA"], :default => "STANDARD"
148
147
 
149
148
  # Set the directory where logstash will store the tmp files before sending it to S3
150
149
  # default to the current OS temporary directory in linux /tmp/logstash
@@ -188,6 +187,12 @@ class LogStash::Outputs::S3 < LogStash::Outputs::Base
188
187
  # In some circonstances you need finer grained permission on subfolder, this allow you to disable the check at startup.
189
188
  config :validate_credentials_on_root_bucket, :validate => :boolean, :default => true
190
189
 
190
+ # The number of times to retry a failed S3 upload.
191
+ config :retry_count, :validate => :number, :default => Float::INFINITY
192
+
193
+ # The amount of time to wait in seconds before attempting to retry a failed upload.
194
+ config :retry_delay, :validate => :number, :default => 1
195
+
191
196
  def register
192
197
  # I've move the validation of the items into custom classes
193
198
  # to prepare for the new config validation that will be part of the core so the core can
@@ -219,7 +224,7 @@ class LogStash::Outputs::S3 < LogStash::Outputs::Base
219
224
  :max_queue => @upload_queue_size,
220
225
  :fallback_policy => :caller_runs })
221
226
 
222
- @uploader = Uploader.new(bucket_resource, @logger, executor)
227
+ @uploader = Uploader.new(bucket_resource, @logger, executor, retry_count: @retry_count, retry_delay: @retry_delay)
223
228
 
224
229
  # Restoring from crash will use a new threadpool to slowly recover
225
230
  # New events should have more priority.
@@ -326,10 +331,6 @@ class LogStash::Outputs::S3 < LogStash::Outputs::Base
326
331
  Aws::S3::Bucket.new(@bucket, full_options)
327
332
  end
328
333
 
329
- def aws_service_endpoint(region)
330
- { :s3_endpoint => region == 'us-east-1' ? 's3.amazonaws.com' : "s3-#{region}.amazonaws.com"}
331
- end
332
-
333
334
  def rotate_if_needed(prefixes)
334
335
  prefixes.each do |prefix|
335
336
  # Each file access is thread safe,
@@ -6,7 +6,7 @@ module LogStash
6
6
  module Outputs
7
7
  class S3
8
8
  class Uploader
9
- TIME_BEFORE_RETRYING_SECONDS = 1
9
+
10
10
  DEFAULT_THREADPOOL = Concurrent::ThreadPoolExecutor.new({
11
11
  :min_threads => 1,
12
12
  :max_threads => 8,
@@ -14,13 +14,14 @@ module LogStash
14
14
  :fallback_policy => :caller_runs
15
15
  })
16
16
 
17
-
18
17
  attr_reader :bucket, :upload_options, :logger
19
18
 
20
- def initialize(bucket, logger, threadpool = DEFAULT_THREADPOOL)
19
+ def initialize(bucket, logger, threadpool = DEFAULT_THREADPOOL, retry_count: Float::INFINITY, retry_delay: 1)
21
20
  @bucket = bucket
22
21
  @workers_pool = threadpool
23
22
  @logger = logger
23
+ @retry_count = retry_count
24
+ @retry_delay = retry_delay
24
25
  end
25
26
 
26
27
  def upload_async(file, options = {})
@@ -33,6 +34,7 @@ module LogStash
33
34
  def upload(file, options = {})
34
35
  upload_options = options.fetch(:upload_options, {})
35
36
 
37
+ tries = 0
36
38
  begin
37
39
  obj = bucket.object(file.key)
38
40
  obj.upload_file(file.path, upload_options)
@@ -44,15 +46,22 @@ module LogStash
44
46
  #
45
47
  # Thread might be stuck here, but I think its better than losing anything
46
48
  # its either a transient errors or something bad really happened.
47
- logger.error("Uploading failed, retrying.", :exception => e.class, :message => e.message, :path => file.path, :backtrace => e.backtrace)
48
- sleep TIME_BEFORE_RETRYING_SECONDS
49
- retry
49
+ if tries < @retry_count
50
+ tries += 1
51
+ logger.warn("Uploading failed, retrying (##{tries} of #{@retry_count})", :exception => e.class, :message => e.message, :path => file.path, :backtrace => e.backtrace)
52
+ sleep @retry_delay
53
+ retry
54
+ else
55
+ logger.error("Failed to upload file (retried #{@retry_count} times).", :exception => e.class, :message => e.message, :path => file.path, :backtrace => e.backtrace)
56
+ end
50
57
  end
51
58
 
52
- options[:on_complete].call(file) unless options[:on_complete].nil?
53
- rescue => e
54
- logger.error("An error occured in the `on_complete` uploader", :exception => e.class, :message => e.message, :path => file.path, :backtrace => e.backtrace)
55
- raise e # reraise it since we don't deal with it now
59
+ begin
60
+ options[:on_complete].call(file) unless options[:on_complete].nil?
61
+ rescue => e
62
+ logger.error("An error occurred in the `on_complete` uploader", :exception => e.class, :message => e.message, :path => file.path, :backtrace => e.backtrace)
63
+ raise e # reraise it since we don't deal with it now
64
+ end
56
65
  end
57
66
 
58
67
  def stop
@@ -1,6 +1,6 @@
1
1
  Gem::Specification.new do |s|
2
2
  s.name = 'logstash-output-s3'
3
- s.version = '4.1.9'
3
+ s.version = '4.3.2'
4
4
  s.licenses = ['Apache-2.0']
5
5
  s.summary = "Sends Logstash events to the Amazon Simple Storage Service"
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"
@@ -6,7 +6,7 @@ require "aws-sdk"
6
6
  require "stud/temporary"
7
7
 
8
8
  describe LogStash::Outputs::S3::Uploader do
9
- let(:logger) { spy(:logger ) }
9
+ let(:logger) { spy(:logger) }
10
10
  let(:max_upload_workers) { 1 }
11
11
  let(:bucket_name) { "foobar-bucket" }
12
12
  let(:client) { Aws::S3::Client.new(stub_responses: true) }
@@ -14,7 +14,6 @@ describe LogStash::Outputs::S3::Uploader do
14
14
  let(:temporary_directory) { Stud::Temporary.pathname }
15
15
  let(:temporary_file) { Stud::Temporary.file }
16
16
  let(:key) { "foobar" }
17
- let(:upload_options) { {} }
18
17
  let(:threadpool) do
19
18
  Concurrent::ThreadPoolExecutor.new({
20
19
  :min_threads => 1,
@@ -31,27 +30,41 @@ describe LogStash::Outputs::S3::Uploader do
31
30
  f
32
31
  end
33
32
 
34
- subject { described_class.new(bucket, logger, threadpool) }
33
+ subject { described_class.new(bucket, logger, threadpool, retry_delay: 0.01) }
35
34
 
36
35
  it "upload file to the s3 bucket" do
37
36
  expect { subject.upload(file) }.not_to raise_error
38
37
  end
39
38
 
40
39
  it "execute a callback when the upload is complete" do
41
- callback = proc { |f| }
40
+ callback = proc { |_| }
42
41
 
43
42
  expect(callback).to receive(:call).with(file)
44
- subject.upload(file, { :on_complete => callback })
43
+ subject.upload(file, :on_complete => callback)
45
44
  end
46
45
 
47
- it "retries errors indefinitively" do
46
+ it "retries errors indefinitely" do
48
47
  s3 = double("s3").as_null_object
49
48
 
50
- expect(logger).to receive(:error).with(any_args).once
51
- expect(bucket).to receive(:object).with(file.key).and_return(s3).twice
52
- expect(s3).to receive(:upload_file).with(any_args).and_raise(StandardError)
49
+ allow(bucket).to receive(:object).with(file.key).and_return(s3)
50
+
51
+ expect(logger).to receive(:warn).with(any_args)
52
+ expect(s3).to receive(:upload_file).with(any_args).and_raise(RuntimeError.new('UPLOAD FAILED')).exactly(5).times
53
53
  expect(s3).to receive(:upload_file).with(any_args).and_return(true)
54
54
 
55
55
  subject.upload(file)
56
56
  end
57
+
58
+ it "retries errors specified times" do
59
+ subject = described_class.new(bucket, logger, threadpool, retry_count: 3, retry_delay: 0.01)
60
+ s3 = double("s3").as_null_object
61
+
62
+ allow(bucket).to receive(:object).with(file.key).and_return(s3)
63
+
64
+ expect(logger).to receive(:warn).with(any_args).exactly(3).times
65
+ expect(logger).to receive(:error).with(any_args).once
66
+ expect(s3).to receive(:upload_file).with(file.path, {}).and_raise(RuntimeError).at_least(1).times
67
+
68
+ subject.upload(file)
69
+ end
57
70
  end
@@ -122,7 +122,7 @@ describe LogStash::Outputs::S3 do
122
122
 
123
123
  describe "Storage Class" do
124
124
  context "when configured" do
125
- ["STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA"].each do |storage_class|
125
+ ["STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA"].each do |storage_class|
126
126
  it "should return the configured storage class: #{storage_class}" do
127
127
  s3 = described_class.new(options.merge({ "storage_class" => storage_class }))
128
128
  expect(s3.upload_options).to include(:storage_class => storage_class)
@@ -204,4 +204,27 @@ describe LogStash::Outputs::S3 do
204
204
  subject.multi_receive_encoded(events_and_encoded)
205
205
  end
206
206
  end
207
+
208
+ describe "aws service" do
209
+ context 'us-east-1' do
210
+ let(:region) { 'us-east-1' }
211
+ it "sets endpoint" do
212
+ expect( subject.send(:bucket_resource).client.config.endpoint.to_s ).to eql 'https://s3.us-east-1.amazonaws.com'
213
+ end
214
+ end
215
+
216
+ context 'ap-east-1' do
217
+ let(:region) { 'ap-east-1' }
218
+ it "sets endpoint" do
219
+ expect( subject.send(:bucket_resource).client.config.endpoint.to_s ).to eql 'https://s3.ap-east-1.amazonaws.com'
220
+ end
221
+ end
222
+
223
+ context 'cn-northwest-1' do
224
+ let(:region) { 'cn-northwest-1' }
225
+ it "sets endpoint" do
226
+ expect( subject.send(:bucket_resource).client.config.endpoint.to_s ).to eql 'https://s3.cn-northwest-1.amazonaws.com.cn'
227
+ end
228
+ end
229
+ end
207
230
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: logstash-output-s3
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.1.9
4
+ version: 4.3.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Elastic
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-04-15 00:00:00.000000000 Z
11
+ date: 2020-05-28 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  requirement: !ruby/object:Gem::Requirement