fluent-plugin-http-pull 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0033972f818bac5efaeeef71a73bfa68f98c0f37'
-  data.tar.gz: 3701de04b66bc1c3425f8671b7312c03863985e2
+  metadata.gz: 3de0f90b59370bd0d780479ad4326cb3f1cb7a4d
+  data.tar.gz: 5bea27b0f9b1c3fb5e3a593b40c9366f4a651e2a
 SHA512:
-  metadata.gz: d1ff1fd51040c7d42fe55572af3378674777a75808139ed0e9064779b2107f3c9bfb77fc61033ec85f31f581d69cedf53cccc0c2b2a764b06ebf99bcef76066d
-  data.tar.gz: 77751076212a33bd6bcbfda4c2ed5f07cddfe5901de043f0e4839eef075a017238f978a834416659eaf93c69102f9b8af497b2a8c6effb28897f71fa806df60d
+  metadata.gz: f832e52834daa32d1be42df2be0cd836526dadf149a5c9973cc44eb3225b16217ca1926037a2553fdd024450e0eed748c9c02fecb94e1e5f901cc7ab42c031fa
+  data.tar.gz: dca6fe53b789b3b6ed8eb277af015461b0216d2804bf9720244dccfbd8cb817386e46ee520f40c63af7f8dfe192743bbd744f623167e7591000c5a5e2d804f55

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -2,3 +2,5 @@ TODO
 *.swp
 .bundle
 Gemfile.lock
+coverage/**/*
+*.gem

data/README.md

