fluent-plugin-ncmb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3e2983ba819aa5da64ae6216e57190a184c7c65
+  data.tar.gz: 6649e8c8be26ee4d02338f4e890aa045ac332fc1
+SHA512:
+  metadata.gz: 46c951ee79313cbe92660b726cf21197db0d73e0aebe6a055adcf32cfb0b26dfa445f73d03558bc4058beda5afba676a6c9b75feb3a1d93ffa5bbac488407816
+  data.tar.gz: 53fe82d9933830435f17aff6381ca777e02f5dc0c33a987b126f14b9c846d90187610bc1b7d36cc65631947fa9c1e31c3f9d388e76a2f66fea5d5e6e5b4485ed

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+pos_file

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.3
+before_install: gem install bundler -v 1.10.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-ncmb.gemspec
+gem 'test-unit', '3.1.2'
+gem 'fluentd', '0.12.12'
+gem 'ncmb-ruby-client'
+gem 'test-unit-rr', '1.0.3'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 suzuki.yuta
+
+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,51 @@
+fluent-plugin-ncmb: NIFTYCloud-mbaas plugin for Fluentd
+====
+
+
+## Installation
+
+```
+$ gem install fluent-plugin-ncmb
+```
+
+## Usage
+
+### input configulation
+
+```
+<source>
+  type                ncmb
+  tag                 TAG
+  application_key     YOUR_APPLICATION_KEY
+  client_key          YOUR_CLIENT_KEY
+  class_name          CLASS_NAME
+  api_version         YYYY-MM-DD            (default: 2013-09-01)
+  pos_file_path       POS_FILE_PATH         (default: ./pos_file)
+
+  interval            [min]                 (default: 10)
+  field               [field]               (default: all)
+  start_date          [YYYY-MM-DD HH:MM:SS] (default: now)
+  limit               [limit]               (default: 1000)
+</source>
+```
+
+### output configulation
+
+```
+<match **>
+  type                ncmb
+  application_key     YOUR_APPLICATION_KEY
+  client_key          YOUR_CLIENT_KEY
+  api_version         YYYY-MM-DD            (default: 2013-09-01)
+  class_name          CLASS_NAME
+
+  buffer_path         [path]
+  failed_log_path     [path]                (defualt: /var/log/fluent/ncmb)
+  buffer_chunk_limit  [byte]                (default: 32m)
+  flush_interval      [second]              (default: 60)
+</match>
+```
+
+### Supported Ruby Versions
+- Ruby 2.1
+- Ruby 2.2

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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fluent/plugin/ncmb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fluent-plugin-ncmb.gemspec

@@ -0,0 +1,34 @@
+# 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-ncmb"
+  spec.version       = "0.1.0"
+  spec.authors       = ["suzuki.yuta", "goya.tomohiro"]
+  spec.email         = ["suzuki.yuta@nifty.co.jp", "goya.tomohiro@nifty.co.jp"]
+
+  spec.summary       = "This gem is a fluentd plugin of NiftyCloud-MobileBackend"
+  spec.homepage      = 'http://mb.cloud.nifty.com/'
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "fluentd", [">= 0.10.9", "< 2"]
+  spec.add_development_dependency "ncmb-ruby-client", "~> 0.1"
+  spec.add_development_dependency "test-unit-rr", ">= 1.0.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rb-readline"
+end

data/lib/fluent/plugin/file_pos_entry.rb

@@ -0,0 +1,47 @@
+
+module Fluent
+  class FilePositionEntry
+    require 'pathname'
+
+    def initialize(file_path)
+      @pos_file = file_path
+    end
+
+    def update_pos(pos)
+      return unless @pos_file
+
+      begin
+        f = Pathname.new(@pos_file)
+        f.open('wb') do |fp|
+          Marshal.dump({
+            :date => "#{pos[:date]}",
+            :id   => "#{pos[:id]}",
+          }, fp)
+        end
+      rescue => e
+        $log.warn "Can't write pos_file #{e}"
+      end
+    end
+
+    def read_pos
+      min_date = "0000-01-01T00:00:00.000Z"
+
+      return unless @pos_file
+      f = Pathname.new(@pos_file)
+      unless f.exist? then
+        return ({:date=> min_date, :id=> ""})
+      end
+      
+      pos = {}
+      begin
+        f.open('rb') do |_f|
+          pos = Marshal.load(_f)
+        end
+      rescue => e
+        return ({:date=> min_date, :id=> ""})
+      end
+      
+      return (pos)
+    end
+  end
+end

