fluent-plugin-out-http 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3880fd774a40aecbe2a66d70b82f1839262ac6b788a9beded2cd5209a272c9eb
-  data.tar.gz: f4edd620701fdba356062650b67fb80b45308d240d49240b291447cea10788d8
+  metadata.gz: f6816aa0fc629f6b264dce12602cdd716577350c2e65c05c6cb1d97c51b95f34
+  data.tar.gz: 3db9d8d0c757b307f53abb6fcc4e84d7dd3f4c84232409fc075c225821a38300
 SHA512:
-  metadata.gz: 7596426626b5c0c419c5851075f9727b998c10a8ddfc65304ed9580a461d5b0fabb626de0dd19ff8dd951174afb8ee749e65127df08dafcb6b610843226948a0
-  data.tar.gz: 03bfe5f1164a42accc81b1fc2a0c746ad80b468d70e0b313994e86d5b2765ffad11cf4f14aecc51bc7e4412c46999dd88c9fe251053b2140627555fa3c94d0ef
+  metadata.gz: 16c16745835465635955c5d86d52c5c0be5d3c887002db36e74206f12059b514be37ed99003ef8c86f508f316984cad27f9c71a826511d089c977fce5ef0b7d8
+  data.tar.gz: 2322d4d8ffc7a79abcb3905fd36486e1f939ed0b36a425876faf43e9fd9d8bd1ca7b0bb2eb0a8d5d6f71859fb94003fcd9a18c7647e64c5a76d69e624afd85e2

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+### 1.1.2
+* Added custom headers feature
+
 ## 1.1.1
 * Added plain text transport capability
 * Added specify cacert file for ssl verify

data/README.md

@@ -19,6 +19,7 @@ A generic [fluentd][1] output plugin for sending logs to an HTTP endpoint.
       buffered        true   # default: false. Switch non-buffered/buffered mode
       cacert_file     /etc/ssl/endpoint1.cert # default: ''
       token           tokent # default: ''
+      custom_headers  {"token":"arbitrary"} # default: nil
     </match>
 
 ## Usage notes

data/fluent-plugin-out-http.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name          = "fluent-plugin-out-http"
-  gem.version       = "1.1.1"
+  gem.version       = "1.1.2"
   gem.authors       = ["Marica Odagaki"]
   gem.email         = ["ento.entotto@gmail.com"]
   gem.summary       = %q{A generic Fluentd output plugin to send logs to an HTTP endpoint}

data/lib/fluent/plugin/out_http.rb

@@ -36,6 +36,9 @@ class Fluent::Plugin::HTTPOutput < Fluent::Plugin::Output
   # ca file to use for https request
   config_param :cacert_file, :string, :default => ''
 
+  # custom headers
+  config_param :custom_headers, :hash, :default => nil
+
   # 'none' | 'basic' | 'jwt' | 'bearer'
   config_param :authentication, :enum, list: [:none, :basic, :jwt, :bearer],  :default => :none
   config_param :username, :string, :default => ''
@@ -88,7 +91,14 @@ class Fluent::Plugin::HTTPOutput < Fluent::Plugin::Output
   end
 
   def set_header(req, tag, time, record)
-    req
+    if @custom_headers
+      @custom_headers.each do |k,v|
+        req[k] = v
+      end
+      req
+    else
+      req
+    end
   end
 
   def set_json_body(req, data)
@@ -119,6 +129,10 @@ class Fluent::Plugin::HTTPOutput < Fluent::Plugin::Output
       opts
   end
 
+  def proxies
+    ENV['HTTPS_PROXY'] || ENV['HTTP_PROXY'] || ENV['http_proxy'] || ENV['https_proxy']
+  end
+
   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)
@@ -137,7 +151,17 @@ class Fluent::Plugin::HTTPOutput < Fluent::Plugin::Output
         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) }
+
+      if proxy = proxies
+        proxy_uri = URI.parse(proxy)
+
+        res = Net::HTTP.start(uri.host, uri.port,
+                              proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password,
+                              **http_opts(uri)) {|http| http.request(req) }
+      else
+        res = Net::HTTP.start(uri.host, uri.port, **http_opts(uri)) {|http| http.request(req) }
+      end
+
     rescue => e # rescue all StandardErrors
       # server didn't respond
       log.warn "Net::HTTP.#{req.method.capitalize} raises exception: #{e.class}, '#{e.message}'"

data/test/plugin/test_out_http.rb

@@ -56,6 +56,7 @@ class HTTPOutputTestBase < Test::Unit::TestCase
     @prohibited = 0
     @requests = 0
     @auth = false
+    @headers = {}
     @dummy_server_thread = Thread.new do
       srv = WEBrick::HTTPServer.new(self.class.server_config)
       begin
@@ -67,6 +68,9 @@ class HTTPOutputTestBase < Test::Unit::TestCase
             res.body = 'request method mismatch'
             next
           end
+          req.each do |key, value|
+            @headers[key] = value
+          end
           if @auth and req.header['authorization'][0] == 'Basic YWxpY2U6c2VjcmV0IQ==' # pattern of user='alice' passwd='secret!'
             # ok, authorized
           # pattern of bear #{Base64.encode64('secret token!')}
@@ -280,6 +284,34 @@ class HTTPOutputTest < HTTPOutputTestBase
     assert_equal 2, @posts.size
   end
 
+  def test_emit_form_with_custom_headers
+    d = create_driver CONFIG + %[custom_headers {"key":"custom","token":"arbitrary"}]
+    d.run(default_tag: 'test.metrics') do
+      d.feed({ 'field1' => 50, 'field2' => 20, 'field3' => 10, 'otherfield' => 1, 'binary' => "\xe3\x81\x82".force_encoding("ascii-8bit") })
+    end
+
+    assert_true @headers.has_key?("key")
+    assert_equal "custom", @headers["key"]
+    assert_true @headers.has_key?("token")
+    assert_equal "arbitrary", @headers["token"]
+
+    assert_equal 1, @posts.size
+    record = @posts[0]
+
+    assert_equal '50', record[:form]['field1']
+    assert_equal '20', record[:form]['field2']
+    assert_equal '10', record[:form]['field3']
+    assert_equal '1', record[:form]['otherfield']
+    assert_equal URI.encode_www_form_component("あ").upcase, record[:form]['binary'].upcase
+    assert_nil record[:auth]
+
+    d.run(default_tag: 'test.metrics') do
+      d.feed({ 'field1' => 50, 'field2' => 20, 'field3' => 10, 'otherfield' => 1 })
+    end
+
+    assert_equal 2, @posts.size
+  end
+
   class BufferedEmitTest < self
     def test_emit_form
       d = create_driver CONFIG + %[buffered true]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-out-http
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Marica Odagaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-08 00:00:00.000000000 Z
+date: 2018-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby