fluent-plugin-time-sampling 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 145704aa65c1245200718d754dbea24378f8dfe4
+  data.tar.gz: a7996a3de0b496bcd2478f97d43294ec36ae586d
+SHA512:
+  metadata.gz: 572092b8d47eb567810d86638921e9cf4455e4d7edc0c5e29e320c5fc923686a72409bdae3365be764e310be08ed7c949c92605200af2ce29815e72a9f7488c1
+  data.tar.gz: b8550d42301a3ed1ee563892a17c75d92132499bd7bd2a0b49761cd2048444dc65f0e1a8f62372e2499801c9e7b66bff72d7bcf9b6fbe62c18ed6eeaefc5b4ef

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2018 eramuk
+
+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,41 @@
+# fluent-plugin-time-sampling
+
+## Installation
+```
+gem install fluent-plugin-time-sampling
+```
+
+## Usage
+Example:
+```
+<filter test.**>
+  @type time_sampling
+  unit ${tag}, hostname, sample_key1
+  interval 10
+  keep_keys hostname, sample_key2
+</filter>
+```
+
+Assume following input in 10 seconds:
+```
+sample.tag { "hostname": "host1", "sample_key1": "foo", "sample_key2": "aaa" }
+sample.tag { "hostname": "host1", "sample_key1": "foo", "sample_key2": "bbb" }
+sample.tag { "hostname": "host2", "sample_key1": "bar", "sample_key2": "ccc" }
+```
+
+then output is below:
+```
+sample.tag { "hostname": "host1", "sample_key2": "aaa" }
+sample.tag { "hostname": "host2", "sample_key2": "ccc" }
+```
+
+## Configuration
+
+### unit
+Specify keys for grouping.
+
+### interval
+Time of filtering interval. default is 60 second.
+
+### keep_keys
+Specify output keys. default is all keys.

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
+  test.warning = false
+end
+
+task :default => :test

data/fluent-plugin-time-sampling.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "fluent-plugin-time-sampling"
+  gem.version       = "0.1.1"
+  gem.authors       = ["Yuki Kuwabara"]
+  gem.email         = ["eramuk@gmail.com"]
+  gem.summary       = "filtering record at prescribed intervals"
+  gem.description   = gem.summary
+  gem.homepage      = "https://github.com/eramuk/fluent-plugin-time-sampling"
+  gem.licenses      = ["MIT"]
+
+  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_runtime_dependency "fluentd", "~> 0.12.0"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "test-unit"
+end

data/lib/fluent/plugin/filter_time_sampling.rb

@@ -0,0 +1,81 @@
+require "fluent/output"
+require "fluent/time"
+require "fluent/timezone"
+require "fluent/config/error"
+require "date"
+
+module Fluent
+  class TimeSamplingFilter < Filter
+    Plugin.register_filter('time_sampling', self)
+
+    config_param :unit, :array, value_type: :string
+    config_param :keep_keys, :array, value_type: :string, default: []
+    config_param :interval, :time, default: 60
+
+    def configure(conf)
+      super
+      @cache = {}
+      @cache_period = @interval * 2
+      @interval = -1 if @interval.zero?
+      @unused_cache_clear_interval = 300
+      @unused_cache_clear_time = Time.now
+    end
+
+    def start
+      super
+    end
+
+    def shutdown
+      super
+    end
+
+    def filter(tag, time, record)
+      cache_key = @unit.map do |unit|
+        if unit != "${tag}" && !record.has_key?(unit)
+          raise "#{unit}: unit not found"
+        end
+        unit != "${tag}" ? record[unit] : tag
+      end.join(":")
+
+      @keep_keys.each do |key|
+        unless record.has_key?(key)
+          raise "#{key}: keep_keys not found"
+        end
+      end
+
+      unless cache(cache_key)
+        cache(cache_key, "")
+        new_record = @keep_keys.empty? ?
+          record.dup : record.select { |k, v| @keep_keys.include?(k) }
+      end
+
+      if Time.now > @unused_cache_clear_time + @unused_cache_clear_interval
+        clear_unused_cache
+        @unused_cache_clear_time = Time.now
+      end
+
+      new_record ||= nil
+    end
+
+    def cache(key, data = nil)
+      if data.nil?
+        @cache[key] ||= { :time => Time.at(0) }
+        expired = Time.now > @cache[key][:time]
+        expired ? nil : @cache[key][:data]
+      else
+        @cache[key] = {
+          :data => data,
+          :time => Time.now + @interval
+        }
+      end
+    end
+
+    def clear_unused_cache
+      @cache.each_key do |key|
+        expired = Time.now > @cache[key][:time] + @cache_period
+        @cache.delete(key) if expired
+      end
+    end
+
+  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/filter_time_sampling'
+
+class Test::Unit::TestCase
+end

data/test/plugin/test_filter_time_sampling.rb

@@ -0,0 +1,33 @@
+require "helper"
+
+class TimeSamplingFilterTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %q{
+    unit ${tag}, sample_key1
+    keep_keys sample_key2
+  }
+
+  def create_driver(conf = CONFIG, tag = "test")
+    Fluent::Test::FilterTestDriver.new(Fluent::TimeSamplingFilter, tag).configure(conf)
+  end
+
+  def test_filter
+    sample_records = [
+      {"sample_key1" => "foo", "sample_key2" => "aaa"},
+      {"sample_key1" => "foo", "sample_key2" => "bbb"},
+      {"sample_key1" => "bar", "sample_key2" => "ccc"},
+    ]
+    d = create_driver
+    d.run {
+      sample_records.each do |records|
+        d.filter(records, Time.now)
+      end
+    }
+    filtered = d.filtered_as_array
+    p filtered.map {|m| m[2] }
+  end
+
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-time-sampling
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Yuki Kuwabara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !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: test-unit
+  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'
+description: filtering record at prescribed intervals
+email:
+- eramuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-time-sampling.gemspec
+- lib/fluent/plugin/filter_time_sampling.rb
+- test/helper.rb
+- test/plugin/test_filter_time_sampling.rb
+homepage: https://github.com/eramuk/fluent-plugin-time-sampling
+licenses:
+- MIT
+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.6.14
+signing_key: 
+specification_version: 4
+summary: filtering record at prescribed intervals
+test_files:
+- test/helper.rb
+- test/plugin/test_filter_time_sampling.rb