fluent-plugin-arango 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+*.swp
+*~
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/AUTHORS

@@ -0,0 +1,2 @@
+tamtam180 <kirscheless _at_ gmail.com>
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-arango.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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,138 @@
+= ArangoDB plugin for Fluentd
+
+fluent-plugin-arango provides write to {ArangoDB}[http://www.arangodb.org/] for {Fluentd}[http://fluentd.org/].
+
+= Install
+
+  $ fluent-gem install fluent-plugin-arango
+
+= Configuration
+
+== Minimum Configuration
+
+  <match access.**>
+    type arango
+    collection my_collection_name
+  </match>
+
+== Supported Configurations
+
+  <match access.**>
+
+    # plugin type
+    type arango
+
+    # required
+    collection my_collection_name
+
+    # optional host-config
+    host localhost
+    port 8529
+
+    # optional auth-config
+    username xxxx
+    password xxxx
+
+    # optional time-config (provided by Fluent::SetTimeKeyMixin)
+    include_time_key true
+    time_key time
+    ##time_format
+    ##localtime
+    ##utc
+
+    # optional tag-config (proviced by Fluent::SetTagKeyMixin)
+    include_tag_key true
+    tag_key tag
+
+    # optinal parent-class-config (proviced by Fluent::BufferedOutput)
+    buffer_type memory
+    flush_interval 60
+    retry_limit 17
+    retry_wait 1.0
+    num_threads 1
+    ##<secondary>
+    ##secondary_limit
+    
+  </match>
+
+= Examples
+
+== Example: Basically Output
+
+*Configure*
+
+  <match hoge>
+    type arango
+    collection fuga
+  </match>
+
+*Result*
+  IN: {"a": 1}
+  OUT: {"a":1, "tag": "hoge", "time": "2013-02-18T12:59:10Z"}
+
+
+== Example: Does not include a time,tag key
+
+*Configure*
+
+  <match hoge>
+    type arango
+    collection fuga
+    include_time_key false
+    include_tag_key false
+  </match>
+
+*Result*
+  IN: {"a": 1}
+  OUT: {"a":1}
+
+== Example: Change time format, and Change time,tag key name
+
+*Configure*
+
+  <match hoge>
+    type arango
+    collection fuga
+    time_format %Y/%m/%d %H:%M:%S
+    time_key mytime
+    tag_key  mytag
+  </match>
+
+*Result*
+  IN: {"a": 1}
+  OUT: {"a":1, "mytag": "hoge", "mytime": "2013/02/18 12:59:10"}
+
+
+== Example: Connect to ArangoDB with authenticate
+
+*Configure*
+
+  <match hoge>
+    type arango
+    collection fuga
+    username your_name
+    password your_pass
+  </match>
+
+= Attention
+
+time and tag is destructive operation.
+( see: http://d.hatena.ne.jp/oranie/20120525/1337942598 )
+
+= TODO
+
+* Bulk import
+* UnitTest for auth
+
+= Dependency Library
+
+* {ashikawa-core}[https://github.com/triAGENS/ashikawa-core/]
+
+
+= Copyright and License
+
+Copyright:: Copyright (c) 2013- tamtam180 <kirscheless _at_ gmail.com>
+License:: Apache License, Version 2.0
+
+
+

data/Rakefile

@@ -0,0 +1,12 @@
+#coding: utf-8
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => :build
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/plugin/*.rb']
+  test.verbose = true
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/fluent-plugin-arango.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "fluent-plugin-arango"
+  gem.version       = File.read("VERSION").strip
+  gem.authors       = ["tamtam180"]
+  gem.email         = ["kirscheless@gmail.com"]
+  gem.description   = %q{ArangoDB plugin for Fluent event collector}
+  gem.summary       = %q{ArangoDB plugin for Fluent event collector}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "fluentd", "~> 0.10.0"
+  gem.add_dependency "ashikawa-core", "~> 0.5.1"
+  gem.add_development_dependency "rake", ">= 0.9.2"
+
+end

data/lib/fluent/plugin/out_arango.rb

@@ -0,0 +1,74 @@
+#coding: utf-8
+
+module Fluent
+  class ArangoOutput < BufferedOutput
+    Fluent::Plugin.register_output('arango', self)
+    
+    include Fluent::SetTagKeyMixin
+    config_set_default :include_tag_key, true
+
+    include Fluent::SetTimeKeyMixin
+    config_set_default :include_time_key, true
+
+    config_param :scheme, :string, :default => 'http'
+    config_param :host, :string, :default => 'localhost'
+    config_param :port, :integer, :default => 8529
+    config_param :collection, :string
+    config_param :username, :string, :default => nil
+    config_param :password, :string, :default => nil
+
+    def initialize
+      super
+      require 'ashikawa-core'
+      require 'msgpack'
+
+      @db = nil
+      @conn = nil
+      @col = nil
+    end
+
+    def configure(conf)
+      super
+    end
+
+
+    def start
+      super
+
+      @conn = Ashikawa::Core::Connection.new(get_arango_url)
+      if @username && @password then
+        @conn.authenticate_with(:username => @username, :password => @password)
+      end
+      @db = Ashikawa::Core::Database.new(@conn)
+      @col = @db[@collection]
+    end
+
+    def shutdown
+      # MEMO: Ashikawa-Core has not finalize-method.
+      super
+    end
+
+    def format(tag, time, record)
+      return record.to_msgpack
+    end
+
+    #def emit(tag, es, chain)
+    #end
+
+    def write(chunk)
+      # TODO: Change to bulk import if Ashikawa-core implemented.
+      chunk.msgpack_each do |record|
+        @col.create(record)
+      end
+    end
+
+
+    private
+
+    def get_arango_url
+      return "#{@scheme}://#{@host}:#{@port}"
+    end
+
+  end
+end
+

data/test/plugin/out_arango.rb

@@ -0,0 +1,123 @@
+# coding: utf-8
+require 'fluent/test'
+require 'ashikawa-core'
+require 'msgpack'
+
+class ArangoOutputTest < Test::Unit::TestCase
+  
+  DEFAULT_COL = 'ut_col'
+  DEFAULT_HOST = 'localhost'
+  DEFAULT_PORT = 8529
+  CONFIG = %[
+    type arango
+    collection  #{DEFAULT_COL}
+    host        #{DEFAULT_HOST}
+    port        #{DEFAULT_PORT}
+  ]
+  ARANGO_URL = "http://#{DEFAULT_HOST}:#{DEFAULT_PORT}"
+  
+  def setup
+    Fluent::Test.setup
+    # HACK: Avoid Error "Encoding::UndefinedConversionError: U+00FC from UTF-8 to ASCII-8BIT"
+    Encoding.default_internal = Encoding::UTF_8
+    require 'fluent/plugin/out_arango'
+
+    # TODO: AUTH case
+    # TODO: Start/Stop ArangoDB from Ruby-Script
+
+    # drop collection
+    @con = Ashikawa::Core::Connection.new(ARANGO_URL)
+    @db = Ashikawa::Core::Database.new(@con)
+    @col = @db[DEFAULT_COL]
+    @col.delete
+
+  end
+  
+  def teardown
+    
+  end
+
+  def create_driver(conf = CONFIG)
+    return Fluent::Test::BufferedOutputTestDriver.new(Fluent::ArangoOutput).configure(conf)
+  end
+
+  def test_configure_no_parameter
+    # assert_throws .. 
+    begin
+      driver = create_driver(%[
+        type arango
+      ])
+      flunk "fail"
+    rescue Fluent::ConfigError
+      assert_equal $!.message, "'collection' parameter is required"
+    rescue
+      flunk "fail"
+    end
+  end
+
+  def test_configure
+    d = create_driver(%[
+      type arango
+      collection ut_col
+    ])
+    assert_equal 'ut_col', d.instance.collection
+    # default parameter
+    assert_equal 'http', d.instance.scheme
+    assert_equal 'localhost', d.instance.host
+    assert_equal 8529, d.instance.port
+    assert_equal nil, d.instance.username
+    assert_equal nil, d.instance.password
+  end
+
+  def test_format
+    d = create_driver()
+    
+    tag = "test"
+    time = Time.parse("2013-02-28 23:59:59 UTC").to_i  # 1362095999
+    d.emit({"a" => 1}, time)
+    d.emit({"a" => 2}, time)
+
+    d.expect_format({"a" => 1, "tag" => tag, "time" => "2013-02-28T23:59:59Z"}.to_msgpack)
+    d.expect_format({"a" => 2, "tag" => tag, "time" => "2013-02-28T23:59:59Z"}.to_msgpack)
+
+    d.run
+  end
+
+  def test_format_time
+    d = create_driver(CONFIG + %[
+      time_format %Y-%m-%d %H:%M:%S
+      time_key mytime
+    ])
+    d.emit({"a" => 1}, Time.parse("2013-02-28 23:59:59 UTC").to_i)
+    
+    d.expect_format({"a" => 1, "tag" => "test", "mytime" => "2013-02-28 23:59:59"}.to_msgpack)
+
+    d.run
+  end
+
+  def test_write
+
+    d = create_driver()
+    
+    tag = "test"
+    time = Time.parse("2012-02-28 23:59:59 UTC").to_i
+    d.emit({"b" => 1}, time)
+    d.emit({"b" => 2}, time)
+    d.run
+
+    # MEMO: first_example does not running.. bug?
+    #cursor = @col.query.execute(%[FOR t IN #{DEFAULT_COL} FILTER t.b == 1 RETURN t])
+    doc1 = @col.query.by_example(b:1).detect{true}
+    assert_equal 1, doc1["b"]
+    assert_equal tag, doc1["tag"]
+    assert_equal "2012-02-28T23:59:59Z", doc1["time"]
+
+    doc2 = @col.query.by_example(b:2).detect{true}
+    assert_equal 2, doc2["b"]
+    assert_equal tag, doc2["tag"]
+    assert_equal "2012-02-28T23:59:59Z", doc2["time"]
+
+  end
+
+end
+

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-arango
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- tamtam180
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: ashikawa-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: ArangoDB plugin for Fluent event collector
+email:
+- kirscheless@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- AUTHORS
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- fluent-plugin-arango.gemspec
+- lib/fluent/plugin/out_arango.rb
+- test/plugin/out_arango.rb
+homepage: ''
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ArangoDB plugin for Fluent event collector
+test_files:
+- test/plugin/out_arango.rb