fluent-plugin-http-client 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68f891862d8ed0d65bee31528b8ea940360140f5f364c00b5ffb0e8d5028a00e
-  data.tar.gz: c46abc77c9c14ef2c8d882d87ad5e9ed6fa44526a8285149d39d61bf9c6f5f63
+  metadata.gz: a1a740cbf45e549d3f0d908bddfff2e987529b5d2e5f35931e60253038d9a974
+  data.tar.gz: cdeca75cc223b3c0bde3b579a1e744902d59894a1a8831097be26a2669f83e14
 SHA512:
-  metadata.gz: 7fffd4e41722471f9008c51295a0cb37ec00983288c2f30703ba66addbdfb177064da9bf224902a3aa1792f8b8ec124aea6fe4cd63cf71b0069c9afd7b18dabd
-  data.tar.gz: b5e58dadf0a8de160a46558840bad56f606d29caa63b27e8dd08d8739376962f950fe56de7481b18e9996289349e7aaf287d9eb72225be320cce9ab2f025c42f
+  metadata.gz: f06dfa20783659d082f465e166c558698395bd9633902d45635f3da307f80d988a306f45c8a47bb3c4b84b2c1d4b6a0917bb80ed93f84387aa0c3e3bd035ef46
+  data.tar.gz: b2355771af9812c508f27a661a7c5f18c635954132ce1e80cdaa896f3df50feb6f24cd1c9d42062643e727239bb326334a6490c2b31011fb2d14754a02f056f0

data/.rubocop.yml

@@ -1,9 +1,14 @@
-require:
+---
+
+plugins:
   - rubocop-rake
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 3.0
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
 
 Layout/LineLength:
   Max: 120
@@ -11,19 +16,15 @@ Layout/LineLength:
 Metrics/BlockLength:
   Exclude:
     - fluent-plugin-http-client.gemspec
-    - 'test/**/*.rb'
+    - test/**/*.rb
 
 Metrics/ClassLength:
+  Max: 150
   Exclude:
-    - 'test/**/*.rb'
+    - test/**/*.rb
 
 Metrics/MethodLength:
   Max: 20
 
-# Style/StringLiterals:
-#   Enabled: true
-#   EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
+Style/Documentation:
+  Enabled: false

data/Rakefile

@@ -1,19 +1,29 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
 require 'rake/testtask'
-require 'bump/tasks'
-require 'rubocop/rake_task'
 
 Rake::TestTask.new(:test) do |t|
   t.libs.push('lib', 'test')
-  t.test_files = FileList['test/**/test_*.rb']
-  t.verbose = true
-  t.warning = true
+
+  t.test_files = if ENV['TEST_FILE']
+                   FileList["#{ENV['TEST_FILE']}*",
+                            "test/**/#{ENV['TEST_FILE']}*"]
+                 else
+                   FileList['test/**/test_*.rb', 'test/**/*_test.rb']
+                 end
+  t.verbose = ENV.fetch('VERBOSE', false)
+  t.warning = ENV.fetch('WARNING', false)
 end
 
+require 'rubocop/rake_task'
+
 RuboCop::RakeTask.new do |task|
-  task.requires << 'rubocop-rake'
+  # task.plugins << 'rubocop-rake'
 end
 
+require 'bump/tasks'
+
 task default: %i[test rubocop]

