fluent-plugin-google-cloud-storage 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc04df508c4d34342b1bb5508122f8990f1a3649
+  data.tar.gz: 9b2f23328532dbcdef8683d5982373d7b0330651
+SHA512:
+  metadata.gz: cab1aad9019bac99499d8960fb81d840941085dd15f7aa9f50031e4d95e5f674a62e7a6add2490650f20bfe588379a1718ae3de5609656e8ac329bbccbec3f16
+  data.tar.gz: 3f75fa7be0a8f8206c2d5ff72657eba7c7f4692e92386f1b3a77ab6b1ab2e53d0d0dede026bb6b8a14e4d017623d5951964d4f975a39f588212c441656157ae9

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2012- TAGOMORI Satoshi
+
+   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,124 @@
+# fluent-plugin-google-cloud-storage
+
+[Fluentd](http://fluentd.org/) output plugin to write data into a [Google Cloud
+Storage](https://cloud.google.com/storage/) bucket.
+
+GoogleCloudStorageOutput slices data by time (specified unit), and store these
+data as file of plain text. You can specify to:
+
+* format whole data as serialized JSON, single attribute or separated multi attributes
+* or LTSV, labeled-TSV (see http://ltsv.org/ )
+* include time as line header, or not
+* include tag as line header, or not
+* change field separator (default: TAB)
+* add new line as termination, or not
+
+And you can specify output file path as 'path path/to/dir/access.%Y%m%d.log', then get 'path/to/dir/access.20120316.log' in your GCS bucket.
+
+## Configuration
+
+### GoogleCloudStorageOutput
+
+To store data by time,tag,json (same with 'type file') over WebHDFS:
+
+    <match access.**>
+      type google_cloud_storage
+      service_email SERVICE_ACCOUNT_EMAIL
+      service_pkcs12_path /path/to/key.p12
+      project_id name-of-project
+      bucket_id name-of-bucket
+      path path/to/access.%Y%m%d_%H.log
+    </match>
+
+To specify the pkcs12 file's password, use `service_pkcs12_password`:
+
+    <match access.**>
+      type google_cloud_storage
+      service_email SERVICE_ACCOUNT_EMAIL
+      service_pkcs12_path /path/to/key.p12
+      service_pkcs12_password SECRET_PASSWORD
+      project_id name-of-project
+      bucket_id name-of-bucket
+      path path/to/access.%Y%m%d_%H.log
+    </match>
+
+If you want JSON object only (without time or tag or both on header of lines), specify it by `output_include_time` or `output_include_tag` (default true):
+
+    <match access.**>
+      type google_cloud_storage
+      service_email SERVICE_ACCOUNT_EMAIL
+      service_pkcs12_path /path/to/key.p12
+      project_id name-of-project
+      bucket_id name-of-bucket
+      path path/to/access.%Y%m%d_%H.log
+      output_include_time false
+      output_include_tag  false
+    </match>
+
+To store data as LTSV without time and tag over WebHDFS:
+
+    <match access.**>
+      type google_cloud_storage
+      # ...
+      output_data_type ltsv
+    </match>
+
+Store data as TSV (TAB separated values) of specified keys, without time, with tag (removed prefix 'access'):
+
+    <match access.**>
+      type google_cloud_storage
+      # ...
+
+      field_separator TAB        # or 'SPACE', 'COMMA' or 'SOH'(Start Of Heading: \001)
+      output_include_time false
+      output_include_tag true
+      remove_prefix access
+
+      output_data_type attr:path,status,referer,agent,bytes
+    </match>
+
+If message doesn't have specified attribute, fluent-plugin-webhdfs outputs 'NULL' instead of values.
+
+To store data compressed (gzip only now):
+
+    <match access.**>
+      type google_cloud_storage
+      # ...
+
+      compress gzip
+    </match>
+
+### Performance notifications
+
+As GCS does not support appending to files, if you have multiple fluentd nodes,
+you most likely want to log to multiple files. You can use '${hostname}' or
+'${uuid:random}' placeholders in configuration for this purpose.
+
+For hostname:
+
+    <match access.**>
+      type google_cloud_storage
+      # ...
+      path log/access/%Y%m%d/${hostname}.log
+    </match>
+
+Or with random filename (to avoid duplicated file name only):
+
+    <match access.**>
+      type google_cloud_storage
+      # ...
+      path log/access/%Y%m%d/${uuid:random}.log
+    </match>
+
+With configurations above, you can handle all of files of '/log/access/20120820/*' as specified timeslice access logs.
+
+## TODO
+
+* docs?
+* patches welcome!
+
+## Copyright
+
+* Copyright (c) 2014- Hsiu-Fan Wang (hfwang@porkbuns.net)
+* License
+  * Apache License, Version 2.0

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/fluent-plugin-google-cloud-storage.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name          = "fluent-plugin-google-cloud-storage"
+  gem.version       = "0.3.2"
+  gem.authors       = ["Hsiu-Fan Wang"]
+  gem.email         = ["hfwang@porkbuns.net"]
+  gem.summary       = %q{Fluentd plugin to write data to Google Cloud Storage}
+  gem.description   = %q{Google Cloud Storage fluentd output}
+  gem.homepage      = "https://github.com/hfwang/fluent-plugin-google-cloud-storage"
+  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_development_dependency "rake"
+  gem.add_runtime_dependency "fluentd", '>= 0.10.53'
+  gem.add_runtime_dependency "fluent-mixin-plaintextformatter", '>= 0.2.1'
+  gem.add_runtime_dependency "fluent-mixin-config-placeholders", ">= 0.3.0"
+  gem.add_runtime_dependency "google-api-client", '~> 0.7'
+end

data/lib/fluent/plugin/out_google_cloud_storage.rb

@@ -0,0 +1,154 @@
+# -*- coding: utf-8 -*-
+
+require 'fluent/mixin/config_placeholders'
+require 'fluent/mixin/plaintextformatter'
+
+class Fluent::GoogleCloudStorageOutput < Fluent::TimeSlicedOutput
+  Fluent::Plugin.register_output('google_cloud_storage', self)
+
+  config_set_default :buffer_type, 'file'
+  config_set_default :time_slice_format, '%Y%m%d'
+
+  config_param :ignore_start_check_error, :bool, :default => false
+
+  include Fluent::Mixin::ConfigPlaceholders
+
+  config_param :service_email, :string
+  config_param :service_pkcs12_path, :string
+  config_param :service_pkcs12_password, :string, :default => "notasecret"
+  config_param :project_id, :string
+  config_param :bucket_id, :string
+  config_param :path, :string
+
+  config_param :compress, :default => nil do |val|
+      unless ["gz", "gzip"].include?(val)
+        raise ConfigError, "Unsupported compression algorithm '#{val}'"
+      end
+      val
+  end
+
+  # how many times of write failure before switch to standby namenode
+  # by default it's 11 times that costs 1023 seconds inside fluentd,
+  # which is considered enough to exclude the scenes that caused by temporary network fail or single datanode fail
+  config_param :failures_before_use_standby, :integer, :default => 11
+
+  include Fluent::Mixin::PlainTextFormatter
+
+  config_param :default_tag, :string, :default => 'tag_missing'
+
+  CHUNK_ID_PLACE_HOLDER = '${chunk_id}'
+
+  def initialize
+    super
+    require 'zlib'
+    require 'net/http'
+    require 'time'
+    require 'google/api_client'
+    require 'signet/oauth_2/client'
+  end
+
+  # Define `log` method for v0.10.42 or earlier
+  unless method_defined?(:log)
+    define_method("log") { $log }
+  end
+
+  def call_google_api(params)
+    # refresh_auth
+    if @google_api_client.authorization.expired?
+      @google_api_client.authorization.fetch_access_token!
+    end
+    return @google_api_client.execute(params)
+  end
+
+  def configure(conf)
+    if conf['path']
+      if conf['path'].index('%S')
+        conf['time_slice_format'] = '%Y%m%d%H%M%S'
+      elsif conf['path'].index('%M')
+        conf['time_slice_format'] = '%Y%m%d%H%M'
+      elsif conf['path'].index('%H')
+        conf['time_slice_format'] = '%Y%m%d%H'
+      end
+    end
+
+    super
+
+    @client = prepare_client()
+
+    if @path.index(CHUNK_ID_PLACE_HOLDER).nil?
+      raise Fluent::ConfigError, "path must contain ${chunk_id}, which is the placeholder for chunk_id, when append is set to false."
+    end
+  end
+
+  def prepare_client
+    @google_api_client = Google::APIClient.new(
+        :application_name => "fluent-plugin-google-cloud-storage",
+        :application_version => "0.3.1")
+    begin
+      key = Google::APIClient::KeyUtils.load_from_pkcs12(
+        @service_pkcs12_path, @service_pks12_password)
+      @google_api_client.authorization = Signet::OAuth2::Client.new(
+          token_credential_uri: "https://accounts.google.com/o/oauth2/token",
+          audience: "https://accounts.google.com/o/oauth2/token",
+          issuer: @service_email,
+          scope: "https://www.googleapis.com/auth/devstorage.read_write",
+          signing_key: key)
+      @google_api_client.authorization.fetch_access_token!
+    rescue Signet::AuthorizationError
+      raise Fluent::ConfigError, "Error occurred authenticating with Google"
+    end
+    @storage_api = @google_api_client.discovered_api("storage", "v1")
+    return @google_api_client
+  end
+
+  def start
+    super
+  end
+
+  def shutdown
+    super
+  end
+
+  def path_format(chunk_key)
+    Time.strptime(chunk_key, @time_slice_format).strftime(@path)
+  end
+
+  def chunk_unique_id_to_str(unique_id)
+    unique_id.unpack('C*').map{|x| x.to_s(16).rjust(2,'0')}.join('')
+  end
+
+  def send_data(path, data)
+    content_type = "application/json"
+
+    io = nil
+    if ["gz", "gzip"].include?(@compress)
+      io = StringIO.new("")
+      writer = Zlib::GzipWriter.new(io)
+      writer.write(data)
+      writer.finish
+      io.rewind
+    else
+      io = StringIO.new(data)
+    end
+
+    media = Google::APIClient::UploadIO.new(io, content_type, File.basename(path))
+
+    call_google_api(api_method: @storage_api.objects.insert,
+                    parameters: {
+                      uploadType: "multipart",
+                      project: @project_id,
+                      bucket: @bucket_id,
+                      name: path
+                    },
+                    body_object: { contentType: media.content_type },
+                    media: media)
+  end
+
+  def write(chunk)
+    hdfs_path = path_format(chunk.key).gsub(CHUNK_ID_PLACE_HOLDER, chunk_unique_id_to_str(chunk.unique_id))
+
+    send_data(hdfs_path, chunk.read)
+
+    hdfs_path
+  end
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fluent/test'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/out_google_cloud_storage'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_out_google_cloud_storage.rb

@@ -0,0 +1,76 @@
+require 'helper'
+
+class WebHDFSOutputTest < Test::Unit::TestCase
+  CONFIG = %[
+host namenode.local
+path /hdfs/path/file.%Y%m%d.log
+  ]
+
+  def create_driver(conf=CONFIG,tag='test')
+    Fluent::Test::OutputTestDriver.new(Fluent::WebHDFSOutput, tag).configure(conf)
+  end
+
+  def test_configure
+    d = create_driver
+    assert_equal 'namenode.local', d.instance.instance_eval{ @namenode_host }
+    assert_equal 50070, d.instance.instance_eval{ @namenode_port }
+    assert_equal '/hdfs/path/file.%Y%m%d.log', d.instance.path
+    assert_equal '%Y%m%d', d.instance.time_slice_format
+    assert_equal false, d.instance.httpfs
+    assert_nil d.instance.username
+    assert_equal false, d.instance.ignore_start_check_error
+    
+    assert_equal true, d.instance.output_include_time
+    assert_equal true, d.instance.output_include_tag
+    assert_equal 'json', d.instance.output_data_type
+    assert_nil d.instance.remove_prefix
+    assert_equal 'TAB', d.instance.field_separator
+    assert_equal true, d.instance.add_newline
+    assert_equal 'tag_missing', d.instance.default_tag
+
+    d = create_driver %[
+namenode server.local:14000
+path /hdfs/path/file.%Y%m%d.%H%M.log
+httpfs yes
+username hdfs_user
+]
+    assert_equal 'server.local', d.instance.instance_eval{ @namenode_host }
+    assert_equal 14000, d.instance.instance_eval{ @namenode_port }
+    assert_equal '/hdfs/path/file.%Y%m%d.%H%M.log', d.instance.path
+    assert_equal '%Y%m%d%H%M', d.instance.time_slice_format
+    assert_equal true, d.instance.httpfs
+    assert_equal 'hdfs_user', d.instance.username
+  end
+
+  def test_configure_placeholders
+    d = create_driver %[
+hostname testing.node.local
+namenode server.local:50070
+path /hdfs/${hostname}/file.%Y%m%d%H.log
+]
+    assert_equal '/hdfs/testing.node.local/file.%Y%m%d%H.log', d.instance.path
+  end
+
+  def test_path_format
+    d = create_driver
+    assert_equal '/hdfs/path/file.%Y%m%d.log', d.instance.path
+    assert_equal '%Y%m%d', d.instance.time_slice_format
+    assert_equal '/hdfs/path/file.20120718.log', d.instance.path_format('20120718')
+
+    d = create_driver %[
+namenode server.local:14000
+path /hdfs/path/file.%Y%m%d.%H%M.log
+]
+    assert_equal '/hdfs/path/file.%Y%m%d.%H%M.log', d.instance.path
+    assert_equal '%Y%m%d%H%M', d.instance.time_slice_format
+    assert_equal '/hdfs/path/file.20120718.1503.log', d.instance.path_format('201207181503')
+
+    assert_raise Fluent::ConfigError do
+      d = create_driver %[
+            namenode server.local:14000
+            path /hdfs/path/file.%Y%m%d.%H%M.log
+            append false
+          ]
+    end
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-google-cloud-storage
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- Hsiu-Fan Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.53
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.53
+- !ruby/object:Gem::Dependency
+  name: fluent-mixin-plaintextformatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: fluent-mixin-config-placeholders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: google-api-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Google Cloud Storage fluentd output
+email:
+- hfwang@porkbuns.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-google-cloud-storage.gemspec
+- lib/fluent/plugin/out_google_cloud_storage.rb
+- test/helper.rb
+- test/plugin/test_out_google_cloud_storage.rb
+homepage: https://github.com/hfwang/fluent-plugin-google-cloud-storage
+licenses:
+- APLv2
+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.2
+signing_key: 
+specification_version: 4
+summary: Fluentd plugin to write data to Google Cloud Storage
+test_files:
+- test/helper.rb
+- test/plugin/test_out_google_cloud_storage.rb