Class: Fluent::Plugin::HTTPOutput

Inherits:
Output
  • Object
show all
Defined in:
lib/fluent/plugin/out_http.rb

Constant Summary collapse

DEFAULT_BUFFER_TYPE =
"memory"

Instance Method Summary collapse

Constructor Details

#initializeHTTPOutput

Returns a new instance of HTTPOutput.



13
14
15
# File 'lib/fluent/plugin/out_http.rb', line 13

def initialize
  super
end

Instance Method Details

#configure(conf) ⇒ Object

Raises:

  • (Fluent::ConfigError)


49
50
51
52
53
54
55
56
57
58
59
60
61
# File 'lib/fluent/plugin/out_http.rb', line 49

def configure(conf)
  compat_parameters_convert(conf, :buffer)
  super

  @ssl_verify_mode = if @ssl_no_verify
                       OpenSSL::SSL::VERIFY_NONE
                     else
                       OpenSSL::SSL::VERIFY_PEER
                     end

  @last_request_time = nil
  raise Fluent::ConfigError, "'tag' in chunk_keys is required." if !@chunk_key_tag && @buffered
end

#create_request(tag, time, record) ⇒ Object



93
94
95
96
97
98
99
100
# File 'lib/fluent/plugin/out_http.rb', line 93

def create_request(tag, time, record)
  url = format_url(tag, time, record)
  uri = URI.parse(url)
  req = Net::HTTP.const_get(@http_method.to_s.capitalize).new(uri.path)
  set_body(req, tag, time, record)
  set_header(req, tag, time, record)
  return req, uri
end

#format(tag, time, record) ⇒ Object



154
155
156
# File 'lib/fluent/plugin/out_http.rb', line 154

def format(tag, time, record)
  [time, record].to_msgpack
end

#format_url(tag, time, record) ⇒ Object



71
72
73
# File 'lib/fluent/plugin/out_http.rb', line 71

def format_url(tag, time, record)
  @endpoint_url
end

#formatted_to_msgpack_binary?Boolean

Returns:

  • (Boolean)


158
159
160
# File 'lib/fluent/plugin/out_http.rb', line 158

def formatted_to_msgpack_binary?
  true
end

#handle_record(tag, time, record) ⇒ Object

end send_request



145
146
147
148
# File 'lib/fluent/plugin/out_http.rb', line 145

def handle_record(tag, time, record)
  req, uri = create_request(tag, time, record)
  send_request(req, uri)
end

#http_opts(uri) ⇒ Object



102
103
104
105
106
107
108
# File 'lib/fluent/plugin/out_http.rb', line 102

def http_opts(uri)
    opts = {
      :use_ssl => uri.scheme == 'https'
    }
    opts[:verify_mode] = @ssl_verify_mode if opts[:use_ssl]
    opts
end

#multi_workers_ready?Boolean

Returns:

  • (Boolean)


162
163
164
# File 'lib/fluent/plugin/out_http.rb', line 162

def multi_workers_ready?
  true
end

#prefer_buffered_processingObject



150
151
152
# File 'lib/fluent/plugin/out_http.rb', line 150

def prefer_buffered_processing
  @buffered
end

#process(tag, es) ⇒ Object



166
167
168
169
170
# File 'lib/fluent/plugin/out_http.rb', line 166

def process(tag, es)
  es.each do |time, record|
    handle_record(tag, time, record)
  end
end

#send_request(req, uri) ⇒ Object



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# File 'lib/fluent/plugin/out_http.rb', line 110

def send_request(req, uri)
  is_rate_limited = (@rate_limit_msec != 0 and not @last_request_time.nil?)
  if is_rate_limited and ((Time.now.to_f - @last_request_time) * 1000.0 < @rate_limit_msec)
    log.info('Dropped request due to rate limiting')
    return
  end

  res = nil

  begin
    if @authentication == :basic
      req.basic_auth(@username, @password)
    elsif @authentication == :bearer
      req['authorization'] = "bearer #{@token}"
    elsif @authentication == :jwt
      req['authorization'] = "jwt #{@token}"
    end
    @last_request_time = Time.now.to_f
    res = Net::HTTP.start(uri.host, uri.port, **http_opts(uri)) {|http| http.request(req) }
  rescue => e # rescue all StandardErrors
    # server didn't respond
    log.warn "Net::HTTP.#{req.method.capitalize} raises exception: #{e.class}, '#{e.message}'"
    raise e if @raise_on_error
  else
     unless res and res.is_a?(Net::HTTPSuccess)
        res_summary = if res
                         "#{res.code} #{res.message} #{res.body}"
                      else
                         "res=nil"
                      end
        log.warn "failed to #{req.method} #{uri} (#{res_summary})"
     end #end unless
  end # end begin
end

#set_body(req, tag, time, record) ⇒ Object



75
76
77
78
79
80
81
82
# File 'lib/fluent/plugin/out_http.rb', line 75

def set_body(req, tag, time, record)
  if @serializer == :json
    set_json_body(req, record)
  else
    req.set_form_data(record)
  end
  req
end

#set_header(req, tag, time, record) ⇒ Object



84
85
86
# File 'lib/fluent/plugin/out_http.rb', line 84

def set_header(req, tag, time, record)
  req
end

#set_json_body(req, data) ⇒ Object



88
89
90
91
# File 'lib/fluent/plugin/out_http.rb', line 88

def set_json_body(req, data)
  req.body = Yajl.dump(data)
  req['Content-Type'] = 'application/json'
end

#shutdownObject



67
68
69
# File 'lib/fluent/plugin/out_http.rb', line 67

def shutdown
  super
end

#startObject



63
64
65
# File 'lib/fluent/plugin/out_http.rb', line 63

def start
  super
end

#write(chunk) ⇒ Object



172
173
174
175
176
177
178
# File 'lib/fluent/plugin/out_http.rb', line 172

def write(chunk)
  tag = chunk..tag
  @endpoint_url = extract_placeholders(@endpoint_url, chunk.)
  chunk.msgpack_each do |time, record|
    handle_record(tag, time, record)
  end
end