fluent-plugin-yohoushi 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ba86fd85bd4b6e256ffb4f1633d8944a274307b8
+  data.tar.gz: 51a4a9f99f7055d49f42e4af253730f4a215560b
+SHA512:
+  metadata.gz: fa06329d4f0d24d58360a874b8346365ceae60c467898c3f9d819b12a6d821591832a39826fc7a50e425716f1d51cae774e0bfb6d495129a50d820b17b71c662
+  data.tar.gz: 5975b9820caef9e28a7cff8fbe17a691ef483011df0f4be7ec6a9e9ade6f6993720d5924f647902cc2f4785dd1c466b4f13697c46a1980a9305873c729914d5d

data/.gitignore

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

data/.pryrc

@@ -0,0 +1,5 @@
+Pry.commands.alias_command 'c', 'continue'
+Pry.commands.alias_command 's', 'step'
+Pry.commands.alias_command 'n', 'next'
+Pry.commands.alias_command 'f', 'finish'
+

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/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+gemspec
+gem 'webmock', :require => false # want :require => false

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,104 @@
+# fluent-plugin-yohoushi [![Build Status](https://secure.travis-ci.org/sonots/fluent-plugin-yohoushi.png?branch=master)](http://travis-ci.org/sonots/fluent-plugin-yohoushi) [![Dependency Status](https://gemnasium.com/sonots/fluent-plugin-yohoushi.png)](https://gemnasium.com/sonots/fluent-plugin-yohoushi)
+
+Fluentd plugin to post data to yohoushi where [yohoushi](http://yohoushi.github.io/yohoushi/) is a visualization graph tool.
+
+## Configuration
+
+    <match foo.bar.**>
+      type yohoushi
+      base_uri http://yohoushi.local:4804
+      key1 foo_count /foobar/foo_count
+      key2 bar_count /foobar/bar_count
+    </source>
+
+Assuming following inputs are coming:
+
+    foo.bar: {"foo_count":1,"bar_count":2}
+
+then fluent-plugin-yohoushi posts data to yohoshi similarly like
+
+    $ curl -d number=1 http://yohoushi.local:4804/api/graphs/foobar/foo_count
+    $ curl -d number=2 http://yohoushi.local:4804/api/graphs/foobar/bar_count
+
+## Parameters
+
+- base\_uri (semi-required)
+
+    The base uri of yohoushi. `mapping1` or `base_uri` is required.
+
+- mapping\[1-20\] (semi-required)
+
+    This is an option for [multiforecast-client](https://github.com/yohoushi/multiforecast-client). `mapping1` or `base_uri` is required. 
+
+    With this option, you can post graph data directly to multiple growthforecasts, not via yohoushi, which is more efficient.
+
+    ex)
+
+        mapping1 /foobar http://growthforecast1.local:5125
+        mapping2 /       http://growthforecast2.local:5125
+
+- key\[1-20\] (semi-required)
+
+    A pair of a field name of the input record, and a graph path to be posted. `key1` or `key_pattern` is required.
+
+    SECRET TRICK: You can use placeholders for the graph path. See Placeholders section.
+
+- key\_pattern (semi-requierd)
+
+    A pair of a regular expression to specify field names of the input record, and an expression to specify graph paths. `key1` or `key_pattern` is required. 
+
+    For example, a configuration like
+
+        key_pattern _count$ /foobar/${key}
+
+    instead of key1, key2 in the above example gives the same effect. 
+
+        $ curl -d number=1 http://yohoushi.local:4804/api/graphs/foobar/foo_count
+        $ curl -d number=2 http://yohoushi.local:4804/api/graphs/foobar/bar_count
+
+    See Placeholders section to know more about placeholders such as ${key}.
+
+- enable\_float\_number
+
+    Set to `true` if you are enabling `--enable_float_number` option of GrowthForecast. Default is `false`
+
+- mode
+
+    The graph mode (either of gauge, count, or modified). Just same as mode of GrowthForecast POST parameter. Default is gauge.
+
+### Placeholders
+
+The keys of input json are available as placeholders. In the above example, 
+
+* ${foo_count}
+* ${bar_count}
+
+shall be available. In addition, following placeholders are reserved: 
+
+* ${hostname} hostname
+* ${tag} input tag
+* ${tags} input tag splitted by '.'
+* ${time} time of the event
+* ${key} the matched key value with `key_pattern` or `key1`, `key2`, ...
+
+It is also possible to write a ruby code in placeholders, so you may write some codes as
+
+* ${time.strftime('%Y-%m-%dT%H:%M:%S%z')}
+* ${tags.last}  
+
+## 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) 2013 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-yohoushi.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "fluent-plugin-yohoushi"
+  s.version     = "0.0.1"
+  s.authors     = ["Naotoshi Seo"]
+  s.email       = ["sonots@gmail.com"]
+  s.homepage    = "https://github.com/sonots/fluent-plugin-yohoushi"
+  s.summary     = "fluentd plugin to post data to yohoushi"
+  s.description = s.summary
+
+  s.rubyforge_project = "fluent-plugin-yohoushi"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "fluentd"
+  s.add_runtime_dependency "multiforecast-client"
+  s.add_runtime_dependency "yohoushi-client"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "pry-nav"
+end

data/lib/fluent/plugin/out_yohoushi.rb

@@ -0,0 +1,137 @@
+class Fluent::YohoushiOutput < Fluent::Output
+  Fluent::Plugin.register_output('yohoushi', self)
+
+  MAPPING_MAX_NUM = 20
+  KEY_MAX_NUM = 20
+
+  def initialize
+    super
+    require 'socket'
+    require 'multiforecast-client'
+    require 'yohoushi-client'
+  end
+
+  config_param :base_uri, :string, :default => nil
+  (1..MAPPING_MAX_NUM).each {|i| config_param "mapping#{i}".to_sym, :string, :default => nil }
+  config_param :key_pattern, :string, :default => nil
+  (1..KEY_MAX_NUM).each {|i| config_param "key#{i}".to_sym, :string, :default => nil }
+  config_param :enable_float_number, :bool, :default => false
+  config_param :mode, :default => :gauge do |val|
+    case val.downcase
+    when 'gauge'
+      :gauge
+    when 'count'
+      :count
+    when 'modified'
+      :modified
+    else
+      raise ConfigError, "stdout output output_type should be `gauge`, `count`, or `modified`"
+    end
+  end
+
+  # for test
+  attr_reader :client
+  attr_reader :mapping
+  attr_reader :keys
+  attr_reader :key_pattern
+  attr_reader :key_pattern_path
+
+  def configure(conf)
+    super
+
+    if @base_uri
+      @client = Yohoushi::Client.new(@base_uri)
+    else
+      @mapping = {}
+      (1..MAPPING_MAX_NUM).each do |i|
+        next unless conf["mapping#{i}"]
+        from, to = conf["mapping#{i}"].split(/ +/, 2)
+        raise Fluent::ConfigError, "mapping#{i} does not contain 2 parameters" unless to
+        @mapping[from] = to
+      end
+      @client = MultiForecast::Client.new('mapping' => @mapping) unless @mapping.empty?
+    end
+    raise Fluent::ConfigError, "Either of `base_uri` or `mapping1` must be specified" unless @client
+
+    if @key_pattern
+      key_pattern, @key_pattern_path = @key_pattern.split(/ +/, 2)
+      raise Fluent::ConfigError, "key_pattern does not contain 2 parameters" unless @key_pattern_path
+      @key_pattern = Regexp.compile(key_pattern)
+    else
+      @keys = {}
+      (1..KEY_MAX_NUM).each do |i|
+        next unless conf["key#{i}"] 
+        key, path = conf["key#{i}"].split(/ +/, 2)
+        raise Fluent::ConfigError, "key#{i} does not contain 2 parameters" unless path
+        @keys[key] = path
+      end
+    end
+    raise Fluent::ConfigError, "Either of `key_pattern` or `key1` must be specified" if (@key_pattern.nil? and @keys.empty?)
+
+    @hostname = Socket.gethostname
+  rescue => e
+    raise Fluent::ConfigError, "#{e.class} #{e.message} #{e.backtrace.first}"
+  end
+
+  def start
+    super
+  end
+
+  def shutdown
+    super
+  end
+
+  def post(path, number)
+    if @enable_float_number
+      @client.post_graph(path, { 'number' => number.to_f, 'mode' => @mode.to_s })
+    else
+      @client.post_graph(path, { 'number' => number.to_i, 'mode' => @mode.to_s })
+    end
+  rescue => e
+    $log.warn "out_yohoushi: #{e.class} #{e.message} #{e.backtrace.first}"
+  end
+
+  def emit(tag, es, chain)
+    tags = tag.split('.')
+    if @key_pattern
+      es.each do |time, record|
+        record.each do |key, value|
+          next unless key =~ @key_pattern
+          path = expand_placeholder(@key_pattern_path, record, tag, tags, time, key)
+          post(path, value)
+        end
+      end
+    else # keys
+      es.each do |time, record|
+        @keys.each do |key, path|
+          next unless value = record[key]
+          path = expand_placeholder(path, record, tag, tags, time, key)
+          post(path, value)
+        end
+      end
+    end
+
+    chain.next
+  rescue => e
+    $log.warn "out_yohoushi: #{e.class} #{e.message} #{e.backtrace.first}"
+  end
+
+  private
+
+  def expand_placeholder(str, record, tag, tags, time, key)
+    struct = UndefOpenStruct.new(record)
+    struct.tag  = tag
+    struct.tags = tags
+    struct.time = time
+    struct.key  = key
+    struct.hostname = @hostname
+    str = str.gsub(/\$\{([^}]+)\}/, '#{\1}') # ${..} => #{..}
+    eval "\"#{str}\"", struct.instance_eval { binding }
+  end
+
+  class UndefOpenStruct < OpenStruct
+    (Object.instance_methods).each do |m|
+      undef_method m unless m.to_s =~ /^__|respond_to_missing\?|object_id|public_methods|instance_eval|method_missing|define_singleton_method|respond_to\?|new_ostruct_member/
+    end
+  end
+end

data/spec/out_yohoushi_spec.rb

@@ -0,0 +1,140 @@
+# encoding: UTF-8
+require_relative 'spec_helper'
+
+shared_context "stub_yohoushi_post_graph" do |path|
+  before do
+    stub_request(:post, "#{yohoushi_base_uri}/api/graphs/#{path}").
+    to_return(:status => 200, :body => { "error" => 0, "data" => "blahblah" }.to_json)
+  end
+end
+shared_context "stub_growthforecast_post_graph" do |path|
+  before do
+    stub_request(:post, "#{growthforecast_base_uri}/api/#{path}").
+    to_return(:status => 200, :body => { "error" => 0, "data" => "blahblah" }.to_json)
+  end
+end
+
+describe Fluent::YohoushiOutput do
+  before { Fluent::Test.setup }
+  let(:yohoushi_base_uri) { 'http://localhost:4804' }
+  let(:growthforecast_base_uri) { 'http://localhost:5125' }
+  let(:tag) { 'test' }
+  let(:driver) { Fluent::Test::OutputTestDriver.new(Fluent::YohoushiOutput, tag).configure(config) }
+  let(:emit) { driver.run { messages.each {|message| driver.emit(message, time) } } }
+
+  describe 'test configure' do
+    context "empty" do
+      let(:config) { '' } 
+      it { expect { driver }.to raise_error(Fluent::ConfigError) }
+    end
+
+    context "no uri" do
+      let(:config) { %[key1 foo_count /foobar/foo_count] }
+      it { expect { driver }.to raise_error(Fluent::ConfigError) }
+    end
+
+    context "no keys" do
+      let(:config) { %[base_uri #{yohoushi_base_uri}] }
+      it { expect { driver }.to raise_error(Fluent::ConfigError) }
+    end
+
+    context "base_uri" do
+      subject { driver.instance }
+      let(:config) {%[
+        base_uri #{yohoushi_base_uri}
+        key1 foo_count /foobar/foo_count
+      ]}
+      it { subject.client.class == Yohoushi::Client }
+    end
+
+    context "mapping" do
+      subject { driver.instance }
+      let(:config) {%[
+        mapping1 / #{growthforecast_base_uri}
+        key1 foo_count /foobar/foo_count
+      ]}
+      it { subject.client.class == GrowthForecast::Client }
+    end
+
+    context "keys" do
+      subject { driver.instance }
+      let(:config) {%[
+        base_uri #{yohoushi_base_uri}
+        key1 foo_count /foobar/foo_count
+        key2 bar_count /foobar/bar_count
+      ]}
+      it { subject.keys["foo_count"].should == "/foobar/foo_count" }
+      it { subject.keys["bar_count"].should == "/foobar/bar_count" }
+    end
+
+    context "key_pattern" do
+      subject { driver.instance }
+      let(:config) {%[
+        base_uri #{yohoushi_base_uri}
+        key_pattern _count$ /foobar/${key}
+      ]}
+      it { subject.key_pattern.should == Regexp.compile("_count$") }
+      it { subject.key_pattern_path.should == "/foobar/${key}" }
+    end
+  end
+
+  describe 'test emit' do
+    let(:time) { Time.now.to_i }
+    let(:messages) do
+      [
+        { 'foo_count' => "1", 'bar_count' => "1" },
+        { 'foo_count' => "2", 'bar_count' => "2" },
+      ]
+    end
+
+    context 'base_uri and keys' do
+      let(:config) {%[
+        base_uri #{yohoushi_base_uri}
+        key1 foo_count /path/to/foo_count
+        key2 bar_count /path/to/bar_count
+      ]}
+
+      include_context "stub_yohoushi_post_graph", "path/to/foo_count" unless ENV["MOCK"] == "off"
+      include_context "stub_yohoushi_post_graph", "path/to/bar_count" unless ENV["MOCK"] == "off"
+      before { Fluent::Engine.stub(:now).and_return(time) }
+      it { emit }
+    end
+
+    context 'base_uri and key_pattern' do
+      let(:config) {%[
+        base_uri #{yohoushi_base_uri}
+        key_pattern _count$ /path/to/${key}
+      ]}
+
+      include_context "stub_yohoushi_post_graph", "path/to/foo_count" unless ENV["MOCK"] == "off"
+      include_context "stub_yohoushi_post_graph", "path/to/bar_count" unless ENV["MOCK"] == "off"
+      before { Fluent::Engine.stub(:now).and_return(time) }
+      it { emit }
+    end
+
+    context 'mapping and keys' do
+      let(:config) {%[
+        mapping1 / #{growthforecast_base_uri}
+        key1 foo_count /path/to/${key}
+        key2 bar_count /path/to/${key}
+      ]}
+
+      include_context "stub_growthforecast_post_graph", "path/to/foo_count" unless ENV["MOCK"] == "off"
+      include_context "stub_growthforecast_post_graph", "path/to/bar_count" unless ENV["MOCK"] == "off"
+      before { Fluent::Engine.stub(:now).and_return(time) }
+      it { emit }
+    end
+
+    context 'maping and key_pattern' do
+      let(:config) {%[
+        mapping1 / #{growthforecast_base_uri}
+        key_pattern _count$ /path/to/${key}
+      ]}
+
+      include_context "stub_growthforecast_post_graph", "path/to/foo_count" unless ENV["MOCK"] == "off"
+      include_context "stub_growthforecast_post_graph", "path/to/bar_count" unless ENV["MOCK"] == "off"
+      before { Fluent::Engine.stub(:now).and_return(time) }
+      it { emit }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
+
+require 'fluent/test'
+require 'rspec'
+require 'pry'
+require 'multiforecast-client'
+require 'webmock/rspec'
+WebMock.allow_net_connect! if ENV['MOCK'] == 'off'
+
+$TESTING=true
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'fluent/plugin/out_yohoushi'

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-yohoushi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-29 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: multiforecast-client
+  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: yohoushi-client
+  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'
+description: fluentd plugin to post data to yohoushi
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .pryrc
+- .rspec
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-yohoushi.gemspec
+- lib/fluent/plugin/out_yohoushi.rb
+- spec/out_yohoushi_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sonots/fluent-plugin-yohoushi
+licenses: []
+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: fluent-plugin-yohoushi
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: fluentd plugin to post data to yohoushi
+test_files:
+- spec/out_yohoushi_spec.rb
+- spec/spec_helper.rb
+has_rdoc: