Class: LogStash::Outputs::Http

Inherits:
Base
  • Object
show all
Includes:
PluginMixins::HttpClient
Defined in:
lib/logstash/outputs/edge_http.rb

Defined Under Namespace

Classes: PluginInternalQueueLeftoverError, RetryTimerTask

Constant Summary collapse

VALID_METHODS = 
["put", "post", "patch", "delete", "get", "head"]
RETRYABLE_MANTICORE_EXCEPTIONS = 
[
  ::Manticore::Timeout,
  ::Manticore::SocketException,
  ::Manticore::ClientProtocolException,
  ::Manticore::ResolutionFailure,
  ::Manticore::SocketTimeout
]
RETRYABLE_UNKNOWN_EXCEPTION_STRINGS = 
[
  /Connection reset by peer/i,
  /Read Timed out/i
]

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#is_batch ⇒ Object

Returns the value of attribute is_batch.



15
16
17
 
# File 'lib/logstash/outputs/edge_http.rb', line 15

def is_batch
  @is_batch
end

Instance Method Details

#close ⇒ Object 



296
297
298
299
 
# File 'lib/logstash/outputs/edge_http.rb', line 296

def close
  @timer.cancel
  client.close
end

#log_error_response(response, url, event) ⇒ Object 



157
158
159
160
161
162
163
164
 
# File 'lib/logstash/outputs/edge_http.rb', line 157

def log_error_response(response, url, event)
  log_failure(
            "Encountered non-2xx HTTP code #{response.code}",
            :response_code => response.code,
            :url => url,
            :event => event
          )
end

#log_retryable_response(response) ⇒ Object 



148
149
150
151
152
153
154
155
 
# File 'lib/logstash/outputs/edge_http.rb', line 148

def log_retryable_response(response)
  retry_msg = @retry_failed ? 'will retry' : "won't retry"
  if (response.code == 429)
    @logger.debug? && @logger.debug("Encountered a 429 response, #{retry_msg}. This is not serious, just flow control via HTTP")
  else
    @logger.warn("Encountered a retryable HTTP request in HTTP output, #{retry_msg}", :code => response.code, :body => response.body)
  end
end

#multi_receive(events) ⇒ Object

def register



130
131
132
133
 
# File 'lib/logstash/outputs/edge_http.rb', line 130

def multi_receive(events)
  return if events.empty?
  send_events(events)
end

#pipeline_shutdown_requested? ⇒ Boolean

Returns:

  • (Boolean) 


231
232
233
234
 
# File 'lib/logstash/outputs/edge_http.rb', line 231

def pipeline_shutdown_requested?
  return super if defined?(super) # since LS 8.1.0
  nil
end

#register ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/logstash/outputs/edge_http.rb', line 99

def register
  @http_method = @http_method.to_sym

  # We count outstanding requests with this queue
  # This queue tracks the requests to create backpressure
  # When this queue is empty no new requests may be sent,
  # tokens must be added back by the client on success
  @request_tokens = SizedQueue.new(@pool_max)
  @pool_max.times {|t| @request_tokens << true }

  @requests = Array.new

  if @content_type.nil?
    case @format
      when "form" ; @content_type = "application/x-www-form-urlencoded"
      when "json" ; @content_type = "application/json"
      when "json_batch" ; @content_type = "application/json"
      when "message" ; @content_type = "text/plain"
    end
  end

  @is_batch = @format == "json_batch"

  @headers["Content-Type"] = @content_type

  validate_format!

  # Run named Timer as daemon thread
  @timer = java.util.Timer.new("HTTP Output #{self.params['id']}", true)
end

#send_event(event, attempt) ⇒ Object 



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/logstash/outputs/edge_http.rb', line 242

def send_event(event, attempt)
  body = event_body(event)

  # Send the request
  url = @is_batch ? @url : event.sprintf(@url)
  headers = @is_batch ? @headers : event_headers(event)

  # Compress the body and add appropriate header
  if @http_compression == true
    headers["Content-Encoding"] = "gzip"
    body = gzip(body)
  end

  # Create an async request
  response = client.send(@http_method, url, :body => body, :headers => headers).call

  if !response_success?(response)
    if retryable_response?(response)
      log_retryable_response(response)
      return :retry, event, attempt
    else
      log_error_response(response, url, event)
      return :failure, event, attempt
    end
  else
    return :success, event, attempt
  end

rescue => exception
  will_retry = retryable_exception?(exception)
  log_params = {
    :url => url,
    :method => @http_method,
    :message => exception.message,
    :class => exception.class,
    :will_retry => will_retry
  }
  if @logger.debug?
    # backtraces are big
    log_params[:backtrace] = exception.backtrace
    # headers can have sensitive data
    log_params[:headers] = headers
    # body can be big and may have sensitive data
    log_params[:body] = body
  end
  log_failure("Could not fetch URL", log_params)

  if will_retry
    return :retry, event, attempt
  else
    return :failure, event, attempt
  end
end

#send_events(events) ⇒ Object 



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/logstash/outputs/edge_http.rb', line 166

def send_events(events)
  successes = java.util.concurrent.atomic.AtomicInteger.new(0)
  failures  = java.util.concurrent.atomic.AtomicInteger.new(0)
  retries = java.util.concurrent.atomic.AtomicInteger.new(0)
  event_count = @is_batch ? 1 : events.size

  pending = Queue.new
  if @is_batch
    pending << [events, 0]
  else
    events.each {|e| pending << [e, 0]}
  end

  while popped = pending.pop
    break if popped == :done

    event, attempt = popped

    raise PluginInternalQueueLeftoverError.new("Received pipeline shutdown request but http output has unfinished events. " \
            "If persistent queue is enabled, events will be retried.") if attempt > 2 && pipeline_shutdown_requested?

    action, event, attempt = send_event(event, attempt)
    begin
      action = :failure if action == :retry && !@retry_failed

      case action
      when :success
        successes.incrementAndGet
      when :retry
        retries.incrementAndGet

        next_attempt = attempt+1
        sleep_for = sleep_for_attempt(next_attempt)
        @logger.info("Retrying http request, will sleep for #{sleep_for} seconds")
        timer_task = RetryTimerTask.new(pending, event, next_attempt)
        @timer.schedule(timer_task, sleep_for*1000)
      when :failure
        failures.incrementAndGet
      else
        raise "Unknown action #{action}"
      end

      if action == :success || action == :failure
        if successes.get+failures.get == event_count
          pending << :done
        end
      end
    rescue => e
      # This should never happen unless there's a flat out bug in the code
      @logger.error("Error sending HTTP Request",
        :class => e.class.name,
        :message => e.message,
        :backtrace => e.backtrace)
      failures.incrementAndGet
      raise e
    end
  end
rescue => e
  @logger.error("Error in http output loop",
          :class => e.class.name,
          :message => e.message,
          :backtrace => e.backtrace)
  raise e
end

#sleep_for_attempt(attempt) ⇒ Object 



236
237
238
239
240
 
# File 'lib/logstash/outputs/edge_http.rb', line 236

def sleep_for_attempt(attempt)
  sleep_for = attempt**2
  sleep_for = sleep_for <= 60 ? sleep_for : 60
  (sleep_for/2) + (rand(0..sleep_for)/2)
end