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)


48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/fluent/plugin/out_http.rb', line 48

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

  serializers = [:json, :form]
  @serializer = if serializers.include? @serializer.intern
                  @serializer.intern
                else
                  :form
                end

  http_methods = [:get, :put, :post, :delete]
  @http_method = if http_methods.include? @http_method.intern
                  @http_method.intern
                else
                  :post
                end

  @auth = case @authentication
          when 'basic' then :basic
          else
            :none
          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



112
113
114
115
116
117
118
119
# File 'lib/fluent/plugin/out_http.rb', line 112

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



169
170
171
# File 'lib/fluent/plugin/out_http.rb', line 169

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

#format_url(tag, time, record) ⇒ Object



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

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

#formatted_to_msgpack_binary?Boolean

Returns:

  • (Boolean)


173
174
175
# File 'lib/fluent/plugin/out_http.rb', line 173

def formatted_to_msgpack_binary?
  true
end

#handle_record(tag, time, record) ⇒ Object

end send_request



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

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

#http_opts(uri) ⇒ Object



121
122
123
124
125
126
127
# File 'lib/fluent/plugin/out_http.rb', line 121

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)


177
178
179
# File 'lib/fluent/plugin/out_http.rb', line 177

def multi_workers_ready?
  true
end

#prefer_buffered_processingObject



165
166
167
# File 'lib/fluent/plugin/out_http.rb', line 165

def prefer_buffered_processing
  @buffered
end

#process(tag, es) ⇒ Object



181
182
183
184
185
# File 'lib/fluent/plugin/out_http.rb', line 181

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

#send_request(req, uri) ⇒ Object



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
# File 'lib/fluent/plugin/out_http.rb', line 129

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 @auth and @auth == :basic
      req.basic_auth(@username, @password)
    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



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

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



103
104
105
# File 'lib/fluent/plugin/out_http.rb', line 103

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

#set_json_body(req, data) ⇒ Object



107
108
109
110
# File 'lib/fluent/plugin/out_http.rb', line 107

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

#shutdownObject



86
87
88
# File 'lib/fluent/plugin/out_http.rb', line 86

def shutdown
  super
end

#startObject



82
83
84
# File 'lib/fluent/plugin/out_http.rb', line 82

def start
  super
end

#write(chunk) ⇒ Object



187
188
189
190
191
192
# File 'lib/fluent/plugin/out_http.rb', line 187

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