fluent-plugin-out-http 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1070709b043ea9772ddf71b806a2f7807775e7e8ebc19d1ba0408df37926f9e
-  data.tar.gz: d904c7394b6ae84450ad67f8aa0ea8dacfdc27f73d9e4bedb3b3f4d12bf58ccd
+  metadata.gz: 3ec10329a626597058faa33835bcc4b553d28595fc973353e5807f1ffbea4036
+  data.tar.gz: 6ee543bbd1835b69d9bd80cf1b13af9e9f39d3fcd83ee823425408607d8fc240
 SHA512:
-  metadata.gz: a5b7fab8ecd5bfa6b49e75aabf6c01b25d78a4f356c8275cdce5a8df996c688a3e648b040795a3487f5d9f7a0e9defc6c89ab49478d1c6216c05106a6b0dc152
-  data.tar.gz: 472f6517e9e46aff558e255256cc27851673bd50cfe015195b34419f4a5e0a77e96318208103992b96ea65e55dd8cb91ccd4c3d8728d1806acdd9abcd97f1efa
+  metadata.gz: 9dfb53ea8a4773adf2407646e34cb98c8d789d472220b066a90b51a325fea123a2f9af283c02f2fb304c0e0e3e0df67187d4883c936c8dcb329c90853d533fc6
+  data.tar.gz: 4bb782810c5f9c5bebf2b56c3be308809e6788d35211a814bdfb9b9e15628f866282ee49a9011d64c2682c0eed2bd6c1540d8d2ee63afad0405ef4f67aca86c9

data/.travis.yml

@@ -1,8 +1,9 @@
 rvm:
-  - 2.1
   - 2.2
   - 2.3
-  - 2.4.0
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
   - ruby-head
 
 os:
@@ -14,6 +15,9 @@ dist: trusty
 gemfile:
   - Gemfile
 
+before_install:
+  - gem update --system=2.7.8
+
 script: bundle exec rake test
 
 matrix:

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### 1.1.4
+* Add custom formatter feature
+* Tweak Travis CI tasks
+
 ### 1.1.3
 * Send query_string to endpoint_url
 

data/README.md

@@ -7,7 +7,7 @@ A generic [fluentd][1] output plugin for sending logs to an HTTP endpoint.
 ## Configuration options
 
     <match *>
-      type http
+      @type http
       endpoint_url    http://localhost.local/api/
       http_method     put    # default: post
       serializer      json   # default: form

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.3"
+  gem.version       = "1.1.4"
   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

@@ -6,9 +6,10 @@ require 'fluent/plugin/output'
 class Fluent::Plugin::HTTPOutput < Fluent::Plugin::Output
   Fluent::Plugin.register_output('http', self)
 
-  helpers :compat_parameters
+  helpers :compat_parameters, :formatter
 
   DEFAULT_BUFFER_TYPE = "memory"
+  DEFAULT_FORMATTER = "json"
 
   def initialize
     super
@@ -52,8 +53,12 @@ class Fluent::Plugin::HTTPOutput < Fluent::Plugin::Output
     config_set_default :chunk_keys, ['tag']
   end
 
+  config_section :format do
+    config_set_default :@type, DEFAULT_FORMATTER
+  end
+
   def configure(conf)
-    compat_parameters_convert(conf, :buffer)
+    compat_parameters_convert(conf, :buffer, :formatter)
     super
 
     @ssl_verify_mode = if @ssl_no_verify
@@ -65,6 +70,10 @@ class Fluent::Plugin::HTTPOutput < Fluent::Plugin::Output
     @ca_file = @cacert_file
     @last_request_time = nil
     raise Fluent::ConfigError, "'tag' in chunk_keys is required." if !@chunk_key_tag && @buffered
+
+    if @formatter_config = conf.elements('format').first
+      @formatter = formatter_create
+    end
   end
 
   def start
@@ -179,6 +188,9 @@ class Fluent::Plugin::HTTPOutput < Fluent::Plugin::Output
   end # end send_request
 
   def handle_record(tag, time, record)
+    if @formatter_config
+      record = @formatter.format(tag, time, record)
+    end
     req, uri = create_request(tag, time, record)
     send_request(req, uri)
   end

data/test/plugin/script/plugin/formatter_test.rb

@@ -0,0 +1,21 @@
+require 'fluent/plugin/formatter'
+
+module Fluent
+  module Plugin
+    class TestFormatter < Formatter
+      Fluent::Plugin.register_formatter('test', self)
+
+      def configure(conf)
+        super
+      end
+
+      def format(tag, time, record)
+        output = {
+          "wrapped" => true,
+          "record" => record
+        }
+        output
+      end
+    end
+  end
+end

data/test/plugin/test_out_http.rb

@@ -6,6 +6,7 @@ require 'fluent/test/http_output_test'
 require 'fluent/plugin/out_http'
 require 'fluent/test/driver/output'
 require 'fluent/test/helpers'
+require_relative "./script/plugin/formatter_test"
 
 module OS
   # ref. http://stackoverflow.com/questions/170956/how-can-i-find-which-operating-system-my-ruby-program-is-running-on
@@ -579,6 +580,46 @@ class HTTPOutputTest < HTTPOutputTestBase
     assert_equal 2, @prohibited
   end
 
+  class CustomFormatterTest < self
+    def test_new_config
+      config = Fluent::Config::Element.new(
+        'ROOT', '',
+        {"@type" => "http",
+         "endpoint_url" => "http://127.0.0.1:#{self.class.port}/api/",
+         "serializer" => "json"}, [
+          Fluent::Config::Element.new('format', '', {
+                                        "@type" => "test"
+                                      }, [])
+        ])
+      d = create_driver config
+      payload = {"field" => 1}
+      d.run(default_tag: 'test.metrics') do
+        d.feed(payload)
+      end
+
+      record = @posts[0]
+      expected = {"wrapped" => true, "record" => payload}
+      assert_equal expected, record[:json]
+    end
+
+    def test_legacy_config
+      config = %[
+        endpoint_url http://127.0.0.1:#{self.class.port}/api/
+        serializer json
+        format test
+      ]
+
+      d = create_driver config
+      payload = {"field" => 1}
+      d.run(default_tag: 'test.metrics') do
+        d.feed(payload)
+      end
+
+      record = @posts[0]
+      expected = {"wrapped" => true, "record" => payload}
+      assert_equal expected, record[:json]
+    end
+  end
 end
 
 class HTTPSOutputTest < HTTPOutputTestBase

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-out-http
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Marica Odagaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-05 00:00:00.000000000 Z
+date: 2019-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
@@ -104,6 +104,7 @@ files:
 - fluent-plugin-out-http.gemspec
 - lib/fluent/plugin/out_http.rb
 - lib/fluent/test/http_output_test.rb
+- test/plugin/script/plugin/formatter_test.rb
 - test/plugin/test_out_http.rb
 homepage: https://github.com/fluent-plugins-nursery/fluent-plugin-out-http
 licenses:
@@ -124,10 +125,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: A generic Fluentd output plugin to send logs to an HTTP endpoint
 test_files:
+- test/plugin/script/plugin/formatter_test.rb
 - test/plugin/test_out_http.rb