fluent-plugin-storage-mongo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f92c1ab802709f91b4621de0647a350c57c8083
+  data.tar.gz: 3eb59a886d0a1f82b8a4f09b6246f6268f565cb7
+SHA512:
+  metadata.gz: a3330e09aac3131c289f47ed84997ec13f309e72a263d89a5386ef6307b6be7413f931ecd73afa95b5ae63ccbdf8a89b9de4333c0d1337baec94eaf151ae4dbd
+  data.tar.gz: 940e09ed5c593d8429ea7f30014f9d36fef29daba6543a48bd11f4e16e7a4c23c5b37e3d8036188cf0e86f717e418224e0086d5f6f4092e7ff0cba5b9cb6780a

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3.3
+  - 2.4.0
+
+before_install:
+  - gem install bundler
+
+script:
+  - bundle exec rake test
+
+addons:
+  apt:
+    sources:
+      - mongodb-upstart
+      - mongodb-3.0-precise
+    packages:
+      - mongodb-org-server
+      - mongodb-org-shell

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Hiroshi Hatake
+
+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,64 @@
+# Mongo Storage plugin for Fluent
+
+[![Build Status](https://travis-ci.org/cosmo0920/fluent-plugin-storage-mongo.svg?branch=master)](https://travis-ci.org/cosmo0920/fluent-plugin-storage-mongo)
+
+fluent-plugin-storage-mongo is a fluentd plugin to store plugin state into mongodb.
+
+## Prerequisite
+
+* MongoDB 3.0 or later.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fluent-plugin-storage-mongo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-storage-mongo
+
+## Configuration
+
+Use _mongo_ type in store.
+
+```aconf
+<store>
+  @type mongo
+  database fluent
+  collection test
+
+  # Following attibutes are optional
+  host fluenter
+  port 10000
+
+  # capped option is not implemented yet.
+
+  # Set 'user' and 'password' for authentication
+  user handa
+  password shinobu
+
+  # Other buffer configurations here
+</store>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cosmo0920/fluent-plugin-storage-mongo.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fluent/plugin/storage/mongo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fluent-plugin-storage-mongo.gemspec

@@ -0,0 +1,37 @@
+# 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-storage-mongo"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Hiroshi Hatake"]
+  spec.email         = ["cosmo0920.oucc@gmail.com"]
+
+  spec.summary       = %q{Fluentd storage plugin for MongoDB.}
+  spec.description   = %q{Fluentd storage plugin for MongoDB.}
+  spec.homepage      = "https://github.com/cosmo0920/fluent-plugin-storage-mongo"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "test-unit", "~> 3.2.0"
+  spec.add_dependency "fluentd", [">= 0.14.12", "< 2"]
+  spec.add_dependency "mongo", "~> 2.4.0"
+end

data/lib/fluent/plugin/logger_support.rb

@@ -0,0 +1,25 @@
+module Fluent::Plugin
+  module LoggerSupport
+    def self.included(klass)
+      klass.instance_eval {
+        desc "MongoDB log level"
+        config_param :mongo_log_level, :string, default: 'info'
+      }
+    end
+
+    def configure_logger(mongo_log_level)
+      Mongo::Logger.level = case @mongo_log_level.downcase
+                            when 'fatal'
+                              Logger::FATAL
+                            when 'error'
+                              Logger::ERROR
+                            when 'warn'
+                              Logger::WARN
+                            when 'info'
+                              Logger::INFO
+                            when 'debug'
+                              Logger::DEBUG
+                            end
+    end
+  end
+end

data/lib/fluent/plugin/mongo_auth.rb

@@ -0,0 +1,34 @@
+module Fluent
+  module Plugin
+    module MongoAuthParams
+      def self.included(klass)
+        klass.instance_eval {
+          desc "MongoDB user"
+          config_param :user, :string, default: nil
+          desc "MongoDB password"
+          config_param :password, :string, default: nil, secret: true
+          desc "MongoDB authentication database"
+          config_param :auth_source, :string, default: nil
+        }
+      end
+    end
+
+    module MongoAuth
+      def authenticate(client)
+        unless @user.nil? || @password.nil?
+          begin
+            if @auth_source.nil?
+              client = client.with(user: @user, password: @password)
+            else
+              client = client.with(user: @user, password: @password, auth_source: @auth_source)
+            end
+          rescue Mongo::Auth::Unauthorized => e
+            log.fatal e
+            exit!
+          end
+        end
+        client
+      end
+    end
+  end
+end

data/lib/fluent/plugin/storage_mongo.rb

@@ -0,0 +1,196 @@
+require 'mongo'
+require 'fluent/plugin/storage'
+require 'fluent/plugin/mongo_auth'
+require 'fluent/plugin/logger_support'
+
+module Fluent
+  module Plugin
+    class MongoStorage < Storage
+      Fluent::Plugin.register_storage('mongo', self)
+
+      attr_reader :store # for test
+
+      include Fluent::Plugin::MongoAuthParams
+      include Fluent::Plugin::MongoAuth
+      include Fluent::Plugin::LoggerSupport
+
+      config_param :path, :string, default: nil
+      desc "MongoDB collection"
+      config_param :collection, :string, default: "unspecified"
+      desc "MongoDB database"
+      config_param :database, :string
+      desc "MongoDB host"
+      config_param :host, :string, default: 'localhost'
+      desc "MongoDB port"
+      config_param :port, :integer, default: 27017
+      desc "MongoDB write_concern"
+      config_param :write_concern, :integer, default: nil
+      desc "MongoDB journaled"
+      config_param :journaled, :bool, default: false
+      desc "Replace dot with specified string"
+      config_param :replace_dot_in_key_with, :string, default: nil
+      desc "Replace dollar with specified string"
+      config_param :replace_dollar_in_key_with, :string, default: nil
+
+      # SSL connection
+      config_param :ssl, :bool, default: false
+      config_param :ssl_cert, :string, default: nil
+      config_param :ssl_key, :string, default: nil
+      config_param :ssl_key_pass_phrase, :string, default: nil, secret: true
+      config_param :ssl_verify, :bool, default: false
+      config_param :ssl_ca_cert, :string, default: nil
+
+      attr_reader :client_options, :collection_options
+
+      def initialize
+        super
+
+        @client_options = {}
+        @collection_options = {capped: false}
+        @store = {}
+      end
+
+      def configure(conf)
+        super
+
+        unless @path
+          if conf && !conf.arg.empty?
+            @path = conf.arg
+          else
+            raise Fluent::ConfigError, "path or conf.arg for <storage> is required."
+          end
+        end
+
+        @client_options[:write] = {j: @journaled}
+        @client_options[:write].merge!({w: @write_concern}) unless @write_concern.nil?
+        @client_options[:ssl] = @ssl
+
+        if @ssl
+          @client_options[:ssl_cert] = @ssl_cert
+          @client_options[:ssl_key] = @ssl_key
+          @client_options[:ssl_key_pass_phrase] = @ssl_key_pass_phrase
+          @client_options[:ssl_verify] = @ssl_verify
+          @client_options[:ssl_ca_cert] = @ssl_ca_cert
+        end
+        configure_logger(@mongo_log_level)
+
+        @client = client
+        @client = authenticate(@client)
+      end
+
+      def multi_workers_ready?
+        true
+      end
+
+      def load
+        begin
+          value = {}
+          documents = @client[format_collection_name(@collection)].find(_id: @path)
+          if documents.count >= 1
+            documents.each do |document|
+              value.merge!(document)
+            end
+          end
+          value.delete('_id')
+          unless value.is_a?(Hash)
+            log.error "broken content for plugin storage (Hash required: ignored)", type: json.class
+            log.debug "broken content", content: json_string
+            return
+          end
+          @store = value
+        rescue => e
+          log.error "failed to load data for plugin storage from mongo", path: @path, error: e
+        end
+      end
+
+      def save
+        operate(format_collection_name(@collection), @store)
+      end
+
+      def get(key)
+        @store[key.to_s]
+      end
+
+      def fetch(key, defval)
+        @store.fetch(key.to_s, defval)
+      end
+
+      def put(key, value)
+        @store[key.to_s] = value
+      end
+
+      def delete(key)
+        @store.delete(key.to_s)
+      end
+
+      def update(key, &block)
+        @store[key.to_s] = block.call(@store[key.to_s])
+      end
+
+      private
+
+      def client
+        @client_options[:database] = @database
+        @client_options[:user] = @user if @user
+        @client_options[:password] = @password if @password
+        Mongo::Client.new(["#{@host}:#{@port}"], @client_options)
+      end
+
+      FORMAT_COLLECTION_NAME_RE = /(^\.+)|(\.+$)/
+
+      def format_collection_name(collection_name)
+        formatted = collection_name
+        formatted = formatted.gsub(FORMAT_COLLECTION_NAME_RE, '')
+        formatted = @collection if formatted.size == 0 # set default for nil tag
+        formatted
+      end
+
+      def format_key(record)
+        if @replace_dot_in_key_with
+          replace_key_of_hash(record, ".", @replace_dot_in_key_with)
+        end
+        if @replace_dollar_in_key_with
+          replace_key_of_hash(record, /^\$/, @replace_dollar_in_key_with)
+        end
+        record
+      end
+
+      def operate(collection, record)
+        begin
+          record = format_key(record)
+
+          @client[collection, @collection_options].update_one({_id: @path}, record, {upsert: true})
+        rescue Mongo::Error::BulkWriteError => e
+          log.warn "document is not inserted. Maybe this document is invalid as a BSON."
+        rescue ArgumentError => e
+          log.warn e
+        end
+        record
+      end
+
+      # copied from https://github.com/fluent/fluent-plugin-mongo/blob/c989ae01d21513c8d45b5338431586542aa93b0d/lib/fluent/plugin/out_mongo.rb#L223-L244
+      def replace_key_of_hash(hash_or_array, pattern, replacement)
+        case hash_or_array
+        when Array
+          hash_or_array.map do |elm|
+            replace_key_of_hash(elm, pattern, replacement)
+          end
+        when Hash
+          result = Hash.new
+          hash_or_array.each_pair do |k, v|
+            k = k.gsub(pattern, replacement)
+
+            if v.is_a?(Hash) || v.is_a?(Array)
+              result[k] = replace_key_of_hash(v, pattern, replacement)
+            else
+              result[k] = v
+            end
+          end
+          result
+        else
+          hash_or_array
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-storage-mongo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hiroshi Hatake
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.12
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.12
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+description: Fluentd storage plugin for MongoDB.
+email:
+- cosmo0920.oucc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fluent-plugin-storage-mongo.gemspec
+- lib/fluent/plugin/logger_support.rb
+- lib/fluent/plugin/mongo_auth.rb
+- lib/fluent/plugin/storage_mongo.rb
+homepage: https://github.com/cosmo0920/fluent-plugin-storage-mongo
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Fluentd storage plugin for MongoDB.
+test_files: []