logstash-output-http 5.2.0 → 5.2.5

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: 74a3adbb0ae7188d50a8c025f7fd256cfb4adb36e4e17862c6d64ae6b6b6c8ee
4
- data.tar.gz: 72e55c3f943a81d2e5e89e4a52ba54a39495e7f9ea3e684273822d7dc59d7ec4
3
+ metadata.gz: 7bc2a004219fe6c466a5d60b24de18d1e70e8350da5f204279e43bdc0205b24a
4
+ data.tar.gz: a3e44b45451030f4ba285df7875b418ef043df81e0689230b20a3de295484cde
5
5
  SHA512:
6
- metadata.gz: d7d0109785a2fe03f9936e6a7d56cf6406d3c81c1f66f7afdae0d45fe9b998dfdd95fe1e5970ccec15b69f6f884e9104aacfc7ca063a83d7feae3b35e278bb8a
7
- data.tar.gz: 074e51a776ec7c1b12f3fbb33ccc9da9d6bd1188b32884bd6403506709c09083c930420550f9ee5ce2d8c5a4aff32dcc709972df71a53bb69c6a05044b1580fe
6
+ metadata.gz: d9d08edfc5f3cb590177d1b529b30fde4e7fc4ed3ee70bca99dcd2e0c4cdb01cb91f90d5deb0fb60efc6ce3e632ff7db2bcb82890c4f7ad6a08a576c209f9fd9
7
+ data.tar.gz: 79c522bf0c7be7dd4d60abccef78eb52dd52f8f3a3cd30fd141941aef6e1288ea5e5249fe718fbf4452b2f81a8f09d168ffabba7ecc2a6b374a9f25cedf886a4
data/CHANGELOG.md CHANGED
@@ -1,3 +1,19 @@
1
+ ## 5.2.5
2
+ - Reduce amount of default logging on a failed request [#122](https://github.com/logstash-plugins/logstash-output-http/pull/122)
3
+
4
+ ## 5.2.4
5
+ - Relax dependency on http_client mixin since current major works on both
6
+
7
+ ## 5.2.3
8
+ - Fixed handling of empty `retryable_codes` [#99](https://github.com/logstash-plugins/logstash-output-http/pull/99)
9
+
10
+ ## 5.2.2
11
+ - Fix high CPU usage on retries in json_batch mode. [#89](https://github.com/logstash-plugins/logstash-output-http/pull/89)
12
+ - Enable compression in json_batch mode. [#89](https://github.com/logstash-plugins/logstash-output-http/pull/89)
13
+
14
+ ## 5.2.1
15
+ - Docs: Set the default_codec doc attribute.
16
+
1
17
  ## 5.2.0
2
18
  - Added json_batch format
3
19
  - Make 429 responses log at debug, not error level. They are really just flow control
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.
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Logstash Plugin
2
2
 
3
- [![Travis Build Status](https://travis-ci.org/logstash-plugins/logstash-output-http.svg)](https://travis-ci.org/logstash-plugins/logstash-output-http)
3
+ [![Travis Build Status](https://travis-ci.com/logstash-plugins/logstash-output-http.svg)](https://travis-ci.com/logstash-plugins/logstash-output-http)
4
4
 
5
5
  This is a plugin for [Logstash](https://github.com/elastic/logstash).
6
6
 
data/docs/index.asciidoc CHANGED
@@ -1,5 +1,6 @@
1
1
  :plugin: http
2
2
  :type: output
3
+ :default_codec: plain
3
4
 
4
5
  ///////////////////////////////////////////
5
6
  START - GENERATED VARIABLES, DO NOT EDIT!
@@ -85,7 +86,10 @@ output plugins.
85
86
 
86
87
  How many times should the client retry a failing URL. We highly recommend NOT setting this value
87
88
  to zero if keepalive is enabled. Some servers incorrectly end keepalives early requiring a retry!
88
- Note: if `retry_non_idempotent` is set only GET, HEAD, PUT, DELETE, OPTIONS, and TRACE requests will be retried.
89
+ Only IO related failures will be retried, such as connection timeouts and unreachable hosts.
90
+ Valid but non 2xx HTTP responses will always be retried, regardless of the value of this setting,
91
+ unless `retry_failed` is set.
92
+ Note: if `retry_non_idempotent` is NOT set only GET, HEAD, PUT, DELETE, OPTIONS, and TRACE requests will be retried.
89
93
 
90
94
  [id="plugins-{type}s-{plugin}-cacert"]
91
95
  ===== `cacert`
@@ -315,6 +319,7 @@ Set this to false if you don't want this output to retry failed requests
315
319
  * Default value is `false`
316
320
 
317
321
  If `automatic_retries` is enabled this will cause non-idempotent HTTP verbs (such as POST) to be retried.
322
+ This only affects connectivity related errors (see related `automatic_retries` setting).
318
323
 
319
324
  [id="plugins-{type}s-{plugin}-retryable_codes"]
320
325
  ===== `retryable_codes`
@@ -382,3 +387,5 @@ See https://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/org/apache
382
387
 
383
388
  [id="plugins-{type}s-{plugin}-common-options"]
384
389
  include::{include_path}/{type}.asciidoc[]
390
+
391
+ :default_codec!:
@@ -8,16 +8,18 @@ require "zlib"
8
8
 
9
9
  class LogStash::Outputs::Http < LogStash::Outputs::Base
10
10
  include LogStash::PluginMixins::HttpClient
11
-
11
+
12
12
  concurrency :shared
13
13
 
14
+ attr_accessor :is_batch
15
+
14
16
  VALID_METHODS = ["put", "post", "patch", "delete", "get", "head"]
15
-
17
+
16
18
  RETRYABLE_MANTICORE_EXCEPTIONS = [
17
19
  ::Manticore::Timeout,
18
20
  ::Manticore::SocketException,
19
- ::Manticore::ClientProtocolException,
20
- ::Manticore::ResolutionFailure,
21
+ ::Manticore::ClientProtocolException,
22
+ ::Manticore::ResolutionFailure,
21
23
  ::Manticore::SocketTimeout
22
24
  ]
23
25
 
@@ -51,14 +53,14 @@ class LogStash::Outputs::Http < LogStash::Outputs::Base
51
53
  # * if format is "json", "application/json"
52
54
  # * if format is "form", "application/x-www-form-urlencoded"
53
55
  config :content_type, :validate => :string
54
-
56
+
55
57
  # Set this to false if you don't want this output to retry failed requests
56
58
  config :retry_failed, :validate => :boolean, :default => true
57
-
59
+
58
60
  # If encountered as response codes this plugin will retry these requests
59
61
  config :retryable_codes, :validate => :number, :list => true, :default => [429, 500, 502, 503, 504]
60
-
61
- # If you would like to consider some non-2xx codes to be successes
62
+
63
+ # If you would like to consider some non-2xx codes to be successes
62
64
  # enumerate them here. Responses returning these codes will be considered successes
63
65
  config :ignorable_codes, :validate => :number, :list => true
64
66
 
@@ -83,7 +85,7 @@ class LogStash::Outputs::Http < LogStash::Outputs::Base
83
85
 
84
86
  # Set this to true if you want to enable gzip compression for your http requests
85
87
  config :http_compression, :validate => :boolean, :default => false
86
-
88
+
87
89
  config :message, :validate => :string
88
90
 
89
91
  def register
@@ -107,24 +109,21 @@ class LogStash::Outputs::Http < LogStash::Outputs::Base
107
109
  end
108
110
  end
109
111
 
112
+ @is_batch = @format == "json_batch"
110
113
 
111
114
  @headers["Content-Type"] = @content_type
112
115
 
113
116
  validate_format!
114
-
117
+
115
118
  # Run named Timer as daemon thread
116
119
  @timer = java.util.Timer.new("HTTP Output #{self.params['id']}", true)
117
120
  end # def register
118
121
 
119
122
  def multi_receive(events)
120
123
  return if events.empty?
121
- if @format == "json_batch"
122
- send_json_batch(events)
123
- else
124
- send_events(events)
125
- end
124
+ send_events(events)
126
125
  end
127
-
126
+
128
127
  class RetryTimerTask < java.util.TimerTask
129
128
  def initialize(pending, event, attempt)
130
129
  @pending = pending
@@ -132,35 +131,12 @@ class LogStash::Outputs::Http < LogStash::Outputs::Base
132
131
  @attempt = attempt
133
132
  super()
134
133
  end
135
-
134
+
136
135
  def run
137
136
  @pending << [@event, @attempt]
138
137
  end
139
138
  end
140
139
 
141
- def send_json_batch(events)
142
- attempt = 1
143
- body = LogStash::Json.dump(events.map {|e| map_event(e) })
144
- begin
145
- while true
146
- request = client.send(@http_method, @url, :body => body, :headers => @headers)
147
- response = request.call
148
- break if response_success?(response)
149
- if retryable_response?(response)
150
- log_retryable_response(response)
151
- sleep_for_attempt attempt
152
- attempt += 1
153
- else
154
- log_error_response(response, url, events)
155
- end
156
- end
157
- rescue *RETRYABLE_MANTICORE_EXCEPTIONS => e
158
- logger.warn("Encountered exception during http output send, will retry after delay", :message => e.message, :class => e.class.name)
159
- sleep_for_attempt attempt
160
- retry
161
- end
162
- end
163
-
164
140
  def log_retryable_response(response)
165
141
  if (response.code == 429)
166
142
  @logger.debug? && @logger.debug("Encountered a 429 response, will retry. This is not serious, just flow control via HTTP")
@@ -177,55 +153,59 @@ class LogStash::Outputs::Http < LogStash::Outputs::Base
177
153
  :event => event
178
154
  )
179
155
  end
180
-
156
+
181
157
  def send_events(events)
182
158
  successes = java.util.concurrent.atomic.AtomicInteger.new(0)
183
159
  failures = java.util.concurrent.atomic.AtomicInteger.new(0)
184
160
  retries = java.util.concurrent.atomic.AtomicInteger.new(0)
185
-
161
+ event_count = @is_batch ? 1 : events.size
162
+
186
163
  pending = Queue.new
187
- events.each {|e| pending << [e, 0]}
164
+ if @is_batch
165
+ pending << [events, 0]
166
+ else
167
+ events.each {|e| pending << [e, 0]}
168
+ end
188
169
 
189
170
  while popped = pending.pop
190
171
  break if popped == :done
191
-
172
+
192
173
  event, attempt = popped
193
-
194
- send_event(event, attempt) do |action,event,attempt|
195
- begin
196
- action = :failure if action == :retry && !@retry_failed
197
-
198
- case action
199
- when :success
200
- successes.incrementAndGet
201
- when :retry
202
- retries.incrementAndGet
203
-
204
- next_attempt = attempt+1
205
- sleep_for = sleep_for_attempt(next_attempt)
206
- @logger.info("Retrying http request, will sleep for #{sleep_for} seconds")
207
- timer_task = RetryTimerTask.new(pending, event, next_attempt)
208
- @timer.schedule(timer_task, sleep_for*1000)
209
- when :failure
210
- failures.incrementAndGet
211
- else
212
- raise "Unknown action #{action}"
213
- end
214
-
215
- if action == :success || action == :failure
216
- if successes.get+failures.get == events.size
217
- pending << :done
218
- end
219
- end
220
- rescue => e
221
- # This should never happen unless there's a flat out bug in the code
222
- @logger.error("Error sending HTTP Request",
223
- :class => e.class.name,
224
- :message => e.message,
225
- :backtrace => e.backtrace)
174
+
175
+ action, event, attempt = send_event(event, attempt)
176
+ begin
177
+ action = :failure if action == :retry && !@retry_failed
178
+
179
+ case action
180
+ when :success
181
+ successes.incrementAndGet
182
+ when :retry
183
+ retries.incrementAndGet
184
+
185
+ next_attempt = attempt+1
186
+ sleep_for = sleep_for_attempt(next_attempt)
187
+ @logger.info("Retrying http request, will sleep for #{sleep_for} seconds")
188
+ timer_task = RetryTimerTask.new(pending, event, next_attempt)
189
+ @timer.schedule(timer_task, sleep_for*1000)
190
+ when :failure
226
191
  failures.incrementAndGet
227
- raise e
192
+ else
193
+ raise "Unknown action #{action}"
194
+ end
195
+
196
+ if action == :success || action == :failure
197
+ if successes.get+failures.get == event_count
198
+ pending << :done
199
+ end
228
200
  end
201
+ rescue => e
202
+ # This should never happen unless there's a flat out bug in the code
203
+ @logger.error("Error sending HTTP Request",
204
+ :class => e.class.name,
205
+ :message => e.message,
206
+ :backtrace => e.backtrace)
207
+ failures.incrementAndGet
208
+ raise e
229
209
  end
230
210
  end
231
211
  rescue => e
@@ -235,19 +215,19 @@ class LogStash::Outputs::Http < LogStash::Outputs::Base
235
215
  :backtrace => e.backtrace)
236
216
  raise e
237
217
  end
238
-
218
+
239
219
  def sleep_for_attempt(attempt)
240
220
  sleep_for = attempt**2
241
221
  sleep_for = sleep_for <= 60 ? sleep_for : 60
242
222
  (sleep_for/2) + (rand(0..sleep_for)/2)
243
223
  end
244
-
224
+
245
225
  def send_event(event, attempt)
246
226
  body = event_body(event)
247
227
 
248
228
  # Send the request
249
- url = event.sprintf(@url)
250
- headers = event_headers(event)
229
+ url = @is_batch ? @url : event.sprintf(@url)
230
+ headers = @is_batch ? @headers : event_headers(event)
251
231
 
252
232
  # Compress the body and add appropriate header
253
233
  if @http_compression == true
@@ -256,62 +236,44 @@ class LogStash::Outputs::Http < LogStash::Outputs::Base
256
236
  end
257
237
 
258
238
  # Create an async request
259
- request = client.background.send(@http_method, url, :body => body, :headers => headers)
260
-
261
- request.on_success do |response|
262
- begin
263
- if !response_success?(response)
264
- if retryable_response?(response)
265
- log_retryable_response(response)
266
- yield :retry, event, attempt
267
- else
268
- log_error_response(response, url, event)
269
- yield :failure, event, attempt
270
- end
271
- else
272
- yield :success, event, attempt
273
- end
274
- rescue => e
275
- # Shouldn't ever happen
276
- @logger.error("Unexpected error in request success!",
277
- :class => e.class.name,
278
- :message => e.message,
279
- :backtrace => e.backtrace)
239
+ response = client.send(@http_method, url, :body => body, :headers => headers).call
240
+
241
+ if !response_success?(response)
242
+ if retryable_response?(response)
243
+ log_retryable_response(response)
244
+ return :retry, event, attempt
245
+ else
246
+ log_error_response(response, url, event)
247
+ return :failure, event, attempt
280
248
  end
249
+ else
250
+ return :success, event, attempt
281
251
  end
282
252
 
283
- request.on_failure do |exception|
284
- begin
285
- will_retry = retryable_exception?(exception)
286
- log_failure("Could not fetch URL",
287
- :url => url,
288
- :method => @http_method,
289
- :body => body,
290
- :headers => headers,
291
- :message => exception.message,
292
- :class => exception.class.name,
293
- :backtrace => exception.backtrace,
294
- :will_retry => will_retry
295
- )
296
-
297
- if will_retry
298
- yield :retry, event, attempt
299
- else
300
- yield :failure, event, attempt
301
- end
302
- rescue => e
303
- # Shouldn't ever happen
304
- @logger.error("Unexpected error in request failure!",
305
- :class => e.class.name,
306
- :message => e.message,
307
- :backtrace => e.backtrace)
308
- end
253
+ rescue => exception
254
+ will_retry = retryable_exception?(exception)
255
+ log_params = {
256
+ :url => url,
257
+ :method => @http_method,
258
+ :message => exception.message,
259
+ :class => exception.class.name,
260
+ :will_retry => will_retry
261
+ }
262
+ if @logger.debug?
263
+ # backtraces are big
264
+ log_params[:backtrace] = exception.backtrace
265
+ # headers can have sensitive data
266
+ log_params[:headers] = headers
267
+ # body can be big and may have sensitive data
268
+ log_params[:body] = body
309
269
  end
270
+ log_failure("Could not fetch URL", log_params)
310
271
 
311
- # Actually invoke the request in the background
312
- # Note: this must only be invoked after all handlers are defined, otherwise
313
- # those handlers are not guaranteed to be called!
314
- request.call
272
+ if will_retry
273
+ return :retry, event, attempt
274
+ else
275
+ return :failure, event, attempt
276
+ end
315
277
  end
316
278
 
317
279
  def close
@@ -320,17 +282,17 @@ class LogStash::Outputs::Http < LogStash::Outputs::Base
320
282
  end
321
283
 
322
284
  private
323
-
285
+
324
286
  def response_success?(response)
325
287
  code = response.code
326
288
  return true if @ignorable_codes && @ignorable_codes.include?(code)
327
289
  return code >= 200 && code <= 299
328
290
  end
329
-
291
+
330
292
  def retryable_response?(response)
331
- @retryable_codes.include?(response.code)
293
+ @retryable_codes && @retryable_codes.include?(response.code)
332
294
  end
333
-
295
+
334
296
  def retryable_exception?(exception)
335
297
  RETRYABLE_MANTICORE_EXCEPTIONS.any? {|me| exception.is_a?(me) }
336
298
  end
@@ -347,6 +309,8 @@ class LogStash::Outputs::Http < LogStash::Outputs::Base
347
309
  LogStash::Json.dump(map_event(event))
348
310
  elsif @format == "message"
349
311
  event.sprintf(@message)
312
+ elsif @format == "json_batch"
313
+ LogStash::Json.dump(event.map {|e| map_event(e) })
350
314
  else
351
315
  encode(map_event(event))
352
316
  end
@@ -1,6 +1,6 @@
1
1
  Gem::Specification.new do |s|
2
2
  s.name = 'logstash-output-http'
3
- s.version = '5.2.0'
3
+ s.version = '5.2.5'
4
4
  s.licenses = ['Apache License (2.0)']
5
5
  s.summary = "Sends events to a generic HTTP or HTTPS endpoint"
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"
@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
20
20
 
21
21
  # Gem dependencies
22
22
  s.add_runtime_dependency "logstash-core-plugin-api", ">= 1.60", "<= 2.99"
23
- s.add_runtime_dependency "logstash-mixin-http_client", ">= 6.0.0", "< 7.0.0"
23
+ s.add_runtime_dependency "logstash-mixin-http_client", ">= 6.0.0", "< 8.0.0"
24
24
 
25
25
  s.add_development_dependency 'logstash-devutils'
26
26
  s.add_development_dependency 'sinatra'
@@ -117,12 +117,10 @@ describe LogStash::Outputs::Http do
117
117
 
118
118
  let(:expected_method) { method.clone.to_sym }
119
119
  let(:client) { subject.client }
120
- let(:client_proxy) { subject.client.background }
121
120
 
122
121
  before do
123
- allow(client).to receive(:background).and_return(client_proxy)
124
122
  subject.register
125
- allow(client_proxy).to receive(:send).
123
+ allow(client).to receive(:send).
126
124
  with(expected_method, url, anything).
127
125
  and_call_original
128
126
  allow(subject).to receive(:log_failure).with(any_args)
@@ -142,7 +140,7 @@ describe LogStash::Outputs::Http do
142
140
  end
143
141
 
144
142
  it "should execute the request" do
145
- expect(client_proxy).to have_received(:send).
143
+ expect(client).to have_received(:send).
146
144
  with(expected_method, url, anything)
147
145
  end
148
146
  end
@@ -171,7 +169,7 @@ describe LogStash::Outputs::Http do
171
169
 
172
170
  context "with ignorable failing requests" do
173
171
  let(:url) { "http://localhost:#{port}/bad"}
174
- let(:verb_behavior_config) { super.merge("ignorable_codes" => [400]) }
172
+ let(:verb_behavior_config) { super().merge("ignorable_codes" => [400]) }
175
173
 
176
174
  before do
177
175
  subject.multi_receive([event])
@@ -199,7 +197,43 @@ describe LogStash::Outputs::Http do
199
197
  expect(subject).to have_received(:send_event).exactly(3).times
200
198
  end
201
199
  end
200
+ end
201
+
202
+ context "on exception" do
203
+ before :each do
204
+ allow(subject.client).to receive(:send).and_raise RuntimeError
205
+ subject.multi_receive([event])
206
+ end
207
+
208
+ it "should not log headers" do
209
+ expect(subject).to have_received(:log_failure).with(anything, hash_not_including(:headers))
210
+ end
211
+
212
+ it "should not log the body" do
213
+ expect(subject).to have_received(:log_failure).with(anything, hash_not_including(:body))
214
+ end
215
+
216
+ context "with debug log level" do
217
+ before :all do
218
+ @current_log_level = LogStash::Logging::Logger.get_logging_context.get_root_logger.get_level.to_s.downcase
219
+ LogStash::Logging::Logger.configure_logging "debug"
220
+ end
221
+ after :all do
222
+ LogStash::Logging::Logger.configure_logging @current_log_level
223
+ end
224
+
225
+ it "should log a failure" do
226
+ expect(subject).to have_received(:log_failure).with(any_args)
227
+ end
202
228
 
229
+ it "should not log headers" do
230
+ expect(subject).to have_received(:log_failure).with(anything, hash_including(:headers))
231
+ end
232
+
233
+ it "should not log the body" do
234
+ expect(subject).to have_received(:log_failure).with(anything, hash_including(:body))
235
+ end
236
+ end
203
237
  end
204
238
  end
205
239
 
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: logstash-output-http
3
3
  version: !ruby/object:Gem::Version
4
- version: 5.2.0
4
+ version: 5.2.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - Elastic
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-01-15 00:00:00.000000000 Z
11
+ date: 2021-05-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  requirement: !ruby/object:Gem::Requirement
@@ -38,7 +38,7 @@ dependencies:
38
38
  version: 6.0.0
39
39
  - - "<"
40
40
  - !ruby/object:Gem::Version
41
- version: 7.0.0
41
+ version: 8.0.0
42
42
  name: logstash-mixin-http_client
43
43
  prerelease: false
44
44
  type: :runtime
@@ -49,7 +49,7 @@ dependencies:
49
49
  version: 6.0.0
50
50
  - - "<"
51
51
  - !ruby/object:Gem::Version
52
- version: 7.0.0
52
+ version: 8.0.0
53
53
  - !ruby/object:Gem::Dependency
54
54
  requirement: !ruby/object:Gem::Requirement
55
55
  requirements: