fluent-plugin-http-pull 0.2.0.pre → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 198fe9ad32356188705d13ad28b5587e956a9dae
-  data.tar.gz: 1bd9d9eb636748fbd24e5ea58b687138990d3021
+  metadata.gz: e57e28927445599a7804fccaf99431766cc812f4
+  data.tar.gz: dd25e97f2e55ff1a7f6ab4f4ef857b7ad4d6bc53
 SHA512:
-  metadata.gz: d28286e0838a18b75954d315beea25d9da6831fff29b28d2ad7d5471505e7e758ceff63e5dc85dbd7cf2069325bb0692582c7a7d0ec7e07561a49d43d22faf37
-  data.tar.gz: 55fe7c398310a9fbc4596a57753a43e3970a8c5091507396bcda160e3765a4e7c223a5f333e2b5d4e94e7b09df08505e18f0fd628bc7717892c207b01a47151d
+  metadata.gz: '08788a78bfec1da171d1781a866974ffce3066dc82ab72a34fed00171d1ead7fb8429856fe468a1ca0c11e3f2719c4de75e9a414e77b78e81df0b28c35387a20'
+  data.tar.gz: 5073957aa4e3ebe5f19c39d33a08eded5fb138cc71649ceb6b51159ac883ee32c8ad79f8797d469ac9431521b5a4764c48eb8d22a5545c6da9369cec35169a6b

data/.gitignore

@@ -0,0 +1,4 @@
+TODO
+*.swp
+.bundle
+Gemfile.lock

data/README.md

@@ -39,7 +39,7 @@ $ bundle
 
   tag test
   url http://www.google.com
-  interval 1
+  interval 1s
 
   status_only true
 </source>
@@ -67,7 +67,7 @@ $ bundle
 
   tag fluentd.status
   url http://localhost:24220/api/plugins.json
-  interval 1
+  interval 1s
 </source>
 
 <match fluentd.status>
@@ -88,7 +88,7 @@ $ bundle
 
   tag es.cluster.health
   url http://localhost:9200/_cluster/health
-  interval 1
+  interval 1s
 </source>
 
 <match es.cluster.health>
@@ -111,14 +111,18 @@ The tag of the event.
 
 The url of remote server.
 
-### interval (integer) (required)
+### interval (time) (required)
 
-The second interval time between periodic request.
+The interval time between periodic request.
 
 ### status_only (bool) (optional, default: false)
 
 If atatus_only is true, body is not parsed.
 
+### timeout (integer) (optional, default: 10)
+
+Timeout second of each request.
+
 ## In case of remote error
 
 ### Can receive response from remote

data/fluent-plugin-http-pull.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name    = "fluent-plugin-http-pull"
-  spec.version = "0.2.0.pre"
+  spec.version = "0.2.0"
   spec.authors = ["filepang"]
   spec.email   = ["filepang@gmail.com"]
 

data/lib/fluent/plugin/in_http_pull.rb

@@ -21,62 +21,60 @@ module Fluent
     class HttpPullInput < Fluent::Plugin::Input
       Fluent::Plugin.register_input("http_pull", self)
 
+      helpers :timer
+
+      def initialize
+        super
+      end
+
       desc 'The tag of the event.'
       config_param :tag, :string
-
       desc 'The uri of monitoring target'
       config_param :url, :string
-
-      desc 'The second interval time between periodic request'
-      config_param :interval, :integer
-
+      desc 'The interval time between periodic request'
+      config_param :interval, :time
       desc 'status_only'
       config_param :status_only, :bool, default: false
+      desc 'timeout second of each request'
+      config_param :timeout, :integer, default: 10
 
       def configure(conf)
         super
-
-        @shutdown = false
       end
 
       def start
-        @thread = Thread.new(&method(:run))
-      end
-
-      def run
-        while !@shutdown
-          ts = Time.now.to_f
+        super
 
-          log = { "url" => @url }
+        timer_execute(:in_http_pull, @interval, &method(:on_timer))
+      end
 
-          begin
-            res = RestClient.get(@url)
-            log["status"] = res.code
-            log["body"] = res.body
-          rescue RestClient::ExceptionWithResponse => err
+      def on_timer
+        log = { "url" => @url }
+
+        begin
+          res = RestClient::Request.execute(method: :get,
+                                            url: @url,
+                                            timeout: @timeout)
+          log["status"] = res.code
+          log["body"] = res.body
+        rescue StandardError => err
+          if err.respond_to? :code
             log["status"] = err.code
-            log["error"] = err.message
-          rescue Exception => err
+          else
             log["status"] = 0
-            log["error"] = err.message
           end
 
-          log["message"] = JSON.parse(log["body"]) if !@status_only && log["body"] != nil
-          log.delete("body")
-
-          router.emit(@tag, Engine.now, log)
+          log["error"] = err.message
+        end
 
-          te = Time.now.to_f
-          delay = @interval - (te - ts)
-          delay = delay > 0 ? delay : 0
+        log["message"] = JSON.parse(log["body"]) if !@status_only && log["body"] != nil
+        log.delete("body")
 
-          sleep delay
-        end
+        router.emit(@tag, Engine.now, log)
       end
 
       def shutdown
-        @shutdown = true
-        @thread.join if @thread
+        super
       end
 
     end

data/test/plugin/test_in_http_pull.rb

@@ -4,43 +4,73 @@ require "fluent/plugin/in_http_pull.rb"
 require 'ostruct'
 
 class HttpPullInputTest < Test::Unit::TestCase
