fluent-plugin-latency 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e04db26bee1aa442cf3d1d2fcaa0277a48f3c17f
+  data.tar.gz: 55a9002207cefe088c92b5f06eff1101ede0a087
+SHA512:
+  metadata.gz: 17187e3431a42083afa94b8fc5f2d5896dd4a981b49edbbd5208d2261be0cf12d3af27af49a1c03332a234b7f88bf8b441dede5eb21051f746e8dcbf42bbe3ff
+  data.tar.gz: 7c5e846831a25a9a21ed3917dca9848bfaa5425f283b86431b5a4fc50d8e0e2b9201221243bc2c9c5002130c5b01332e0b9aab08530803f36b5892895c46c702

data/.gitignore

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

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/24)
+
+First release
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gemspec
+gem 'fluent-plugin-flowcounter' # for examples

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,94 @@
+# fluent-plugin-latency
+
+[![Build Status](https://secure.travis-ci.org/sonots/fluent-plugin-latency.png?branch=master)](http://travis-ci.org/sonots/fluent-plugin-latency)
+
+Fluentd plugin to measure latency until receiving the messages. 
+
+## What Is It For?
+
+This plugin is to investigate the network latency, in addition, the blocking situation of input plugins.
+
+In the Fluentd mechanism, input plugins usually blocks and will not receive a new data until the previous data processing finishes.
+
+By seeing the latency, you can easily find how long the blocking situation is occuring.
+
+## How It Works
+
+Fluentd messages include the time attribute which expresses the time of when the message is created, or when it is written in application logs.
+
+This plugin takes the difference between the current time and the time attribute to obtain the latency. 
+
+## Installation
+
+Use RubyGems:
+
+    gem install fluent-plugin-latency
+
+## Configuration
+
+Following example measures the max and average latency until receiving messages. 
+Note that this example uses [fluent-plugin-reemit](https://github.com/sonots/fluent-plugin-reemit) to capture all messages once, measure latencies, and then re-emit. 
+
+```apache
+<source>
+  type forward
+  port 24224
+</source>
+
+# Latency plugin output comes here
+<match latency>
+  type stdout
+</match>
+
+# All messages come here once. Measure latencies and re-emit
+<match **>
+  type copy
+  <store>
+    type latency
+    tag latency
+    interval 60
+  </store>
+  <store>
+    type reemit
+  </store>
+</match>
+
+# Whatever you want to do
+<match **>
+  type stdout
+</match>
+```
+
+Output will be like
+
+```
+latency: {"max":1.011,"avg":0.002","num":10}
+```
+
+where `max` and `avg` are the maximum and average latency, and `num` is the number of messages.
+
+## Option Parameters
+
+* interval
+
+    The time interval to emit measurement results
+
+* tag
+
+    The output tag name. Default is `latency`
+
+## ChangeLog
+
+See [CHANGELOG.md](CHANGELOG.md) for details.
+
+## 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/fluent-plugin-latency.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "fluent-plugin-latency"
+  gem.version     = "0.0.1"
+  gem.authors     = ["Naotoshi Seo"]
+  gem.email       = "sonots@gmail.com"
+  gem.homepage    = "https://github.com/sonots/fluent-plugin-latency"
+  gem.description = "Fluentd plugin to measure latency until receiving the messages"
+  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"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "pry-nav"
+  gem.add_development_dependency "timecop"
+end

data/lib/fluent/plugin/out_latency.rb

@@ -0,0 +1,63 @@
+module Fluent
+  class LatencyOutput < MultiOutput
+    Plugin.register_output('latency', self)
+
+    # To support log_level option implemented by Fluentd v0.10.43
+    unless method_defined?(:log)
+      define_method("log") { $log }
+    end
+
+    config_param :tag, :string, :default => 'latency'
+    config_param :interval, :time, :default => 60
+
+    attr_reader :latency # for test
+
+    def initialize
+      super
+      @latency = []
+    end
+
+    def configure(conf)
+      super
+    end
+
+    def emit(tag, es, chain)
+      current = Time.now.to_f
+      es.each do |time, record|
+        @latency << (current - time)
+      end
+      chain.next
+    end
+
+    def start
+      super
+      @thread = Thread.new(&method(:run))
+    end
+
+    def shutdown
+      super
+      @thread.terminate
+      @thread.join
+    end
+
+    def run
+      @last_checked ||= Engine.now
+      while (sleep 0.5)
+        now = Engine.now
+        if now - @last_checked >= @interval
+          flush_emit
+          @last_checked = now
+        end
+      end
+    end
+
+    def flush_emit
+      latency, @latency = @latency, []
+      num = latency.size
+      max = num == 0 ? 0 : latency.max
+      avg = num == 0 ? 0 : latency.map(&:to_f).inject(:+) / num.to_f
+      message = {"max" => max, "avg" => avg, "num" => num}
+      Engine.emit(@tag, Engine.now, message)
+    end
+  end
+end

data/spec/out_latency.rb

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+require_relative 'spec_helper'
+
+describe Fluent::LatencyOutput do
+  before { Fluent::Test.setup }
+  let(:config) { %[] }
+  let(:tag) { 'tag' }
+  let(:driver) { Fluent::Test::OutputTestDriver.new(Fluent::LatencyOutput, tag).configure(config) }
+
+  describe 'test configure' do
+    subject { driver.instance }
+
+    context "check default" do
+      let(:config) { %[] }
+      its(:tag) { should == 'latency' }
+      its(:interval) { should == 60 }
+    end
+
+    context "check config" do
+      let(:config) { %[tag tag\ninterval 120]}
+      its(:tag) { should == 'tag' }
+      its(:interval) { should == 120 }
+    end
+  end
+
+  describe 'test emit' do
+    let(:emit_time) { Time.utc(1,1,1,1,1,2010,nil,nil,nil,nil).to_i }
+    let(:current_time) { Time.utc(2,1,1,1,1,2010,nil,nil,nil,nil).to_i }
+    let(:message) { "INFO GET /ping" }
+    let(:expected) { {"max" => 1.0, "avg" => 1.0, "num" => 1} }
+    before {
+      Timecop.freeze(Time.at(current_time))
+      Fluent::Engine.should_receive(:emit).with("latency", current_time, expected)
+    }
+    after  { Timecop.return }
+    it {
+      driver.run { driver.emit({'message' => message}, emit_time) }
+      driver.instance.flush_emit
+    }
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-latency
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-24 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: 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'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  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 measure latency until receiving the messages
+email: sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-latency.gemspec
+- lib/fluent/plugin/out_latency.rb
+- spec/out_latency.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sonots/fluent-plugin-latency
+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: Fluentd plugin to measure latency until receiving the messages
+test_files:
+- spec/out_latency.rb
+- spec/spec_helper.rb