fluent-plugin-azuretables 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 717265673ec738d28e0944107c0c914db730d802
+  data.tar.gz: 8744a23d087250c75451f7ad64b71332fa1cf18e
+SHA512:
+  metadata.gz: 637d2208fcb7116c36bec17e81391f8aa9e1d9976d62746ce5f19f9479efcb94227c0c04ad38cef98c2269be582d2b3bd2a130df1885e9f851fe8b7f30483add
+  data.tar.gz: 503e67abc865fea869c37cc8af53e20fb0952a5ef96149eb5346645ab6db712febdf32f477e3b0895930bc121982c7237c7d02c429aa483ca5b5817acce04832

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# ChangeLog
+
+- - -
+### Version 0.1.0
+###### 08 Sep 2015 ######
+* Very first commit.
+
+- - -

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) <2015> <Anh Phong (dev.hibiki@gmail.com)>
+
+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,39 @@
+# Azure Tables output plugin for [Fluentd](http://www.fluentd.org/)
+
+## Installation
+
+```ruby
+fluent-gem install fluent-plugin-azuretables
+```
+
+## Usage
+
+### Configuration
+```
+<match azuretables.**>
+  type azuretables
+  account_name AZURE_STORAGE_ACCOUNT
+  access_key AZURE_STORAGE_ACCESS_KEY
+  table YOUR_TABLE_NAME
+  detach_process 6
+  create_table_if_not_exists false
+  partition_keys test-partition-key-01,test-partition-key-02
+  row_keys rk1 test-row-key-01,test-row-key-02
+  key_delimiter __
+</match>
+```
+
+* type (required) - azuretables
+* account_name (required) - AZURE_STORAGE_ACCOUNT (from your Azure portal).
+* access_key (required) - AZURE_STORAGE_ACCESS_KEY (from your Azure portal).
+* table (required) - table name where you want to store event records.
+* detach_process (optional) - number of processes. You can launch multiprocessing if you need high throughput.
+* create_table_if_not_exists (optional) - Set __true__ if you want create table if it doesn't exist. Default: __false__.
+* partition_keys (optional) - A string with comma delimiter.List of properties which are used to create a composite __PartitionKey__.
+* row_keys (optional) - A string with comma delimiter.List of properties which are used to create a composite __RowKey__.
+* key_delimiter (optional) - A string becomes delimiter of partition key and row key in table. Default: "__" (underscores x2)
+
+## TODO
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at [https://github.com/heocoi/fluent-plugin-azuretables](https://github.com/heocoi/fluent-plugin-azuretables).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/fluent-plugin-azuretables.gemspec

@@ -0,0 +1,26 @@
+# 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-azuretables"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Anh Phong"]
+  spec.email         = ["dev.hibiki@gmail.com"]
+  spec.summary       = %q{Fluent plugin to add event record into Azure Tables Storage.}
+  spec.description   = %q{Fluent plugin to add event record into Azure Tables Storage.}
+  spec.homepage      = "https://github.com/heocoi/fluent-plugin-azuretables"
+  spec.licenses      = ["MIT"]
+  spec.has_rdoc      = false
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "fluentd", '~> 0'
+  spec.add_dependency "azure", '~> 0'
+  spec.add_dependency "msgpack", '~> 0'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/fluent/plugin/out_azuretables.rb

@@ -0,0 +1,143 @@
+# coding: utf-8
+require 'azure'
+require 'msgpack'
+
+module Fluent
+  class AzuretablesOutput < BufferedOutput
+    Plugin.register_output('azuretables', self)
+
+    include DetachMultiProcessMixin
+
+    ENTITY_SIZE_LIMIT = 1024*1024 # 1MB
+    BATCHWRITE_ENTITY_LIMIT = 100
+    BATCHWRITE_SIZE_LIMIT = 4*1024*1024 # 4MB
+
+    # config_param defines a parameter
+    config_param :account_name, :string                                 # your azure storage account
+    config_param :access_key, :string                                   # your azure storage access key
+    config_param :table, :string                                        # azure storage table name
+    config_param :create_table_if_not_exists, :bool, :default => false
+    config_param :key_delimiter, :string, :default => '__'
+    config_param :partition_keys, :string, :default => nil
+    config_param :row_keys, :string, :default => nil
+
+    # This method is called before starting.
+    # 'conf' is a Hash that includes configuration parameters.
+    # If the configuration is invalid, raise Fluent::ConfigError.
+    def configure(conf)
+      super
+      unless @partition_keys.nil?
+        @partition_key_array = @partition_keys.split(',')
+      end
+
+      unless @row_keys.nil?
+        @row_key_array = @row_keys.split(',')
+      end
+    end
+
+    # connect azure table storage service
+    def start
+      super
+      unless @account_name.nil? || @access_key.nil?
+        Azure.config.storage_account_name = @account_name
+        Azure.config.storage_access_key = @access_key
+      end
+
+      detach_multi_process do
+        super
+
+        begin
+          @azure_table_service = Azure::Table::TableService.new
+          # create table if not exits
+          @azure_table_service.create_table(@table) if !table_exists?(@table) && @create_table_if_not_exists
+        rescue Exception => e
+          log.error e
+          exit!
+        end
+      end
+    end
+
+    def table_exists?(table_name)
+      begin
+        @azure_table_service.get_table(table_name)
+        true
+      rescue Azure::Core::Http::HTTPError => e
+        false
+      rescue Exception => e
+        log.fatal "UnknownError: '#{e}'"
+        exit!
+      end
+    end
+
+    # This method is called when shutting down.
+    def shutdown
+      super
+    end
+
+    # create entity from event record
+    def format(tag, time, record)
+      partition_keys = []
+      row_keys = []
+      record.each_pair do |name, val|
+        if @partition_key_array.include?(name)
+          partition_keys << val
+          record.delete(name)
+        elsif @row_key_array.include?(name)
+          row_keys << val
+          record.delete(name)
+        end
+      end
+
+      entity = Hash.new
+      entity['partition_key'] = partition_keys.join(@key_delimiter)
+      entity['row_key'] = row_keys.join(@key_delimiter)
+      entity['entity_values'] = record
+      entity.to_msgpack
+    end
+
+    def format_key(record, keys, key_delimiter)
+      ret = []
+      record.each_pair do |name, val|
+        ret << val if keys.include?(name)
+      end
+      ret.join(key_delimiter)
+    end
+
+    def write(chunk)
+      batch_size = 0
+      group_entities = Hash.new
+      chunk.msgpack_each do |entity|
+        partition_key = entity['partition_key']
+        group_entities[partition_key] = [] unless group_entities.has_key?(partition_key)
+        group_entities[partition_key] << entity
+        batch_size += entity.to_json.length
+        if group_entities[partition_key].size >= BATCHWRITE_ENTITY_LIMIT || batch_size >= BATCHWRITE_SIZE_LIMIT
+          insert_entities(partition_key, group_entities[partition_key])
+          group_entities[partition_key] = []
+          batch_size = 0
+        end
+      end
+      unless group_entities.empty?
+        group_entities.each_pair do |partition_key, entities|
+          insert_entities(partition_key, entities)
+        end
+      end
+    end
+
+    def insert_entities(partition_key, entities)
+      begin
+        batch = Azure::Table::Batch.new(@table, partition_key) do
+          entities.each do |entity|
+            insert entity['row_key'], entity['entity_values']
+          end
+        end
+        return @azure_table_service.execute_batch(batch)
+      rescue Exception => e
+        log.fatal "UnknownError: '#{e}'"
+        log.debug partition_key
+        log.debug entities.inspect
+      end
+    end
+
+  end # class
+end # module

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-azuretables
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Anh Phong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-15 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: azure
+  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: msgpack
+  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: 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'
+description: Fluent plugin to add event record into Azure Tables Storage.
+email:
+- dev.hibiki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-azuretables.gemspec
+- lib/fluent/plugin/out_azuretables.rb
+homepage: https://github.com/heocoi/fluent-plugin-azuretables
+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.0.rc.1
+signing_key: 
+specification_version: 4
+summary: Fluent plugin to add event record into Azure Tables Storage.
+test_files: []