fluent-plugin-5rocks 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 469f6033d209b5faea327124c20b2c74768feed4
+  data.tar.gz: d0b9ef4ef01610728efecb1f0636413c630a6073
+SHA512:
+  metadata.gz: 3a82fcf3dfe702cb911dbc26a93cf06e82869ce942b6758da4a223ac3c56a448cdcd634902700a0c1924d0a9238db904209a2231ee148dae8928c04fbabca905
+  data.tar.gz: e1b65ee8d2788dc4df761c8ab22047a77d29dacd9cb0d9cefe424c029ad065eda9757310799cfbf2818d0cc50f3aa36ec95a8284fe701138c9cd1860d7db6352

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.conf

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 hokuts
+
+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,54 @@
+# fluent-plugin-5rocks
+
+[Fluentd](http://fluentd.org) output plugin to insert data into [5rocks](https://www.5rocks.io/) database.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fluent-plugin-5rocks'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-5rocks
+
+## Configuration
+
+```apache
+<match dummy>
+  type 5rocks
+
+  app_id xxxxxxxxxxxxxxxx
+  app_key XXXXXXXXXXXXXXXXX
+
+  <field>
+    type custom
+    name test_from_plugin
+    category cat_1
+    p1 test_p_1
+    p2 test_p_2
+    user_id test_user
+    uv1 $(fld_s)
+    uv2 $(fld_t)
+    <values>
+      abc $(fld_i)
+    </values>
+  </field>
+</match>
+```
+
+`$(xxx)` expression is provided to load a field data from a fluentd record.
+
+## Contributing
+
+1. Fork it ( https://github.com/groovenauts/fluent-plugin-5rocks/fork )
+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 a new Pull Request

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-5rocks.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-5rocks"
+  spec.version       = "0.0.1"
+  spec.authors       = ["hokuts"]
+  spec.email         = ["hokuto.sh@gmail.com"]
+  spec.summary       = %q{Fluentd plugin to store data into 5Rocks}
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_runtime_dependency "fluentd"
+  spec.add_development_dependency "webmock"
+end

data/lib/fluent/plugin/out_5rocks.rb

@@ -0,0 +1,77 @@
+class Fluent::FiveRocksOutput < Fluent::BufferedOutput
+  Fluent::Plugin.register_output('5rocks', self)
+
+  config_param :url_base, :string, :default => "https://server.api.5rocks.io/sev/1/"
+
+  attr_reader :url, :field_map
+
+  def initialize
+    super
+    require 'net/http'
+    require 'uri'
+    require "time"
+  end
+
+  def configure(conf)
+    super
+    @url = "#{@url_base}#{conf['app_id']}"
+    @field_map = {
+      'app_key' => conf['app_key'],
+      'name' => conf['name'],
+    }
+    @field_map['category'] = conf['category'] if conf['category']
+    conf.elements.select { |e|
+      e.name == "field"
+    }.each { |f|
+      f.each_key { |k| @field_map[k] = f[k]}
+
+      f.elements.select { |ee|
+        ee.name == "values"
+      }.each { |m|
+        m.each_key{ |k| @field_map["values[#{k}]"] = m[k]}
+      }
+    }
+  end
+
+  def start
+    super
+  end
+
+  def shutdown
+    super
+  end
+
+  def format(tag, time, record)
+    [tag, time, record].to_msgpack
+  end
+
+  def write(chunk)
+    ret = []
+    chunk.msgpack_each do |tag, time, record|
+      log.debug "tag: #{tag}, record: #{record}"
+
+      params = @field_map.each_with_object({}) do |(k, v), p|
+        if /^\$\(([^)]+)\)$/ =~ v
+          p[k] = record[$1] # can be ::String, ::Numeric, etc.
+        else
+          p[k] = v ? v.gsub(/\$\(([^)]+)\)/) { record[$1] } : nil # ::String
+        end
+      end
+      t = params["time"] || time
+      t = Time.parse(t) if t.is_a?(::String)
+      t = t.to_f * 1000 if t.is_a?(::Date) or t.is_a?(::Time)
+      t = [t / 1000, t, t * 1000].min_by { |_t| (Time.now.to_f * 1000 - _t).abs } # to milliseconds
+      t = t.to_i
+      params["time"] = t
+
+      log.debug "request parameters: #{params}"
+      res = Net::HTTP.post_form(URI.parse(@url), params)
+      log.debug "response code: #{res.code}"
+      log.debug "response body: #{res.body}"
+      
+      ret << params
+      raise "failed to insert into 5rocks" unless res.code == "201"
+    end
+    return ret
+  end
+end

data/test/helper.rb

@@ -0,0 +1,30 @@
+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'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/out_5rocks'
+require 'webmock/test_unit'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_5rocks.rb

