fluent-plugin-storage-memcached 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d0575e5218b0927557533a19c1135c55f5b09abf
+  data.tar.gz: 8192009a393180d49b3a8081d4d9b77ffcd419ff
+SHA512:
+  metadata.gz: beeb6b5c4888c9c5373eeccc4325d0dadf85426843a2ab561b9e15745070514aef6d7974c7d820fb0da9c38c6a32394caddb72a82f09c701b4c1270f6eeff628
+  data.tar.gz: 7be9d3c6f60283c92f462d72d81e9f65567e5a26e6fea3e2adf6efe4d8337f3ae3297f47bf76af20edfef126edc5078180600a462003c7a4067f36f85643950e

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+services:
+  - memcached
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3.3
+  - 2.4.0
+gemfile:
+  - Gemfile
+before_install:
+  - gem update bundler

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fluent-plugin-storage-memcached.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,49 @@
+# fluent-plugin-storage-memcached
+
+[![Build Status](https://travis-ci.org/cosmo0920/fluent-plugin-storage-memcached.svg?branch=master)](https://travis-ci.org/cosmo0920/fluent-plugin-storage-memcached)
+
+fluent-plugin-storage-memcached is a fluent plugin to store plugin state into memcached.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fluent-plugin-storage-memcached'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-storage-memcached
+
+## Configuration
+
+```aconf
+<storage>
+  @type memcached
+
+  path my_key # or conf.arg will be used as redis key
+  host localhost     # localhost is default
+  port 11211         # 11211 is default
+  namespace app_v1   # app_v1 is default
+  compress true      # true is default
+  # If sasl enabled memcached server is configured, please specify them.
+  # username fluenter
+  # password hogefuga
+  serializer yajl    # yajl is default
+  expires_in 0       # 0 is default
+</storage>
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cosmo0920/fluent-plugin-storage-memcached.
+
+
+## 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/memcached"
+
+# 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-memcached.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-memcached"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Hiroshi Hatake"]
+  spec.email         = ["cosmo0920.oucc@gmail.com"]
+
+  spec.summary       = %q{Fluentd storage plugin for Memcached.}
+  spec.description   = %q{Fluentd storage plugin for Memcached.}
+  spec.homepage      = "https://github.com/cosmo0920/fluent-plugin-storage-memcached"
+  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 "dalli", "~> 2.7.0"
+end

data/lib/fluent/plugin/storage_memcached.rb

@@ -0,0 +1,127 @@
+require 'json'
+require 'dalli'
+require 'fluent/plugin/storage'
+
+module Fluent
+  module Plugin
+    class MemcachedStorage < Storage
+      Fluent::Plugin.register_storage('memcached', self)
+
+      config_param :path, :string, default: nil
+      config_param :host, :array, default: 'localhost'
+      config_param :port, :integer, default: 11211
+      config_param :namespace, :string, default: 'app_v1'
+      config_param :compress, :bool, default: true
+      config_param :username, :string, default: nil
+      config_param :password, :string, default: nil, secret: true
+      config_param :serializer, :enum, list: [:yajl, :json, :marshal], default: :yajl
+      config_param :expires_in, :integer, default: 0
+      # Set persistent true by default
+      config_set_default :persistent, true
+
+      attr_reader :store # for test
+
+      def initialize
+        super
+
+        @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
+
+        @serializer = case @serializer
+                     when :yajl
+                       Yajl
+                     when :json
+                       JSON
+                     when :marshal
+                       Marshal
+                     end
+
+        options = {
+          thread_safe: true,
+          namespace: @namespace,
+          compress: @compress,
+          serializer: @serializer,
+          expires_on: @expires_in,
+        }
+        options[:username] = @username if @username
+        options[:password] = @password if @password
+
+        @memcached = Dalli::Client.new("#{@host}:#{@port}", options)
+
+        object = @memcached.get(@path)
+        if object
+          begin
+            data = @serializer.load(object)
+            raise Fluent::ConfigError, "Invalid contents (not object) in plugin memcached storage: '#{@path}'" unless data.is_a?(Hash) unless data.is_a?(Hash)
+          rescue => e
+            log.error "failed to read data from plugin redis storage", path: @path, error: e
+            raise Fluent::ConfigError, "Unexpected error: failed to read data from plugin memcached storage: '#{@path}'"
+          end
+        end
+      end
+
+      def multi_workers_ready?
+        true
+      end
+
+      def persistent_always?
+        true
+      end
+
+      def load
+        begin
+          json_string = @memcached.get(@path)
+          json = @serializer.load(json_string)
+          unless json.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 = json
+        rescue => e
+          log.error "failed to load data for plugin storage from memcached", path: @path, error: e
+        end
+      end
+
+      def save
+        begin
+          json_string = @serializer.dump(@store)
+          @memcached.set(@path, json_string)
+        rescue => e
+          log.error "failed to save data for plugin storage to memcached", path: @path, error: e
+        end
+      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
+    end
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-storage-memcached
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hiroshi Hatake
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-20 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: dalli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+description: Fluentd storage plugin for Memcached.
+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-memcached.gemspec
+- lib/fluent/plugin/storage_memcached.rb
+homepage: https://github.com/cosmo0920/fluent-plugin-storage-memcached
+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 Memcached.
+test_files: []