@@ -1,7 +1,9 @@
 # fluent-plugin-http-pull
 
 [![Build Status](https://travis-ci.org/HatsuneMiku3939/fluent-plugin-http-pull.svg?branch=master)](https://travis-ci.org/HatsuneMiku3939/fluent-plugin-http-pull)
+[![Build status](https://ci.appveyor.com/api/projects/status/k91x4jyhahoo2it3?svg=true)](https://ci.appveyor.com/project/HatsuneMiku3939/fluent-plugin-http-pull)
 [![Gem Version](https://badge.fury.io/rb/fluent-plugin-http-pull.svg)](https://badge.fury.io/rb/fluent-plugin-http-pull)
+[![Coverage Status](https://coveralls.io/repos/github/HatsuneMiku3939/fluent-plugin-http-pull/badge.svg?branch=master)](https://coveralls.io/github/HatsuneMiku3939/fluent-plugin-http-pull?branch=master)
 
 
 [Fluentd](http://fluentd.org/) input plugin to pull log from rest api.
@@ -41,6 +43,7 @@ $ bundle
   url http://www.google.com
   interval 1s
 
+  format none
   status_only true
 </source>
 
@@ -68,6 +71,8 @@ $ bundle
   tag fluentd.status
   url http://localhost:24220/api/plugins.json
   interval 1s
+
+  format json
 </source>
 
 <match fluentd.status>
@@ -89,6 +94,8 @@ $ bundle
   tag es.cluster.health
   url http://localhost:9200/_cluster/health
   interval 1s
+
+  format json
 </source>
 
 <match es.cluster.health>
@@ -115,13 +122,22 @@ The url of remote server.
 
 The interval time between periodic request.
 
+### format (required)
+
+The format of the response body. Due to limitation of current implement it is
+always required regardless `status_only` option.
+
+`http_pull` uses parse plugin to parse the response body. See
+[parser article](https://docs.fluentd.org/v0.12/articles/parser-plugin-overview)
+for more detail.
+
 ### status_only (bool) (optional, default: false)
 
-If atatus_only is true, body is not parsed.
+If status_only is true, body is not parsed.
 
-### timeout (integer) (optional, default: 10)
+### timeout (time) (optional, default: 10s)
 
-Timeout second of each request.
+The timeout of each request.
 
 ## In case of remote error
 

data/appveyor.yml

@@ -0,0 +1,23 @@
+version: '{build}'
+
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - "%devkit%\\devkitvars.bat"
+  - ruby --version
+  - gem --version
+  - bundle install
+
+build: off
+
+test_script:
+  - bundle exec rake test
+
+branches:
+  only:
+    - master
+
+# https://www.appveyor.com/docs/installed-software/#ruby
+environment:
+  matrix:
+    - ruby_version: "23-x64"
+      devkit: C:\Ruby23-x64\DevKit

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.1"
+  spec.version = "0.3.0"
   spec.authors = ["filepang"]
   spec.email   = ["filepang@gmail.com"]
 
@@ -21,8 +21,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "simplecov", "~> 0.7"
   spec.add_development_dependency "test-unit", "~> 3.0"
   spec.add_development_dependency "test-unit-rr", "~> 1.0", "~> 1.0.2"
+  spec.add_development_dependency "coveralls", "~> 0.7"
 
   spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
   spec.add_runtime_dependency "rest-client", [">= 2.0.0", "< 3"]

data/lib/fluent/plugin/in_http_pull.rb

@@ -21,7 +21,7 @@ module Fluent
     class HttpPullInput < Fluent::Plugin::Input
       Fluent::Plugin.register_input("http_pull", self)
 
-      helpers :timer
+      helpers :timer, :parser, :compat_parameters
 
       def initialize
         super
@@ -29,17 +29,20 @@ module Fluent
 
       desc 'The tag of the event.'
       config_param :tag, :string
-      desc 'The uri of monitoring target'
+      desc 'The url of monitoring target'
       config_param :url, :string
       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
+      config_param :timeout, :time, default: 10
 
       def configure(conf)
+        compat_parameters_convert(conf, :parser)
         super
+
+        @parser = parser_create unless @status_only
       end
 
       def start
@@ -49,28 +52,35 @@ module Fluent
       end
 
       def on_timer
-        log = { "url" => @url }
+        record = { "url" => @url }
 
         begin
           res = RestClient::Request.execute(method: :get,
                                             url: @url,
                                             timeout: @timeout)
-          log["status"] = res.code
-          log["body"] = res.body
+          record["status"] = res.code
+          record["body"] = res.body
         rescue StandardError => err
           if err.respond_to? :http_code
-            log["status"] = err.http_code || 0
+            record["status"] = err.http_code || 0
           else
-            log["status"] = 0
+            record["status"] = 0
           end
 
-          log["error"] = err.message
+          record["error"] = err.message
         end
 
-        log["message"] = JSON.parse(log["body"]) if !@status_only && log["body"] != nil
-        log.delete("body")
+        record_time = Engine.now
+
+        if !@status_only && record["body"] != nil
+          @parser.parse(record["body"]) do |time, message|
+            record["message"] = message
+            record_time = time
+          end
+        end
 
-        router.emit(@tag, Engine.now, log)
+        record.delete("body")
+        router.emit(@tag, record_time, record)
       end
 
       def shutdown

data/test/helper.rb

@@ -1,3 +1,18 @@
+# simplecov must be loaded before any of target code
+require 'simplecov'
+require 'coveralls'
+Coveralls.wear!
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+])
+
+SimpleCov.start do
+  add_filter '/test/'
+end
+
+# load our target code
 $LOAD_PATH.unshift(File.expand_path("../../", __FILE__))
 require "test-unit"
 require "fluent/test"

data/test/plugin/test_in_http_pull.rb

@@ -12,7 +12,9 @@ class HttpPullInputTest < Test::Unit::TestCase
     TEST_DEFAULT_VALUE_CONFIG = %[
       tag test
       url http://127.0.0.1
+
       interval 3s
+      format json
     ]
 
     test 'status_only' do
@@ -37,6 +39,7 @@ class HttpPullInputTest < Test::Unit::TestCase
       timeout 10
 
       interval 3s
+      format none
       status_only true
     ]
 
@@ -46,6 +49,7 @@ class HttpPullInputTest < Test::Unit::TestCase
       timeout 10
 
       interval 5s
+      format json
     ]
 
     setup do
@@ -99,7 +103,9 @@ class HttpPullInputTest < Test::Unit::TestCase
     TEST_REFUSED_CONFIG = %[
       tag test
       url http://127.0.0.1:5927
-      interval 1
+      interval 1s
+
+      format json
     ]
     test "connection refused by remote" do
       d = create_driver TEST_REFUSED_CONFIG
@@ -126,9 +132,10 @@ class HttpPullInputTest < Test::Unit::TestCase
     TEST_TIMEOUT_FAIL_CONFIG = %[
       tag test
       url http://127.0.0.1
-      timeout 2
+      timeout 2s
 
-      interval 3
+      interval 3s
+      format json
     ]
 
     setup do
@@ -145,6 +152,7 @@ class HttpPullInputTest < Test::Unit::TestCase
     test "timeout" do
       d = create_driver TEST_TIMEOUT_FAIL_CONFIG
       assert_equal("test", d.instance.tag)
+      assert_equal(2, d.instance.timeout)
 
       d.run(timeout: 5) do
         sleep 7

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-http-pull
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - filepang
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: fluentd
   requirement: !ruby/object:Gem::Requirement
@@ -105,12 +133,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- appveyor.yml
 - fluent-plugin-http-pull.gemspec
 - lib/fluent/plugin/in_http_pull.rb
 - test/helper.rb