@@ -0,0 +1,128 @@
+require 'helper'
+# require 'time'
+
+class FiveRocksOutputTest < Test::Unit::TestCase
+
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    app_id test_app_id
+    app_key test_app_key
+    <field>
+      type custom
+      name test_from_plugin
+      category cat_a
+      p1 prefix_$(data_key)
+      <values>
+        key_a val_a
+        key_b $(data_key)
+      </values>
+    </field>
+  ]
+
+  def create_driver(conf=CONFIG)
+    Fluent::Test::BufferedOutputTestDriver.new(Fluent::FiveRocksOutput).configure(conf)
+  end
+
+  def e(name, arg = '', attrs = {}, elements = [])
+    attrs = attrs.inject({}){ |m, (k, v)| m[k.to_s] = v; m }
+    Fluent::Config::Element.new(name, arg, attrs, elements)
+  end
+
+  def test_configure
+    ### set configurations
+    d = create_driver
+    ### check configurations
+    assert_equal 'https://server.api.5rocks.io/sev/1/test_app_id', d.instance.url
+    expected = {
+      "app_key" => "test_app_key",
+      "type" => "custom",
+      "name" => "test_from_plugin",
+      "category" => "cat_a",
+      "p1" => "prefix_$(data_key)",
+      "values[key_a]" => "val_a",
+      "values[key_b]" => "$(data_key)",
+    }
+    assert_equal expected, d.instance.field_map
+  end
+
+  def test_format_and_write
+    d = create_driver
+
+    time = Time.parse("2014-12-08 18:20:30 UTC").to_i
+    d.emit({"data_key" => 7}, time)
+    d.emit({"data_key" => 5}, time)
+
+    d.expect_format ["test", time, {"data_key" => 7}].to_msgpack
+    d.expect_format ["test", time, {"data_key" => 5}].to_msgpack
+
+    stub_request(:post, 'https://server.api.5rocks.io/sev/1/test_app_id').to_return(:status => [201, "Created"])
+    params = d.run
+    expected = [
+      {
+        "app_key" => "test_app_key", "type" => "custom", "name" => "test_from_plugin", "category" => "cat_a",
+        "p1" => "prefix_7", "values[key_a]" => "val_a", "values[key_b]" => 7, "time" => (time * 1000).to_i
+      },
+      {
+        "app_key" => "test_app_key", "type" => "custom", "name" => "test_from_plugin", "category" => "cat_a",
+        "p1" => "prefix_5", "values[key_a]" => "val_a", "values[key_b]" => 5, "time" => (time * 1000).to_i
+      }
+    ]
+    assert_equal expected, params
+  end
+
+  def test_format_and_write_dfferent_time
+    times = [
+      Time.parse("2014-12-08 18:10:00 UTC"),
+      Time.parse("2014-12-08 18:10:01 UTC"),
+    ]
+    d = create_driver(%[
+      app_id test_app_id
+      app_key test_app_key
+      <field>
+        type custom
+        name test_from_plugin
+        category cat_a
+        p1 prefix_$(data_key)
+        p2 $(data_key)$(data_key)
+        time $(time)
+        <values>
+          key_a val_a
+          key_b $(data_key)
+        </values>
+      </field>
+    ])
+
+    d.emit({"data_key" => 7, "time" => times[0].to_i}, times[1].to_i) # sec
+    d.emit({"data_key" => 5, "time" => (times[0].to_f * 1000).to_i}, times[1].to_i) # millisec
+    d.emit({"data_key" => 3, "time" => (times[0].to_f * 1000000).to_i}, times[1].to_i) # microsec
+
+    d.expect_format ["test", times[1].to_i, {"data_key" => 7, "time" => times[0].to_i}].to_msgpack
+    d.expect_format ["test", times[1].to_i, {"data_key" => 5, "time" => (times[0].to_f * 1000).to_i}].to_msgpack
+    d.expect_format ["test", times[1].to_i, {"data_key" => 3, "time" => (times[0].to_f * 1000000).to_i}].to_msgpack
+
+    stub_request(:post, 'https://server.api.5rocks.io/sev/1/test_app_id').to_return(:status => [201, "Created"])
+    params = d.run
+    expected = [
+      {
+        "app_key" => "test_app_key", "type" => "custom", "name" => "test_from_plugin", "category" => "cat_a",
+        "p1" => "prefix_7", "p2" => "77",
+        "values[key_a]" => "val_a", "values[key_b]" => 7, "time" => (times[0].to_f * 1000).to_i
+      },
+      {
+        "app_key" => "test_app_key", "type" => "custom", "name" => "test_from_plugin", "category" => "cat_a",
+        "p1" => "prefix_5", "p2" => "55",
+        "values[key_a]" => "val_a", "values[key_b]" => 5, "time" => (times[0].to_f * 1000).to_i
+      },
+      {
+        "app_key" => "test_app_key", "type" => "custom", "name" => "test_from_plugin", "category" => "cat_a",
+        "p1" => "prefix_3", "p2" => "33",
+        "values[key_a]" => "val_a", "values[key_b]" => 3, "time" => (times[0].to_f * 1000).to_i
+      },
+    ]
+    assert_equal expected, params
+  end
+  
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-5rocks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- hokuts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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: webmock
+  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: 
+email:
+- hokuto.sh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-5rocks.gemspec
+- lib/fluent/plugin/out_5rocks.rb
+- test/helper.rb
+- test/plugin/test_out_5rocks.rb
+homepage: ''
+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 store data into 5Rocks
+test_files:
+- test/helper.rb
+- test/plugin/test_out_5rocks.rb