fluent-plugin-growthforecast 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,52 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+.DS_Store
+
+# For TextMate
+*.tmproj
+tmtags
+
+# For emacs:
+*~
+\#*
+.\#*
+
+# For vim:
+*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc
+
+Gemfile.lock
+vendor
+

data/AUTHORS

@@ -0,0 +1 @@
+TAGOMORI Satoshi <tagomoris _at_ gmail.com>

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "simplecov", ">= 0"
+end
+
+gem "fluentd"
+gem "rdoc"

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2012- TAGOMORI Satoshi
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.rdoc

@@ -0,0 +1,59 @@
+= fluent-plugin-growthforecast
+
+== Component
+
+=== GrowthForecastOutput
+
+Plugin to output numbers(metrics) to 'GrowthForecast', metrics drawing tool over HTTP.
+
+About GrowthForecast, see:
+- Github: https://github.com/kazeburo/growthforecast
+- Japanese blog post by @kazeburo: http://blog.nomadscafe.jp/2011/12/growthforecast.html
+
+GrowthForecast is very simple but useful tool to draw graphs what we want, with GrowthForecastOutput and Fluentd.
+
+== Configuration
+
+=== GrowthForecastOutput
+
+For messages such as:
+    tag:metrics {"field1":300, "field2":20, "field3diff":-30}
+    
+Configuration example for graphs in growthforecast with POST api url 'http://growthforecast.local/api/service1/metrics1/metrics_FIELDNAME'.
+
+    <match metrics>
+      type growthforecast
+      gfapi_url http://growthforecast.local/api/
+      service   service1
+      section   metrics1
+      name_keys field1,field2,field3diff
+    </match>
+
+With this configuration, out_growthforecast posts urls below.
+- http://growthforecast.local/api/service1/metrics1/metrics_field1
+- http://growthforecast.local/api/service1/metrics1/metrics_field2
+- http://growthforecast.local/api/service1/metrics1/metrics_field3diff
+
+
+If you want to use tags for 'section' in GrowthForecast, use 'tag_for' options and remove_prefix (and not to set 'section').
+
+    <match metrics.**>
+      type growthforecast
+      gfapi_url http://growthforecast.local/api/
+      service   service1
+      name_keys field1,field2,field3diff
+      tag_for   section    # or 'name_prefix'(default) or 'ignore'
+      remove_prefix metrics
+    </match>
+
+'mode' option available with 'gauge'(default), 'count', 'modified', just same as 'mode' of GrowthForecast POST parameter.
+
+== TODO
+
+- consider what to do next
+- patches welcome!
+
+== Copyright
+
+Copyright:: Copyright (c) 2012- TAGOMORI Satoshi (tagomoris)
+License::   Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+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 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fluent-plugin-growthforecast"
+  gem.description = "Plugin to post numbers to GrowthForecast (by kazeburo)"
+  gem.homepage = "http://github.com/tagomoris/fluent-plugin-growthforecast"
+  gem.summary = gem.description
+  gem.email = "tagomoris@gmail.com"
+  gem.authors = ["TAGOMORI Satoshi"]
+  gem.has_rdoc = "false"
+  # dependencies defined in Gemfile
+  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.8"
+  gem.add_development_dependency "rake", ">= 0.9.2"
+  gem.add_development_dependency "simplecov", ">= 0.5.4"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+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
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fluent-plugin-growthforecast #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/fluent/plugin/out_growthforecast.rb

@@ -0,0 +1,95 @@
+class Fluent::GrowthForecastOutput < Fluent::Output
+  Fluent::Plugin.register_output('growthforecast', self)
+
+  def initialize
+    super
+    require 'net/http'
+    require 'uri'
+  end
+
+  config_param :gfapi_url, :string # growth.forecast.local/api/
+  config_param :service, :string
+  config_param :section, :string, :default => nil
+  config_param :name_keys, :string
+
+  config_param :mode, :string, :default => 'gauge' # or count/modified
+
+  config_param :remove_prefix, :string, :default => nil
+  config_param :tag_for, :string, :default => 'name_prefix' # or 'ignore' or 'section'
+  
+  def configure(conf)
+    super
+
+    if @gfapi_url !~ /\/api\/\Z/
+      raise Fluent::ConfigError, "gfapi_url must end with /api/"
+    end
+    @gfurl = @gfapi_url + @service + '/'
+
+    @mode = case @mode
+            when 'count' then :count
+            when 'modified' then :modified
+            else
+              :gauge
+            end
+    @tag_for = case @tag_for
+               when 'ignore' then :ignore
+               when 'section' then :section
+               else
+                 :name_prefix
+               end
+    if @tag_for != :section and @section.nil?
+      raise Fluent::ConfigError, "section parameter is needed when tag_for is not 'section'"
+    end
+
+    if @remove_prefix
+      @removed_prefix_string = @remove_prefix + '.'
+      @removed_length = @removed_prefix_string.length
+    end
+    @name_keys = @name_keys.split(',')
+  end
+
+  def start
+    super
+  end
+
+  def shutdown
+    super
+  end
+
+  def format_url(tag, name)
+    case @tag_for
+    when :ignore
+      @gfurl + @section + '/' + name
+    when :section
+      @gfurl + tag + '/' + name
+    when :name_prefix
+      @gfurl + @section + '/' + tag + '_' + name
+    end
+  end
+
+  def post(tag, name, value)
+    url = format_url(tag,name)
+    res = Net::HTTP.post_form(URI.parse(url), {'number' => value.to_i, 'mode' => @mode.to_s})
+    case res
+    when Net::HTTPSuccess
+      # OK
+    else
+      $log.warn "failed to post to growthforecast: #{url}, number: #{value}, code: #{res.code}"
+    end
+  end
+
+  def emit(tag, es, chain)
+    if @remove_prefix and
+        ( (tag.start_with?(@removed_prefix_string) and tag.length > @removed_length) or tag == @remove_prefix)
+      tag = tag[@removed_length..-1]
+    end
+    es.each {|time,record|
+      @name_keys.each {|name|
+        if record[name]
+          post(tag, name, record[name])
+        end
+      }
+    }
+    chain.next
+  end
+end

data/test/helper.rb

@@ -0,0 +1,19 @@
+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'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+require 'fluent/plugin/out_growthforecast'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_growthforecast.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestFluentPluginGrowthforecast < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-growthforecast
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- TAGOMORI Satoshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: &2160082200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160082200
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &2160081720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160081720
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2160081240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2160081240
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2160080760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2160080760
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2160080280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2160080280
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &2160079800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2160079800
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: &2160079320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.8
+  type: :runtime
+  prerelease: false
+  version_requirements: *2160079320
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2160078840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *2160078840
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &2160078360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+  type: :development
+  prerelease: false
+  version_requirements: *2160078360
+description: Plugin to post numbers to GrowthForecast (by kazeburo)
+email: tagomoris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .gitignore
+- AUTHORS
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/fluent/plugin/out_growthforecast.rb
+- test/helper.rb
+- test/plugin/test_out_growthforecast.rb
+homepage: http://github.com/tagomoris/fluent-plugin-growthforecast
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1863730412705014917
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Plugin to post numbers to GrowthForecast (by kazeburo)
+test_files:
+- test/helper.rb
+- test/plugin/test_out_growthforecast.rb