-  TEST_INTERVAL_3_CONFIG = %[
-    tag test
-    url http://127.0.0.1
+  setup do
+    Fluent::Test.setup
+  end
 
-    interval 3
-    status_only true
-  ]
+  sub_test_case "default value of each options" do
+    TEST_DEFAULT_VALUE_CONFIG = %[
+      tag test
+      url http://127.0.0.1
+      interval 3s
+    ]
 
-  TEST_INTERVAL_5_CONFIG = %[
-    tag test
-    url http://127.0.0.1
+    test 'status_only' do
+      d = create_driver TEST_DEFAULT_VALUE_CONFIG
+      assert_equal("test", d.instance.tag)
 
-    interval 5
-  ]
+      assert_equal(false, d.instance.status_only)
+    end
 
-  setup do
-    Fluent::Test.setup
+    test 'timeout' do
+      d = create_driver TEST_DEFAULT_VALUE_CONFIG
+      assert_equal("test", d.instance.tag)
+
+      assert_equal(10, d.instance.timeout)
+    end
   end
 
   sub_test_case "success case with status only" do
+    TEST_INTERVAL_3_CONFIG = %[
+      tag test
+      url http://127.0.0.1
+      timeout 10
+
+      interval 3s
+      status_only true
+    ]
+
+    TEST_INTERVAL_5_CONFIG = %[
+      tag test
+      url http://127.0.0.1
+      timeout 10
+
+      interval 5s
+    ]
+
     setup do
-      mock(RestClient).get("http://127.0.0.1").times(2) do
-        OpenStruct.new({code: 200, body: '{"status": "OK"}'})
-      end
+      mock(RestClient::Request).
+        execute(method: :get,
+                url: "http://127.0.0.1",
+                timeout: 10).
+        times(2) do
+          OpenStruct.new({code: 200, body: '{"status": "OK"}'})
+        end
     end
 
     test 'interval 3 with status_only' do
       d = create_driver TEST_INTERVAL_3_CONFIG
-      assert_equal "test", d.instance.tag
+      assert_equal("test", d.instance.tag)
+      assert_equal(3, d.instance.interval)
 
       d.run(timeout: 5) do
-        sleep 5
+        sleep 7
       end
-      assert_equal 2, d.events.size
+      assert_equal(2, d.events.size)
 
       d.events.each do |tag, time, record|
         assert_equal("test", tag)
+
         assert_equal({"url"=>"http://127.0.0.1","status"=>200}, record)
         assert(time.is_a?(Fluent::EventTime))
       end
@@ -48,15 +78,17 @@ class HttpPullInputTest < Test::Unit::TestCase
 
     test 'interval 5' do
       d = create_driver TEST_INTERVAL_5_CONFIG
-      assert_equal "test", d.instance.tag
+      assert_equal("test", d.instance.tag)
+      assert_equal(5, d.instance.interval)
 
       d.run(timeout: 7) do
-        sleep 7
+        sleep 11
       end
-      assert_equal 2, d.events.size
+      assert_equal(2, d.events.size)
 
       d.events.each do |tag, time, record|
         assert_equal("test", tag)
+
         assert_equal({"url"=>"http://127.0.0.1","status"=>200, "message"=>{"status"=>"OK"}}, record)
         assert(time.is_a?(Fluent::EventTime))
       end
@@ -71,14 +103,62 @@ class HttpPullInputTest < Test::Unit::TestCase
     ]
     test "connection refused by remote" do
       d = create_driver TEST_REFUSED_CONFIG
-      d.run(timeout: 2) { sleep 3 }
+      assert_equal("test", d.instance.tag)
+
+      d.run(timeout: 2) do
+        sleep 3
+      end
 
-      assert_equal 3, d.events.size
+      assert_equal(3, d.events.size)
       d.events.each do |tag, time, record|
         assert_equal("test", tag)
+
         assert_equal("http://127.0.0.1:5927", record["url"])
+        assert(time.is_a?(Fluent::EventTime))
+
         assert_equal(0, record["status"])
+        assert_not_nil(record["error"])
+      end
+    end
+  end
+
+  sub_test_case "fail when remote timeout" do
+    TEST_TIMEOUT_FAIL_CONFIG = %[
+      tag test
+      url http://127.0.0.1
+      timeout 2
+
+      interval 3
+    ]
+
+    setup do
+      mock(RestClient::Request).
+        execute(method: :get,
+                url: "http://127.0.0.1",
+                timeout: 2).
+        times(2) do
+          sleep 2
+          raise RestClient::Exceptions::Timeout.new
+        end
+    end
+
+    test "timeout" do
+      d = create_driver TEST_TIMEOUT_FAIL_CONFIG
+      assert_equal("test", d.instance.tag)
+
+      d.run(timeout: 5) do
+        sleep 7
+      end
+      assert_equal(2, d.events.size)
+
+      d.events.each do |tag, time, record|
+        assert_equal("test", tag)
+
+        assert_equal("http://127.0.0.1", record["url"])
         assert(time.is_a?(Fluent::EventTime))
+
+        assert_equal(0, record["status"])
+        assert_not_nil(record["error"])
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-http-pull
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre
+  version: 0.2.0
 platform: ruby
 authors:
 - filepang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-29 00:00:00.000000000 Z
+date: 2017-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -105,6 +105,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - ".travis.yml"
 - Gemfile
 - LICENSE
@@ -129,9 +130,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.2