data/fluent-plugin-http-client.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://gitlab.com/ttych/fluent-plugin-http-client'
   spec.license       = 'Apache-2.0'
 
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.0.0')
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
@@ -34,19 +34,22 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bump', '~> 0.10.0'
-  spec.add_development_dependency 'bundler', '~> 2.1.4'
-  spec.add_development_dependency 'byebug', '~> 11.1', '>= 11.1.1'
-  spec.add_development_dependency 'flay', '~> 2.13'
-  spec.add_development_dependency 'flog', '~> 4.6', '>= 4.6.6'
-  spec.add_development_dependency 'rake', '~> 13.0.1'
-  spec.add_development_dependency 'reek', '~> 6.1', '>= 6.1.0'
-  spec.add_development_dependency 'rubocop', '~> 1.33', '>= 1.33.0'
-  spec.add_development_dependency 'rubocop-rake', '~> 0.6.0'
-  spec.add_development_dependency 'simplecov', '~> 0.21.2'
-  spec.add_development_dependency 'test-unit', '~> 3.3.4'
-
-  spec.add_runtime_dependency 'faraday', '~> 2.5', '>= 2.0.1'
-  spec.add_runtime_dependency 'faraday-retry', '~> 2.0'
-  spec.add_runtime_dependency 'fluentd', ['>= 0.14.10', '< 2']
+  spec.add_development_dependency 'bump', '~> 0.10'
+  spec.add_development_dependency 'bundler', '~> 2.6', '>= 2.6.6'
+  spec.add_development_dependency 'byebug', '~> 12.0'
+  spec.add_development_dependency 'flay', '~> 2.13', '>= 2.13.3'
+  spec.add_development_dependency 'flog', '~> 4.8'
+  spec.add_development_dependency 'mocha', '~> 2.7', '>= 2.7.1'
+  spec.add_development_dependency 'rake', '~> 13.2', '>= 13.2.1'
+  spec.add_development_dependency 'reek', '~> 6.5'
+  spec.add_development_dependency 'rubocop', '~> 1.75', '>= 1.75.1'
+  spec.add_development_dependency 'rubocop-rake', '~> 0.7', '>= 0.7.1'
+  spec.add_development_dependency 'simplecov', '~> 0.22'
+  spec.add_development_dependency 'test-unit', '~> 3.6', '>= 3.6.7'
+  spec.add_development_dependency 'timecop', '~> 0.9', '>= 0.9.10'
+  spec.add_development_dependency 'webrick', '~> 1.9', '>= 1.9.1'
+
+  spec.add_dependency 'faraday', '~> 2.12', '>= 2.12.2'
+  spec.add_dependency 'faraday-retry', '~> 2.2', '>= 2.2.1'
+  spec.add_dependency 'fluentd', ['>= 0.14.10', '< 2']
 end

data/lib/fluent/plugin/http_client/version.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Fluent
   module Plugin
     module HttpClient
-      VERSION = "0.2.1"
+      VERSION = '1.0.0'
     end
   end
 end

data/lib/fluent/plugin/in_http_client.rb

@@ -27,98 +27,152 @@ module Fluent
     class HttpClientInput < Fluent::Plugin::Input
       Fluent::Plugin.register_input('http_client', self)
 
+      DEFAULT_INTERVAL = 60
+      DEFAULT_HTTP_METHOD = :get
       DEFAULT_USER_AGENT = 'fluent-plugin-http-client'
+      DEFAULT_TIMEOUT = 5
 
       helpers :timer, :compat_parameters
 
-      # behavior
-      desc 'The interval time between request execution'
-      config_param :interval, :time, default: 30
       desc 'The tag of the event is emitted on'
       config_param :tag, :string
-      # http
+      desc 'The tag of the event is emitted on'
+      config_param :tag_status, :string, default: nil
+
+      desc 'The interval time between request execution'
+      config_param :interval, :time, default: DEFAULT_INTERVAL
+
       desc 'The url to request'
       config_param :url, :string
       desc 'The http method for each request'
-      config_param :http_method, :enum, list: %i[get post delete], default: :get
+      config_param :http_method, :enum, list: %i[get post delete put patch head options], default: DEFAULT_HTTP_METHOD
       desc 'The timeout in second for each request'
-      config_param :timeout, :integer, default: 5
+      config_param :timeout, :integer, default: DEFAULT_TIMEOUT
       desc 'verify_ssl'
       config_param :verify_ssl, :bool, default: true
       desc 'The absolute path of directory where ca_file stored'
       config_param :ca_path, :string, default: nil
       desc 'The absolute path of ca_file'
       config_param :ca_file, :string, default: nil
+      desc 'The user agent string of request'
+      config_param :user_agent, :string, default: DEFAULT_USER_AGENT
+      desc 'user of basic auth'
+      config_param :user, :string, default: nil
+      desc 'password of basic auth'
+      config_param :password, :string, default: nil, secret: true
+
+      desc 'enable status events'
+      config_param :enable_status, :bool, default: true
+      desc 'status events with response data'
+      config_param :status_with_response_data, :bool, default: true
+      desc 'enable response data events'
+      config_param :enable_response_data, :bool, default: false
+      desc 'split response data when array'
+      config_param :split_response_data, :bool, default: false
+      desc 'enable response data events on failure'
+      config_param :enable_failed_response_data, :bool, default: false
 
       def configure(conf)
         compat_parameters_convert(conf, :parser)
 
         super
 
+        check_mandatory_params
+        configure_tag
         configure_client
       end
 
       def start
         super
 
