fluent-plugin-flowcounter-simple 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5216d3378426ae3848440710ccbaef547072e6ae
+  data.tar.gz: 9457e194d2c09ff32aa0a78770671fb12c89c8a3
+SHA512:
+  metadata.gz: 887e11504a1bf669daa5a93fc4973afdef066737453effc6b3144aaea3d15fbc8f63bff41d16aeb820a724302b870b5cb5636716afb0ffaa7c3027520fa13cfd
+  data.tar.gz: ff478a165066e0f53835a71f0b5cc706b3401c22b3c58c39bc090ab11effee09e7d49c1a48accc9358894121b74ffa8c5c44969a551922d093efb480cbfbed21

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -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,42 @@
+# fluent-plugin-flowcounter-simple [![Build Status](https://secure.travis-ci.org/sonots/fluent-plugin-flowcounter-simple.png?branch=master)](http://travis-ci.org/sonots/fluent-plugin-flowcounter-simple)
+
+Simple Fluentd Plugin to count number of messages and outputs to log
+
+## Configuration
+
+    <match foo.bar.**>
+      type flowcounter_simple
+      unit second
+    </source>
+
+This plugin does not emit, just writes into the log file as
+
+    plugin:out_flowcounter_simple  count:30  indicator:num  unit:second
+
+## Parameters
+
+- unit
+
+    One of second/minute/hour/day. Default: minute
+
+- indicator
+
+    One of num/byte. Default: num
+
+## Relatives
+
+There is a [fluent-plugin-flowcounter](https://github.com/tagomoris/fluent-plugin-flowcounter), 
+but I needed a very very simple plugin to use for performance evaluation. 
+
+## 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) 2013 Naotoshi Seo. See [LICENSE.txt](LICENSE.txt) for details.
+

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/fluent-plugin-flowcounter-simple.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.name        = "fluent-plugin-flowcounter-simple"
+  gem.version     = "0.0.1"
+  gem.authors     = ["Naotoshi Seo"]
+  gem.email       = ["sonots@gmail.com"]
+  gem.summary     = %q{Simple Fluentd Plugin to count number of messages and outputs to log}
+  gem.description = %q{Simple Fluentd Plugin to count number of messages and outputs to log}
+  gem.homepage    = "https://github.com/sonots/fluent-plugin-flowcounter-simple"
+  gem.license     = "MIT"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency "fluentd"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "pry-nav"
+end

data/lib/fluent/plugin/out_flowcounter_simple.rb

@@ -0,0 +1,93 @@
+class Fluent::FlowCounterSimpleOutput < Fluent::Output
+  Fluent::Plugin.register_output('flowcounter_simple', self)
+
+  config_param :indicator, :string, :default => 'num'
+  config_param :unit, :string, :default => 'second'
+
+  attr_accessor :last_checked
+
+  def configure(conf)
+    super
+
+    @indicator_proc =
+      case @indicator
+      when 'num'  then Proc.new {|record| 1 }
+      when 'byte' then Proc.new {|record| record.to_msgpack.size }
+      else
+        raise Fluent::ConfigError, "flowcounter-simple count allows num/byte"
+      end
+    @unit =
+      case @unit
+      when 'second' then :second
+      when 'minute' then :minute
+      when 'hour' then :hour
+      when 'day' then :day
+      else
+        raise Fluent::ConfigError, "flowcounter-simple unit allows second/minute/hour/day"
+      end
+    @tick =
+      case @unit
+      when :second then 1
+      when :minute then 60
+      when :hour then 3600
+      when :day then 86400
+      else
+        raise RuntimeError, "@unit must be one of second/minute/hour/day"
+      end
+
+    @count = 0
+    @mutex = Mutex.new
+  end
+
+  def start
+    super
+    start_watch
+  end
+
+  def shutdown
+    super
+    @watcher.terminate
+    @watcher.join
+  end
+
+  def countup(count)
+    @mutex.synchronize {
+      @count = (@count || 0) + count
+    }
+  end
+
+  def flush_emit(step)
+    count, @count = @count, 0
+    if count > 0
+      $log.info "plugin:out_flowcounter_simple\tcount:#{count}\tindicator:#{@indicator}\tunit:#{@unit}"
+    end
+  end
+
+  def start_watch
+    # for internal, or tests only
+    @watcher = Thread.new(&method(:watch))
+  end
+
+  def watch
+    # instance variable, and public accessable, for test
+    @last_checked = Fluent::Engine.now
+    while true
+      sleep 0.1
+      if Fluent::Engine.now - @last_checked >= @tick
+        now = Fluent::Engine.now
+        flush_emit(now - @last_checked)
+        @last_checked = now
+      end
+    end
+  end
+
+  def emit(tag, es, chain)
+    count = 0
+    es.each {|time,record|
+      count += @indicator_proc.call(record)
+    }
+    countup(count)
+
+    chain.next
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+require 'fluent/plugin/out_flowcounter_simple'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_flowcounter_simple.rb

@@ -0,0 +1,67 @@
+require 'helper'
+
+class FlowCounterSimpleOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+  
+  CONFIG = %[
+    unit second
+  ]
+
+  def create_driver(conf=CONFIG,tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::FlowCounterSimpleOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    assert_nothing_raised {
+      d = create_driver('')
+    }
+    assert_nothing_raised {
+      d = create_driver(CONFIG)
+    }
+    assert_nothing_raised {
+      d = create_driver(CONFIG + %[indicator num])
+    }
+    assert_nothing_raised {
+      d = create_driver(CONFIG + %[indicator byte])
+    }
+  end
+
+  def test_num
+    d1 = create_driver(CONFIG, 'test.tag1')
+    d1.run do
+      10.times do
+        d1.emit({'message'=> 'a' * 100})
+        d1.emit({'message'=> 'b' * 100})
+        d1.emit({'message'=> 'c' * 100})
+      end
+    end
+    log = capture_log { d1.instance.flush_emit(60) }
+    assert( log.include?("count:30"), log )
+  end
+
+  def test_byte
+    d1 = create_driver(CONFIG + %[indicator byte], 'test.tag1')
+    d1.run do
+      10.times do
+        d1.emit({'message'=> 'a' * 100})
+        d1.emit({'message'=> 'b' * 100})
+        d1.emit({'message'=> 'c' * 100})
+      end
+    end
+    log = capture_log { d1.instance.flush_emit(60) }
+    assert( log.include?("count:3360"), log )
+  end
+
+private
+
+  def capture_log
+    tmp = $log.out
+    $log.out = StringIO.new
+    yield
+    return $log.out.string
+  ensure
+    $log.out = tmp
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-flowcounter-simple
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-27 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: 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: 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: Simple Fluentd Plugin to count number of messages and outputs to log
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-flowcounter-simple.gemspec
+- lib/fluent/plugin/out_flowcounter_simple.rb
+- test/helper.rb
+- test/plugin/test_out_flowcounter_simple.rb
+homepage: https://github.com/sonots/fluent-plugin-flowcounter-simple
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Simple Fluentd Plugin to count number of messages and outputs to log
+test_files:
+- test/helper.rb
+- test/plugin/test_out_flowcounter_simple.rb