data/lib/fluent/plugin/in_ncmb.rb

@@ -0,0 +1,129 @@
+module Fluent
+  class NcmbInput < Fluent::Input
+    Fluent::Plugin.register_input('ncmb', self);
+
+    require 'date'
+    require 'ncmb'
+    require './lib/fluent/plugin/file_pos_entry'
+    include NCMB
+
+    config_param :tag,             :string,  :default => nil
+    config_param :application_key, :string,  :default => nil
+    config_param :client_key,      :string,  :default => nil
+    config_param :class_name,      :string,  :default => nil
+    config_param :api_version,     :string,  :default => '2013-09-01'
+    config_param :pos_file_path,   :string,  :default => './pos_file'
+
+    config_param :interval,        :integer, :default => 10
+    config_param :field,           :string,  :default => nil
+    config_param :start_date,      :string,  :default => nil
+    config_param :limit,           :integer, :default => 1000
+
+    SORT_FIELD = "createDate,objectId"
+    attr_reader :pos_entry
+    attr_reader :last_pos
+
+    def configure(conf)
+      super
+
+      raise Fluent::ConfigError.new("ConfigError: Please input tag") if @tag.nil?
+      raise Fluent::ConfigError.new("ConfigError: Please input application_key") if @application_key.nil?
+      raise Fluent::ConfigError.new("ConfigError: Please input client_key") if @client_key.nil?
+      raise Fluent::ConfigError.new("ConfigError: Please input class_name") if @class_name.nil?
+      raise Fluent::ConfigError.new("ConfigError: Please input pos_file_path") if @pos_file_path.nil?
+
+      @ncmb_client = NCMB.initialize application_key: @application_key, client_key: @client_key
+      @pos_entry = FilePositionEntry.new(@pos_file_path)
+      @last_pos = @pos_entry.read_pos()
+
+      @path = "/#{@api_version}/classes/#{@class_name}"
+
+      unless @start_date.nil? then
+        @start_date = DateTime.parse(@start_date)
+      else
+        @start_date = DateTime.now
+      end
+    end
+
+    def start()
+      super;
+      
+      @ncmb_thread = Thread.new(&method(:run))
+    end
+
+    def shutdown()
+      @pos_entry.update_pos(@last_pos)
+      @ncmb_thread.terminate()
+    end
+
+    def run()
+      loop {
+        loop {
+          records = load_records();
+          if records.length == 0 then
+            break;
+          end
+
+          time = Time.now.to_i;
+          @router.emit(@tag, time, records)
+        } 
+
+        sleep(@interval * 60);
+      }
+    end
+
+    def load_records()
+      queries = {}
+      queries[:limit] = @limit + 1
+      queries[:order] = SORT_FIELD
+      queries[:where] = create_where_query(@start_date)
+
+      items = @ncmb_client.get @path, queries
+      items = remove_emitted_record(items)
+
+      if items.length > 0 then
+        @last_pos[:date] = items[-1][:createDate]
+        @last_pos[:id]   = items[-1][:objectId]
+      end
+
+      records = []
+      if @field.nil? then
+        records = items 
+      else  
+        items.each do |item|
+          records << {@field.intern => item[@field.intern]}
+        end
+      end
+
+      return (records)
+    end
+
+    def remove_emitted_record(items)
+      result_items = []
+      items[:results].each do |item|
+        if item[:createDate] > @last_pos[:date] then
+          result_items << item
+        elsif item[:createDate] == @last_pos[:date] then
+          if item[:objectId] > @last_pos[:id] then
+            result_items << item
+          end
+        end
+      end
+
+      return result_items
+    end
+
+    def create_where_query(conf_start_date)
+      start_date = DateTime.parse(@last_pos[:date])
+      if conf_start_date > start_date then
+        start_date = conf_start_date
+      end
+  
+      query = ""
+      start_date_str = start_date.strftime("%FT%T.%LZ")
+      query = "{\"createDate\": {\"$gte\": {\"__type\":\"Date\", \"iso\":\"#{start_date_str}\"}}}"
+
+      return (query)
+    end
+  end
+end

data/lib/fluent/plugin/out_ncmb.rb

@@ -0,0 +1,101 @@
+module Fluent
+  class NcmbOutput < Fluent::BufferedOutput
+    # First, register the plugin. NAME is the name of this plugin
+    # and identifies the plugin in the configuration file.
+    Fluent::Plugin.register_output('ncmb', self)
+
+    # required
+    config_param :application_key,  :string,  default: nil
+    config_param :client_key,       :string,  default: nil
+    config_param :class_name,       :string,  default: nil
+
+    config_param :api_version,      :string,  default: '2013-09-01'
+    config_param :failed_log_path,  :string,  default: '/var/log/fluent/ncmb_failed.log'
+    config_param :buffer_type,      :string,  default: 'file'
+    config_param :retry_limit,      :integer, default: 3
+
+    attr_reader :ncmb
+
+    # This method is called before starting.
+    def configure(conf)
+      super
+
+      raise Fluent::ConfigError.new("ConfigError: Please input application_key") if @application_key.nil?
+      raise Fluent::ConfigError.new("ConfigError: Please input client_key") if @client_key.nil?
+      raise Fluent::ConfigError.new("ConfigError: Please input class_name") if @class_name.nil?
+
+      require 'ncmb'
+      @ncmb = NCMB.initialize(application_key: @application_key, client_key: @client_key)
+    end
+
+    # This method is called when starting.
+    def start
+      super
+
+      @path = "/#{@api_version}/classes/#{@class_name}"
+      @mutex = Mutex.new
+    end
+
+    # This method is called when shutting down.
+    def shutdown
+      super
+    end
+
+    def format(tag, time, record)
+      [tag, time, record].to_msgpack
+    end
+
+    def write(chunk)
+      records = []
+      failed_records = []
+
+      @mutex.lock
+      begin
+        chunk.msgpack_each do |tag, time, record|
+          records << [tag, time, record]
+        end
+      ensure
+        @mutex.unlock
+      end
+
+      # batchAPIの件数上限が50のため、50件毎に実行する
+      records.each_slice(50) do |slice|
+        bulk_insert(slice)
+      end
+    end
+
+    def bulk_insert(records)
+      requests = records.map {|tag, time, record|
+        {path: @path, method: :POST, body: {tag: tag, time: time, record: record}}
+      }
+      cnt = 0
+      while cnt < @retry_limit
+        begin
+          res = @ncmb.post("/#{@api_version}/batch", requests: requests)
+        rescue
+          # リクエストが失敗した場合
+          next cnt += 1
+        end
+
+        # レスポンスがエラーだった場合
+        if res.is_a?(Hash) && res.has_key?(:code)
+          next cnt += 1
+        else
+          return
+        end
+      end
+
+      # retry上限を超えても送信できなかった場合、送信失敗logに書き込む
+      write_failed_log(records)
+      return
+    end
+
+    def write_failed_log(records)
+      msgpack = records.map{|record| format(*record)}.to_msgpack
+      File.open(@failed_log_path, 'a+') do |file|
+        file.sync = true
+        file.write(msgpack)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-ncmb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- suzuki.yuta
+- goya.tomohiro
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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.10.9
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.9
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: ncmb-ruby-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.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: rb-readline
+  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:
+- suzuki.yuta@nifty.co.jp
+- goya.tomohiro@nifty.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fluent-plugin-ncmb.gemspec
+- lib/fluent/plugin/file_pos_entry.rb
+- lib/fluent/plugin/in_ncmb.rb
+- lib/fluent/plugin/out_ncmb.rb
+homepage: http://mb.cloud.nifty.com/
+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.4.5
+signing_key: 
+specification_version: 4
+summary: This gem is a fluentd plugin of NiftyCloud-MobileBackend
+test_files: []