-        timer_execute(:in_http_client_timer, @interval, &method(:on_timer_request))
+        timer_execute(:in_http_client_timer, interval, &method(:request))
       end
 
       private
 
+      def check_mandatory_params
+        raise Fluent::ConfigError, 'url should not be empty' if url.nil? || url.empty?
+
+        true
+      end
+
+      def configure_tag
+        @tag_status ||= @tag
+
+        raise Fluent::ConfigError, 'tag or tag_status should be defined' if enable_status && !tag_status
+        raise Fluent::ConfigError, 'tag should be defined' if enable_response_data && !tag
+
+        true
+      end
+
       def configure_client
         @client = Faraday.new(client_options) do |f|
           f.request :retry
+          f.request :authorization, :basic, user, password if user && password
           f.response :json
         end
       end
 
       def client_options
         {
-          url: @url,
-          headers: { 'User-Agent' => @user_agent },
-          request: { timeout: @timeout },
-          ssl: { ca_file: @ca_file,
-                 ca_path: @ca_path,
-                 verify: @verify_ssl }
+          url: url,
+          headers: { 'User-Agent' => user_agent },
+          request: { timeout: timeout },
+          ssl: { ca_file: ca_file,
+                 ca_path: ca_path,
+                 verify: verify_ssl }
         }
       end
 
-      def headers
-        { 'User-Agent' => DEFAULT_USER_AGENT }
+      def request
+        request_time = Engine.now
+        response = send_request
+        emit_status(request_time, response)
+        emit_response(request_time, response)
+      rescue StandardError => e
+        emit_exception(request_time, e)
       end
 
-      def on_timer_request
-        base_record = {
-          request_url: @url
-        }
-        begin
-          record = do_request
-        rescue StandardError => e
-          record = parse_exception(e)
-        end
-
-        record_time = Engine.now
-        record.update(base_record)
-        router.emit(tag, record_time, record)
+      def send_request
+        @client.send(http_method)
       end
 
-      def do_request
-        response = @client.send(@http_method)
+      def emit_status(time, response)
+        return unless enable_status
 
-        {
+        record = {
+          'request_url' => url,
           'status' => response.status,
-          'success' => response.success?,
-          'response' => response.body
+          'success' => response.success?
         }
+        record.update('response' => response.body) if status_with_response_data
+
+        router.emit(tag_status, time, record)
       end
 
-      def parse_exception(exception)
-        {
+      def emit_response(time, response)
+        return unless enable_response_data
+        return if !response.success? && !enable_failed_response_data
+
+        record = response.body
+        if split_response_data && record.is_a?(Array)
+          record.each { |record_element| router.emit(tag, time, record_element) }
+        else
+          router.emit(tag, time, record)
+        end
+      end
+
+      def emit_exception(time, error)
+        return unless enable_status
+
+        record = {
+          'request_url' => url,
           'status' => -1,
           'success' => false,
-          'error' => exception.to_s
+          'error' => error.to_s
         }
+
+        router.emit(tag_status, time, record)
       end
     end
   end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-http-client
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Thomas Tych
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-25 00:00:00.000000000 Z
+date: 2025-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -16,48 +15,48 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.6
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 11.1.1
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 11.1.1
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: flay
   requirement: !ruby/object:Gem::Requirement
@@ -65,6 +64,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -72,156 +74,231 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.13.3
 - !ruby/object:Gem::Dependency
   name: flog
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '4.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.6.6
+        version: 2.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '2.7'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.6.6
+        version: 2.7.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: '13.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: '13.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.2.1
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: '6.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: '6.5'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.33'
+        version: '1.75'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.33.0
+        version: 1.75.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.33'
+        version: '1.75'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.33.0
+        version: 1.75.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.2
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.21.2
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.4
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.3.4
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.7
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.10
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.1
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.12'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.12.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.12'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: 2.12.2
 - !ruby/object:Gem::Dependency
   name: faraday-retry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
 - !ruby/object:Gem::Dependency
   name: fluentd
   requirement: !ruby/object:Gem::Requirement
@@ -251,7 +328,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -270,7 +346,6 @@ metadata:
   source_code_uri: https://gitlab.com/ttych/fluent-plugin-http-client
   changelog_uri: https://gitlab.com/ttych/fluent-plugin-http-client/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -278,15 +353,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.6.6
 specification_version: 4
 summary: http client for fluentd
 test_files: []

data/.ruby-version

@@ -1 +0,0 @@
-2.7.6