fluent-plugin-aliyunoss 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9630b26712bdb538975287ff9d33a87757dbc4ed
-  data.tar.gz: 8f9286f8394341f27e025155527be5b2cfecd98c
+  metadata.gz: ea5a93144d5435174567597623da043b85a89e29
+  data.tar.gz: 2518f372c9ba9d0b705de800e19e614a6bab1875
 SHA512:
-  metadata.gz: ad63aa7d5c39c28e17b5b29b8b241fc1e17b358e9aaa54091bc275db5db6cd4e885d9b3939bdb8187c611bac309eb345e6ff355b05bc2bf27658f14e95fca207
-  data.tar.gz: b6afd09ac3c68ca5ee6a018456cff871c3f760d67abde4f952e03e0bc6575d8880c1ddaa14d9072beb872baafbe6f26ee0337f6d9e507892f051695543c5f59e
+  metadata.gz: b0cf5872d90b84c2505777cbc8a2501713a52975538af73783dd11cd7ecee7efb610ef7ca8b53998176b3a9ec3d8e27cb8ab076818163f3d8b4dd191e1da0074
+  data.tar.gz: 16c615442400cbd1e27d5ec5e3c3a4bb43de1e18bd9f6b931fcc70f5366881af8a23cdfe606736be2ed6b6e6eb02fb9d071652ee6562eb04cb6a068b83a2297a

data/Gemfile

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

data/LICENSE

@@ -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.md

