fluent-plugin-config_reloader 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bea4e93686ec8aa255f0c3ab478d87254447f749
+  data.tar.gz: 67a4cbb98f6797a8c2955bf5ce0c2a53d4999a79
+SHA512:
+  metadata.gz: b4dfd1712399776b69068037cad856b0e990a11fdf80cf9fbcd06e4e50de1b797cc69198b5ea194ba0a227cd9113a5e8234a30432436ab94f86b264ed88fc806
+  data.tar.gz: 70c397dc59d601bab9fae90c9435560a920eb2daa510d936ac5375efaa6dcbc378f179859c5e26ff9655ac69b3243bd12bcb392ddb2aa4f855e594394d79613b

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor
+

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,47 @@
+# fluent-plugin-config_reloader
+
+reload child plugin's config plugin.
+
+## Output Plugin
+
+```
+  config_file child.conf
+  reload_file reload.txt
+  reload_file_watch_interval 5
+```
+- config_file: child conf file path
+ - Require 1 `match` directive in this file
+- reload_file: reload file path(reload when touch this file)
+- reload_file_watch_interval (optional): reload file watch interval sec(default 1)
+
+## example
+
+```
+<match example.**>
+  type config_reloader
+  config_file conf/child.conf
+  reload_file reload.txt
+</match>
+```
+
+### conf/child.conf
+
+```
+<match>
+  type stdout
+</match>
+```
+
+### Use out_copy...
+
+```
+<store>
+  type copy
+  <store>
+    type stdout
+  </store>
+  <store>
+    type null
+  </store>
+</store>
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/fluent-plugin-config_reloader.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-config_reloader"
+  spec.version       = '0.0.1'
+  spec.authors       = ["bash0C7"]
+  spec.email         = ["koshiba+github@4038nullpointer.com"]
+  spec.description   = "Fluentd plugin to reload child plugin's config"
+  spec.summary       = "Fluentd plugin to reload child plugin's config"
+  spec.homepage      = "https://github.com/bash0C7/fluent-plugin-config_reloader"
+  spec.license       = "Ruby's"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "fluentd"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/lib/fluent/plugin/out_config_reloader.rb

@@ -0,0 +1,151 @@
+module Fluent
+  class Fluent::ConfigReloaderOutput < Fluent::MultiOutput
+    Fluent::Plugin.register_output('config_reloader', self)
+
+    config_param :config_file, :string
+    config_param :reload_file, :string
+    config_param :reload_file_watch_interval, :integer, :default => 1
+
+    class ReloadFileWatcher
+      require 'observer'
+      include ::Observable
+      
+      attr_reader :thread
+      
+      def self.create(observer, watch_file, interval)
+        obj = self.new
+        obj.add_observer(observer)
+        obj.watch watch_file, interval
+        
+        obj
+      end
+      
+      def watch watch_file, interval
+        mtime = Time.now
+
+        @thread = Thread.new do
+          loop do
+            if File.exists?(watch_file) && File.mtime(watch_file) > mtime
+              mtime = File.mtime(watch_file)
+            
+              changed
+              notify_observers
+            end
+            sleep interval
+          end
+        end
+      end
+    end
+ 
+    def initialize
+      super
+
+      @q = Queue.new
+    end
+ 
+    def outputs
+      [@output]
+    end
+ 
+    def configure(conf)
+      super
+ 
+      load_config_file
+    end
+ 
+    def start
+      output_start
+      @thread = Thread.new(&method(:run))
+      
+      @watcher = ReloadFileWatcher.create(self, @reload_file, @reload_file_watch_interval)
+      
+    rescue
+      $log.warn "raises exception: #{$!.class}, '#{$!.message}"
+    end
+ 
+    def shutdown
+      @watcher.delete_observers
+      Thread.kill(@thread) 
+      output_shutdown
+    rescue
+      $log.warn "raises exception: #{$!.class}, '#{$!.message}"
+    end
+ 
+    def emit(tag, es, chain)
+      param = OpenStruct.new
+      param.tag = tag
+      param.es = es
+      param.chain = chain
+ 
+      @q.push param
+    end
+ 
+    def update
+      $log.warn 'config_reloader: reload config file start'
+      output_shutdown
+      load_config_file
+      output_start
+      $log.warn 'config_reloader: reload config file end'
+    end
+    
+    private
+ 
+    def output_start
+      @output.start      
+    end
+    
+    def output_shutdown
+      @output.shutdown
+    end
+    
+    def load_config_file
+      path = File.expand_path(@config_file)
+
+      store_elements = File.open(path) do |io|
+        if File.extname(path) == '.rb'
+          require 'fluent/config/dsl'
+          Config::DSL::Parser.parse(io, path)
+        else
+          Config.parse(io, File.basename(path), File.dirname(path), false)
+        end
+      end.elements.select {|e| e.name == 'store'}
+
+      raise ConfigError, "Multiple <store> directives are not available" unless store_elements.size == 1
+      
+      store_element = store_elements.first
+      
+      type = store_element['type']
+      unless type
+        raise ConfigError, "Missing 'type' parameter on <store> directive"
+      end
+      log.debug "adding store type=#{type.dump}"
+ 
+      @output = Plugin.new_output(type)
+      @output.configure(store_element)
+    end
+ 
+    def run
+      loop do
+        param = @q.pop
+
+        tag = param.tag
+        es = param.es
+        chain = param.chain
+ 
+        begin
+          unless es.repeatable?
+            m = MultiEventStream.new
+            es.each {|time,record|
+              m.add(time, record)
+            }
+            es = m
+          end
+          chain = OutputChain.new([@output], tag, es, chain)
+          chain.next
+        rescue
+          $log.warn "raises exception: #{$!.class}, '#{$!.message}, #{param}'"
+        end
+      end
+    end
+  end
+end

data/spec/child.conf

@@ -0,0 +1,9 @@
+<store>
+  type copy
+  <store>
+    type stdout
+  </store>
+  <store>
+    type null
+  </store>
+</store>

data/spec/child_test.conf

@@ -0,0 +1,3 @@
+<store>
+  type test
+</store>

data/spec/fluent.conf

@@ -0,0 +1,13 @@
+<source>
+  type exec
+  command echo http://example.com
+  keys uri
+  tag example
+  run_interval 1s
+</source>
+
+<match example.**>
+  type config_reloader
+  config_file spec/child.conf
+  reload_file spec/reload.txt
+</match>

data/spec/lib/fluent/plugin/out_config_reloader_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe do
+  let(:driver) {Fluent::Test::OutputTestDriver.new(Fluent::ConfigReloaderOutput, tag).configure(config)}
+
+  describe 'emit' do
+    let(:tag) {'test.metrics'}
+    let(:record1) {{ 'field1' => 50, 'otherfield' => 99}}
+    let(:record2) {{ 'field1' => 150, 'otherfield' => 199}}
+    let(:time) {0}
+
+      let(:config) {
+        %[
+            type config_reloader
+            config_file spec/child_test.conf
+            reload_file spec/reload.txt
+            reload_file_watch_interval 0
+        ]
+      }
+
+
+    describe :emit do
+      it do
+        d = driver
+        d.run do
+          d.instance.emit(tag, Fluent::OneEventStream.new(time.to_i, {"a"=>1}), Fluent::Test::TestOutputChain.new)
+          d.instance.emit(tag, Fluent::OneEventStream.new(time.to_i, {"a"=>2}), Fluent::Test::TestOutputChain.new)
+          sleep 1
+        end
+        d.instance.outputs.each {|o|
+          expect([
+              [time, {"a"=>1}],
+              [time, {"a"=>2}],
+            ]).to eq(o.events)
+        }
+      end
+    end
+    
+    describe :update do
+      let(:reload_file) {'spec/reload.txt'}
+      after(:each) do
+        File.delete(reload_file) if File.exists?(reload_file)
+      end
+      
+      it do
+        pending("WIP")
+        
+        expect_any_instance_of(Fluent::ConfigReloaderOutput).to receive(:update).once
+
+        d = driver
+        d.run do
+          d.instance.emit(tag, Fluent::OneEventStream.new(time.to_i, {"a"=>1}), Fluent::Test::TestOutputChain.new)
+          sleep 1
+        end
+        open(reload_file, 'w') do |o|
+          o.write 'xx'
+        end
+        sleep 2
+        sleep 2
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  require 'pry'
+
+  require 'fluent/load'
+  require 'fluent/test'
+
+  require 'fluent/plugin/out_config_reloader'
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-config_reloader
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- bash0C7
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Fluentd plugin to reload child plugin's config
+email:
+- koshiba+github@4038nullpointer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- fluent-plugin-config_reloader.gemspec
+- lib/fluent/plugin/out_config_reloader.rb
+- spec/child.conf
+- spec/child_test.conf
+- spec/fluent.conf
+- spec/lib/fluent/plugin/out_config_reloader_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bash0C7/fluent-plugin-config_reloader
+licenses:
+- Ruby's
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Fluentd plugin to reload child plugin's config
+test_files:
+- spec/child.conf
+- spec/child_test.conf
+- spec/fluent.conf
+- spec/lib/fluent/plugin/out_config_reloader_spec.rb
+- spec/spec_helper.rb