fluent-plugin-debug 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 879b946f7b4406574b8b82bd67a624c7da4e3dcd
+  data.tar.gz: ddb297209634c9a15ee05791134a9d92e4db4e95
+SHA512:
+  metadata.gz: 04db20cbc22e0f833e9df9d05f40080e9e16ad0eee296b447d2071a33575e0fce5b0a065b16c0047d4c38adbca15b564ad8fa022edd1302ada0a741561bd00ab
+  data.tar.gz: 18f640c3fcacfd39a76975680f7d8c51fe9b9b26eca45d4f38ee8e233425fbcae3a9c03df3605bc0b15d89d6b288eb972922a15c4bbc076eae0585cec85a5cb7

data/.gitignore

@@ -0,0 +1,15 @@
+/*.gem
+~*
+#*
+*~
+.bundle
+Gemfile.lock
+.rbenv-version
+vendor
+doc/*
+tmp/*
+coverage
+.yardoc
+pkg/
+.ruby-version
+*.log

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+gemfile:
+  - Gemfile

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## 0.0.1  (2014/04/25)
+
+First release
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Naotoshi SEO
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,103 @@
+# fluent-plugin-debug
+
+[![Build Status](https://secure.travis-ci.org/sonots/fluent-plugin-debug.png?branch=master)](http://travis-ci.org/sonots/fluent-plugin-debug)
+[![Code Climate](https://codeclimate.com/github/sonots/fluent-plugin-debug.png)](https://codeclimate.com/github/sonots/fluent-plugin-debug)
+
+Fluentd plugin to investigate incoming messages in a short-hand.
+
+## Installation
+
+Use RubyGems:
+
+    gem install fluent-plugin-debug
+
+## What is this for?
+
+Do you use `out_copy` and `out_stdout` to see incoming messages?
+
+```apache
+<match **>
+  type copy
+  <store>
+    type stdout
+  </store>
+  <store>
+    type file
+    # blah blah
+  </store>
+</match>
+```
+
+This plugin enables to write the same thing in a short-hand, by just adding `debug true`, as:
+
+```apache
+<match **>
+  type file
+  debug true
+  # blash blah
+</match>
+```
+
+## Configuration
+
+This plugin is doing something tricky, which extends arbitrary plugins so that they can use `debug` option parameter. 
+
+```apache
+<source>
+  type debug # This makes available the `debug` option for all output plugins
+</source>
+
+<match **>
+  type file
+  debug true # Now you can use `debug true`
+</match>
+```
+
+If you are lazy to write even `debug true`, you may use `debug_all` option. 
+
+```apache
+<source>
+  type debug
+  debug_all true # This makes turn on the `debug` option for all output plugins
+</source>
+
+<match **>
+  type file # Now you don't need even to add `debug true`
+</match>
+```
+
+## Options
+
+### Options (source)
+
+* debug_all
+
+  * Apply `debug true` for all output plugins
+
+### Options (output plugins)
+
+This plugin extends all output plugins and enables to use the following options:
+
+* debug (bool)
+
+  * Enable to output the incoming messages
+
+## ChangeLog
+
+See [CHANGELOG.md](CHANGELOG.md) for details.
+
+## Note
+
+This plugin is dedicated to [@hirose31](https://github.com/hirose31). 
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new [Pull Request](../../pull/new/master)
+
+## Copyright
+
+Copyright (c) 2014 Naotoshi Seo. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+task :default => :spec
+
+desc 'Open an irb session preloaded with the gem library'
+task :console do
+    sh 'irb -rubygems -I lib'
+end
+task :c => :console

data/examples/debug_all.conf

@@ -0,0 +1,16 @@
+<source>
+  type debug
+  debug_all true
+</source>
+
+<source>
+  type forward
+</source>
+
+<match hoge>
+  type null
+</match>
+
+<match **>
+  type stdout
+</match>

data/fluent-plugin-debug.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "fluent-plugin-debug"
+  gem.version     = "0.0.1"
+  gem.authors     = ["Naotoshi Seo"]
+  gem.email       = "sonots@gmail.com"
+  gem.homepage    = "https://github.com/sonots/fluent-plugin-debug"
+  gem.description = "Fluentd plugin to investigate incoming messages in a short-hand"
+  gem.summary     = gem.description
+  gem.licenses    = ["MIT"]
+  gem.has_rdoc    = false
+
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ['lib']
+
+  gem.add_dependency "fluentd", "~> 0.10.17"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "pry-nav"
+end

data/lib/fluent/plugin/in_debug.rb

@@ -0,0 +1,54 @@
+require 'fluent/input'
+
+module Fluent
+  class DebugInput < Input
+    Plugin.register_input('debug', self)
+    config_param :debug_all, :bool, :default => false
+
+    def configure(conf)
+      super
+      Debuggable.extend_configure(::Fluent::Output)
+    end
+
+    def start
+      # Engine.matches are created after input plugins are configured, so matches are empty in #configure
+      # cf. https://github.com/fluent/fluentd/blob/56f198ecf5ca95dcddef7bdc21b5a309468670e3/lib/fluent/engine.rb#L123
+      # #start is called after that, so we can access to Engine.matches here
+      super
+      if @debug_all
+        Engine.matches.each do |match|
+          Debuggable.extend_emit(match.output)
+        end
+      end
+    end
+  end
+
+  # WOW! WHAT A FUCKING META PROGRAMMING!
+  class Debuggable
+    def self.extend_emit(obj)
+      klass = obj.singleton_class
+      unless klass.method_defined?(:emit_without_debug)
+        klass.__send__(:alias_method, :emit_without_debug, :emit)
+        klass.__send__(:define_method, :emit_with_debug) do |tag, es, chain|
+          es.each do |time, record|
+            $log.write "#{Time.at(time).localtime} #{tag}: #{Yajl.dump(record)}\n"
+          end
+          emit_without_debug(tag, es, chain)
+        end 
+        klass.__send__(:alias_method, :emit, :emit_with_debug)
+      end
+    end
+
+    def self.extend_configure(klass)
+      unless klass.method_defined?(:configure_without_debug)
+        klass.config_param :debug, :bool, :default => false
+        klass.__send__(:alias_method, :configure_without_debug, :configure)
+        klass.__send__(:define_method, :configure_with_debug) do |conf|
+          configure_without_debug(conf)
+          Debuggable.extend_emit(self) if conf['debug']
+        end
+        klass.__send__(:alias_method, :configure, :configure_with_debug)
+      end
+    end
+  end
+end

data/spec/in_debug_spec.rb

@@ -0,0 +1,65 @@
+# encoding: UTF-8
+require_relative 'spec_helper'
+require 'fluent/plugin/out_stdout'
+
+# Capture the log output of the block given
+def capture_log(&block)
+  tmp = $log
+  $log = StringIO.new
+  yield
+  return $log.string
+ensure
+  $log = tmp
+end
+
+describe Fluent::DebugInput do
+  before { Fluent::Test.setup }
+
+  def create_driver(conf=%[])
+    Fluent::Test::InputTestDriver.new(Fluent::DebugInput).configure(conf)
+  end
+
+  describe 'test configure' do
+    it { expect { create_driver }.not_to raise_error }
+    it { expect { create_driver(%[debug_all true]) }.not_to raise_error }
+  end
+end
+
+describe "debug_all" do
+  # There is not suitable test driver ...
+end
+
+describe "extends Fluent::StdoutOutput" do
+  before { Fluent::Test.setup }
+
+  def create_driver(conf=CONFIG, tag = 'test')
+    Fluent::Test::OutputTestDriver.new(Fluent::StdoutOutput, tag).configure(conf)
+  end
+  let(:driver) { create_driver(config) }
+
+  describe 'test configure' do
+    let(:config) { %[debug true] }
+    let(:subject) { driver.instance }
+    its(:debug) { should == true }
+  end
+
+  describe 'test emit' do
+    let(:config) { %[debug true] }
+
+    before {
+      time = Fluent::Engine.now
+      Fluent::Engine.stub(:now).and_return(time)
+    }
+
+    it 'should flush' do
+      d = driver.instance
+      out = capture_log do
+        chain = Fluent::NullOutputChain.instance
+        d.emit('tag', Fluent::OneEventStream.new(0, {'a'=>1}), chain)
+      end
+      debug_stdout, out_stdout = out.split("\n")
+      debug_stdout.should_not be_nil
+      debug_stdout.should == out_stdout
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'bundler'
+require 'fluent/load'
+Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
+
+require 'fluent/test'
+require 'rspec'
+require 'pry'
+
+$TESTING=true
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'fluent/plugin/in_debug'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-debug
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.17
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.17
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  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 investigate incoming messages in a short-hand
+email: sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- examples/debug_all.conf
+- fluent-plugin-debug.gemspec
+- lib/fluent/plugin/in_debug.rb
+- spec/in_debug_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sonots/fluent-plugin-debug
+licenses:
+- MIT
+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.2
+signing_key: 
+specification_version: 4
+summary: Fluentd plugin to investigate incoming messages in a short-hand
+test_files:
+- spec/in_debug_spec.rb
+- spec/spec_helper.rb