@@ -0,0 +1,85 @@
+# fluent-plugin-aliyunoss
+
+[Fluentd](https://fluentd.org/) output plugin to do something.
+
+aliyunoss output plugin buffers event logs in local file and upload it to aliyun oss periodically.
+it is support fluentd>=v0.14.0.
+
+## Installation
+
+### RubyGems
+
+```
+$ gem install fluent-plugin-aliyunoss
+```
+
+### Bundler
+
+Add following line to your Gemfile:
+
+```ruby
+gem "fluent-plugin-aliyunoss"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Configuration
+
+You can generate configuration template:
+
+```
+$ fluent-plugin-config-format output aliyunoss
+```
+
+ex:
+
+```
+<system>
+  workers 2
+  root_dir /var/log/fluentd
+</system>
+
+<source>
+  @type http
+  @id http_input
+
+  port 8888
+  <parse>
+    @type json
+    keep_time_key true
+  </parse>
+</source>
+
+<match debug.*>
+  @type aliyunoss
+  oss_key_id xxx_id
+  oss_key_secret xxx_secret
+  oss_bucket xxx_bucket
+  oss_endpoint xxx_endpoint
+
+  oss_path "project/${tag}/date=%Y-%m-%d/%{host}-worker#{ENV['SERVERENGINE_WORKER_ID']}-%Y%m%d%H%M%S-%{uuid}.gz"
+  <buffer tag,time>
+    @type file
+    path xxx
+    timekey 10
+    timekey_wait 10
+    timekey_use_utc true
+  </buffer>
+  <inject>
+    time_key fluentd_time
+    time_type string
+    time_format '%Y-%m-%d %H:%M:%S'
+    tag_key fluentd_tag
+  </inject>
+</match>
+```
+
+## Copyright
+
+* Copyright(c) 2019- junjie
+* License
+  * Apache License, Version 2.0

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs.push("lib", "test")
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.verbose = true
+  t.warning = true
+end
+
+task default: [:test]

data/fluent-plugin-aliyunoss.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name    = "fluent-plugin-aliyunoss"
+  spec.version = "0.2.0"
+  spec.authors = ["junjie"]
+  spec.email   = ["junjzh0205@gmail.com"]
+
+  spec.description   = "Aliyun OSS output plugin for Fluentd event collector"
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/899/fluent-plugin-aliyunoss"
+  spec.license       = "Apache-2.0"
+
+  test_files, files  = `git ls-files -z`.split("\x0").partition do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.files         = files
+  spec.executables   = files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = test_files
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "test-unit", "~> 3.0"
+  spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
+end

data/lib/fluent/plugin/out_aliyunoss.rb

@@ -0,0 +1,143 @@
+#
+# Copyright 2019- junjie
+#
+# 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.
+
+require "fluent/plugin/output"
+require 'fluent/log'
+require 'aliyun/oss'
+require 'zlib'
+require 'time'
+require 'tempfile'
+require 'securerandom'
+require 'socket'
+
+module Fluent
+	module Plugin
+		class AliyunossOutput < Fluent::Plugin::Output
+			Fluent::Plugin.register_output("aliyunoss", self)
+
+			helpers :formatter, :inject, :compat_parameters
+
+			DEFAULT_FORMAT_TYPE = "out_file"
+			DEFAULT_TIMEKEY = 60 * 60 * 24
+
+			desc "OSS access key id"
+			config_param :oss_key_id, :string
+			desc "OSS access key secret"
+			config_param :oss_key_secret, :string, secret: true
+			desc "OSS bucket name"
+			config_param :oss_bucket, :string
+			desc "OSS endpoint"
+			config_param :oss_endpoint, :string
+			desc "The format of OSS object keys path"
+			config_param :oss_path, :string, default: "${tag}/date=%Y-%m-%d/%{host}-worker#{ENV['SERVERENGINE_WORKER_ID']}-%{uuid}-%Y%m%d%H%M%S"
+			desc "Archive format on OSS"
+			config_param :store_as, :string, default: "gz"
+
+			config_section :format do
+				config_set_default :@type, DEFAULT_FORMAT_TYPE
+			end
+
+			config_section :buffer do
+				config_set_default :chunk_keys, ['time']
+				config_set_default :timekey, DEFAULT_TIMEKEY
+			end
+
+			def configure(conf)
+				super
+				compat_parameters_convert(conf, :formatter, :buffer, :inject, default_chunk_key: "time")
+
+				@json_formatter = formatter_create(usage: 'formatter_in_example_json', type: 'json')
+			end
+
+			def compress(chunk, tmp)
+				if @store_as == "orc"
+					# We just need a tmp file path, orc-tools convert won't work if file exists
+					output_path = tmp.path
+					tmp.delete
+					# Create a symlink with .json suffix, to fool orc-tools
+					chunk_path = File::realpath(chunk.path)
+					fake_path = "#{chunk_path}.json"
+					File::symlink(chunk_path, fake_path)
+
+					command = "orc-tools convert -o #{output_path} #{fake_path}"
+					log.debug "cmd: #{command}"
+					res = system command
+					unless res
+						raise "failed to execute java -jar /orc-tools.jar command. status = #{$?}"
+					end
+					File::unlink(fake_path)
+				else
+					res = system "gzip -c #{chunk.path} > #{tmp.path}"
+					unless res
+						log.warn "failed to execute gzip command. Fallback to GzipWriter. status = #{$?}"
+						begin
+							tmp.truncate(0)
+							gw = Zlib::GzipWriter.new(tmp)
+							chunk.write_to(gw)
+							gw.close
+						ensure
+							gw.close rescue nil
+						end
+					end
+				end
+			end
+
+			def process_object_key_format(chunk, key_format)
+				key_map = {
+					host: Socket.gethostname,
+					uuid: SecureRandom.hex(4),
+				}
+				result = key_format
+				key_map.each do |k, v|
+					result = result.gsub("%{#{k.to_s}}", v)
+				end
+				extract_placeholders(result, chunk.metadata)
+			end
+
+			def multi_workers_ready?
+				true
+			end
+
+			def start
+				super
+				@client = Aliyun::OSS::Client.new(
+					:endpoint => @oss_endpoint,
+					:access_key_id => @oss_key_id,
+					:access_key_secret => @oss_key_secret)
+
+				raise "Specific bucket not exists: #{@oss_bucket}" unless @client.bucket_exists? @oss_bucket
+
+				@bucket = @client.get_bucket(@oss_bucket)
+			end
+
+			def format(tag, time, record)
+				r = inject_values_to_record(tag, time, record)
+				@json_formatter.format(tag, time, r)
+			end
+
+			def write(chunk)
+				begin
+					f = Tempfile.new('oss-')
+					compress(chunk, f)
+					path = process_object_key_format(chunk, "#{@oss_path}.#{{@store_as}})
+					log.debug "output_path: #{f.path} oss_path: #{path}"
+					raise "Upload #{f.path} failed" unless @bucket.resumable_upload(path, f.path)
+				ensure
+					f.close(true)
+				end
+			end
+		end
+	end
+end

data/test/helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.expand_path("../../", __FILE__))
+require "test-unit"
+require "fluent/test"
+require "fluent/test/driver/output"
+require "fluent/test/helpers"
+
+Test::Unit::TestCase.include(Fluent::Test::Helpers)
+Test::Unit::TestCase.extend(Fluent::Test::Helpers)

data/test/plugin/test_out_aliyunoss.rb

@@ -0,0 +1,18 @@
+require "helper"
+require "fluent/plugin/out_aliyunoss.rb"
+
+class AliyunossOutputTest < Test::Unit::TestCase
+  setup do
+    Fluent::Test.setup
+  end
+
+  test "failure" do
+    flunk
+  end
+
+  private
+
+  def create_driver(conf)
+    Fluent::Test::Driver::Output.new(Fluent::Plugin::AliyunossOutput).configure(conf)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-aliyunoss
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - junjie
@@ -78,7 +78,15 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-aliyunoss.gemspec
+- lib/fluent/plugin/out_aliyunoss.rb
+- test/helper.rb
+- test/plugin/test_out_aliyunoss.rb
 homepage: https://github.com/899/fluent-plugin-aliyunoss
 licenses:
 - Apache-2.0
@@ -103,4 +111,6 @@ rubygems_version: 2.5.2.3
 signing_key: 
 specification_version: 4
 summary: Aliyun OSS output plugin for Fluentd event collector
-test_files: []
+test_files:
+- test/helper.rb
+- test/plugin/test_out_aliyunoss.rb