fluent-plugin-hekk_redshift 0.0.4

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.DS_Store
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,191 @@
+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:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+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
+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.md

@@ -0,0 +1,162 @@
+Amazon Redshift output plugin for Fluentd
+========
+
+## Overview
+
+Amazon Redshift output plugin uploads event logs to an Amazon Redshift Cluster. Supportted data formats are csv, tsv and json. An S3 bucket and a Redshift Cluster are required to use this plugin.
+
+## Installation
+
+    gem install fluent-plugin-hekk_redshift
+
+## Configuration
+
+Format:
+
+    <match my.tag>
+        type redshift
+
+        # s3 (for copying data to redshift)
+        aws_key_id YOUR_AWS_KEY_ID
+        aws_sec_key YOUR_AWS_SECRET_KEY
+        s3_bucket YOUR_S3_BUCKET
+        s3_endpoint YOUR_S3_BUCKET_END_POINT
+        path YOUR_S3_PATH
+        timestamp_key_format year=%Y/month=%m/day=%d/hour=%H/%Y%m%d-%H%M
+
+        # redshift
+        redshift_host YOUR_AMAZON_REDSHIFT_CLUSTER_END_POINT
+        redshift_port YOUR_AMAZON_REDSHIFT_CLUSTER_PORT
+        redshift_dbname YOUR_AMAZON_REDSHIFT_CLUSTER_DATABASE_NAME
+        redshift_user YOUR_AMAZON_REDSHIFT_CLUSTER_USER_NAME
+        redshift_password YOUR_AMAZON_REDSHIFT_CLUSTER_PASSWORD
+        redshift_schemaname YOUR_AMAZON_REDSHIFT_CLUSTER_TARGET_SCHEMA_NAME
+        redshift_tablename YOUR_AMAZON_REDSHIFT_CLUSTER_TARGET_TABLE_NAME
+        redshift_copy_command_tablename YOUR_REDSHIFT_COPY_COMMAND_TABLE_NAME
+        redshift_copy_command_columnname YOUR_REDSHIFT_COPY_COMMAND_TABLE_COLUMN_NAME
+        file_type [tsv|csv|json|msgpack]
+
+        # buffer
+        buffer_type file
+        buffer_path /var/log/fluent/redshift
+        flush_interval 15m
+        buffer_chunk_limit 1g
+    </match>
+
+Example (watch and upload json formatted apache log):
+
+    <source>
+        type tail
+        path redshift_test.json
+        pos_file redshift_test_json.pos
+        tag redshift.json
+        format /^(?<log>.*)$/
+    </source>
+
+    <match redshift.json>
+        type redshift
+
+        # s3 (for copying data to redshift)
+        aws_key_id YOUR_AWS_KEY_ID
+        aws_sec_key YOUR_AWS_SECRET_KEY
+        s3_bucket hapyrus-example
+        s3_endpoint s3.amazonaws.com
+        path path/on/s3/apache_json_log/
+        timestamp_key_format year=%Y/month=%m/day=%d/hour=%H/%Y%m%d-%H%M
+
+        # redshift
+        redshift_host xxx-yyy-zzz.xxxxxxxxxx.us-east-1.redshift.amazonaws.com
+        redshift_port 5439
+        redshift_dbname fluent-redshift-test
+        redshift_user fluent
+        redshift_password fluent-password
+        redshift_tablename apache_log
+        redshift_copy_command_tablename copy_commands
+        redshift_copy_command_columnname copy_command
+        file_type json
+
+        # buffer
+        buffer_type file
+        buffer_path /var/log/fluent/redshift
+        flush_interval 15m
+        buffer_chunk_limit 1g
+    <match>
+
++ `type` (required) : The value must be `redshift`.
+
++ `aws_key_id` (required) : AWS access key id to access s3 bucket.
+
++ `aws_sec_key` (required) : AWS securet key id to access s3 bucket.
+
++ `s3_bucket` (required) : s3 bucket name. S3 bucket must be same as the region of your Redshift cluster.
+
++ `s3_endpoint` : s3 endpoint.
+
++ `path` (required) : s3 path to input.
+
++ `timestamp_key_format` : The format of the object keys. It can include date-format directives.
+
+  - Default parameter is "year=%Y/month=%m/day=%d/hour=%H/%Y%m%d-%H%M"
+  - For example, the s3 path is as following with the above example configration.
+    <pre>
+  hapyrus-example/apache_json_log/year=2013/month=03/day=05/hour=12/20130305_1215_00.gz
+  hapyrus-example/apache_json_log/year=2013/month=03/day=05/hour=12/20130305_1230_00.gz
+</pre>
+
++ `redshift_host` (required) : the end point(or hostname) of your Amazon Redshift cluster.
+
++ `redshift_port` (required) : port number.
+
++ `redshift_dbname` (required) : database name.
+
++ `redshift_user` (required) : user name.
+
++ `redshift_password` (required) : password for the user name.
+
++ `redshift_tablename` (required) : table name to store data.
+
++ `redshift_schemaname` : schema name to store data. By default, this option is not set and find table without schema as your own search_path.
+
++ `redshift_copy_command_tablename` (required) : table name for copy command.
+
++ `redshift_copy_command_columnname` (required) : column name for copy command.
+
++ `file_type` : file format of the source data.  `csv`, `tsv`, `msgpack` or `json` are available.
+
++ `delimiter` : delimiter of the source data. This option will be ignored if `file_type` is specified.
+
++ `buffer_type` : buffer type.
+
++ `buffer_path` : path prefix of the files to buffer logs.
+
++ `flush_interval` : flush interval.
+
++ `buffer_chunk_limit` : limit buffer size to chunk.
+
++ `utc` : utc time zone. This parameter affects `timestamp_key_format`.
+
+## Logging examples
+```ruby
+# examples by fluent-logger
+require 'fluent-logger'
+log = Fluent::Logger::FluentLogger.new(nil, :host => 'localhost', :port => 24224)
+
+# file_type: csv
+log.post('your.tag', :log => "12345,12345")
+
+# file_type: tsv
+log.post('your.tag', :log => "12345\t12345")
+
+# file_type: json
+require 'json'
+log.post('your.tag', :log => { :user_id => 12345, :data_id => 12345 }.to_json)
+
+# file_type: msgpack
+log.post('your.tag', :user_id => 12345, :data_id => 12345)
+```
+
+## License
+
+Copyright (c) 2013 [Hapyrus Inc](http://hapyrus.com)
+
+[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/plugin/*.rb']
+  test.verbose = true
+end
+
+task :coverage do |t|
+  ENV['COVERAGE'] = '1'
+  Rake::Task["test"].invoke
+end
+
+task :default => [:build]

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/fluent-plugin-hekk_redshift.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "fluent-plugin-hekk_redshift"
+  gem.version       = File.read("VERSION").strip
+  gem.authors       = ["Masashi Miyazaki"]
+  gem.email         = ["mmasashi@gmail.com"]
+  gem.description   = %q{Amazon Redshift output plugin for Fluentd}
+  gem.summary       = gem.description
+  gem.homepage      = "https://github.com/hekk/fluent-plugin-redshift"
+  gem.has_rdoc      = false
+  gem.license       = 'APLv2'
+
+  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 "aws-sdk", ">= 1.6.3"
+  gem.add_dependency "pg", "~> 0.16.0"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "simplecov", ">= 0.5.4"
+  gem.add_development_dependency "flexmock", ">= 1.3.1"
+end