fluent-plugin-dedup 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75f9ab2798dd39e111ecac0a0afd0c1ac964bc05
+  data.tar.gz: aa7545d7df05055174952cf8edfcb87e3985658f
+SHA512:
+  metadata.gz: f688f6d8f185e583cf6327375b40fc4eff8ca665c5d5cfad31106fa7950240c24a57b0c4bc9836f84411cb2f5c7fd302dbbc692ca25c3a74097b1a8046afdf90
+  data.tar.gz: 037a80be99a3156f450aada80bf75da9714ea8d19723cd46bef6207b453bf5ac9d4681a72a7a31857bc0f1847bc558254781c5c1d14b228b49cd88478e16aeba

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+vendor/bundle/

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Atsushi Takayama
+
+MIT License
+
+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-dedup
+
+A fluentd plugin to suppress emission of subsequent logs identical to the first one.
+
+[![Build Status](https://travis-ci.org/edvakf/fluent-plugin-dedup.svg?branch=master)](https://travis-ci.org/edvakf/fluent-plugin-dedup)
+
+## Example Usage
+
+It's useful when the output of a command executed by `in_exec` only returns the "latest" state of something and you want to send logs only when there is a change.
+
+    <source>
+      type exec
+      command latest_state_of_something.rb
+      format json
+      keys unique_id,foo,bar
+      tag some.thing
+      run_interval 1s
+    </source>
+
+    <match some.thing>
+      type dedup
+      key  unique_id # required
+      file /tmp/dedup_state.json # optional. If set, saves the state to the file.
+    </match>
+
+    <match dedup.some.thing>
+      type stdout
+    </match>
+
+All logs that are processed by this plugin will have tag prefix `dedup`.
+
+If the optional `file` parameter is set, it dumps the state during shutdown and loads on start, so that it can still dedup after reload.
+
+## Testing
+
+    bundle install
+    bundle exec rake test
+
+## Installation
+
+    gem install fluent-plugin-dedup
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/fluent-plugin-dedup/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+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-dedup.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-dedup"
+  spec.version       = "0.1.0"
+  spec.authors       = ["edvakf"]
+  spec.email         = ["taka.atsushi@gmail.com"]
+  spec.summary       = %q{fluentd plugin for removing duplicate logs}
+  spec.description   = %q{fluent-plugin-dedup is a fluentd plugin to suppress emission of subsequent logs identical to the first one.}
+  spec.homepage      = "https://github.com/edvakf/fluent-plugin-dedup"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "test-unit", "~> 3.0"
+
+  spec.add_runtime_dependency "fluentd"
+end

data/lib/fluent/plugin/out_dedup.rb

@@ -0,0 +1,67 @@
+require 'json'
+
+class Fluent::DedupOutput < Fluent::Output
+  Fluent::Plugin.register_output('dedup', self)
+
+  config_param :key, :string, :default => nil
+  config_param :file, :string, :default => nil
+
+  # Define `log` method for v0.10.42 or earlier
+  unless method_defined?(:log)
+    define_method("log") { $log }
+  end
+
+  def configure(conf)
+    super
+    unless conf.include?('key')
+      raise Fluent::ConfigError, "config parameter `key` is required"
+    end
+    @key = conf['key']
+    @file = conf['file']
+    @states = {}
+  end
+
+  def start
+    super
+
+    if not @file.nil? and File.file?(@file)
+      @states = JSON.parse(File.open(@file).read) rescue {}
+    end
+  end
+
+  def shutdown
+    super
+
+    save_states
+  end
+
+  def emit(tag, es, chain)
+    es.each do |time, record|
+      next if dup?(tag, record)
+      update_states(tag, record)
+      Fluent::Engine.emit("dedup.#{tag}", time, record)
+    end
+
+    chain.next
+  end
+
+  private
+  def save_states
+    unless @file.nil?
+      File.open(@file, 'wb') do |f|
+        f.print(@states.to_json)
+      end
+    end
+  end
+
+  def dup?(tag, record)
+    unless record.include?(@key)
+      log.warn "record does not have key `#{@key}`, record: #{record.to_json}"
+    end
+    @states[tag] == record[@key]
+  end
+
+  def update_states(tag, record)
+    @states[tag] = record[@key]
+  end
+end

data/test/fluent/plugin/test_out_dedup.rb

@@ -0,0 +1,92 @@
+require 'helper'
+
+class DedupOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    key     unique_id
+  ]
+
+  def create_driver(conf=CONFIG, tag='test', use_v1=false)
+    Fluent::Test::OutputTestDriver.new(Fluent::DedupOutput, tag).configure(conf, use_v1)
+  end
+
+  test "`key` must be present" do
+    assert_raise(Fluent::ConfigError) {
+      d = create_driver('file abc')
+    }
+  end
+
+  test "two sequential identical logs are emitted only once" do
+    d = create_driver(CONFIG)
+    d.run do
+      d.emit({'unique_id' => '1'}, Time.now)
+      d.emit({'unique_id' => '1'}, Time.now) # dup
+      d.emit({'unique_id' => '2'}, Time.now)
+      d.emit({'unique_id' => '1'}, Time.now)
+    end
+
+    assert_equal 3, d.emits.length
+    assert_equal '1', d.emits[0][2]['unique_id']
+    assert_equal '2', d.emits[1][2]['unique_id']
+    assert_equal '1', d.emits[2][2]['unique_id']
+    assert_equal 'dedup.test', d.emits[0][0], 'sets a tag prefix `dedup`'
+  end
+
+  test "different tags are not treated as identical" do
+    d = create_driver(CONFIG)
+    d.run do
+      d.emit({'unique_id' => '1'}, Time.now)
+      d.tag = d.tag + d.tag # set a different tag from the first
+      d.emit({'unique_id' => '1'}, Time.now) # not dup
+    end
+
+    assert_equal 2, d.emits.length
+  end
+
+  test "state is not saved on shutdown by default" do
+    d1 = create_driver(CONFIG)
+    d1.run do
+      d1.emit({'unique_id' => '1'}, Time.now)
+    end
+    d2 = create_driver(CONFIG)
+    d2.run do
+      d2.emit({'unique_id' => '1'}, Time.now)
+    end
+
+    assert_equal 1, d1.emits.length
+    assert_equal 1, d2.emits.length
+  end
+
+  sub_test_case '`file` parameter is present' do
+    setup do
+      @statefile = File.expand_path('../../../../states.json', __FILE__)
+      File.unlink(@statefile) if File.file?(@statefile)
+    end
+
+    teardown do
+      File.unlink(@statefile) if File.file?(@statefile)
+    end
+
+    test "state is saved on shutdown if `file` parameter is present" do
+      config = %[
+        key     unique_id
+        file    #{@statefile}
+      ]
+
+      d1 = create_driver(config)
+      d1.run do
+        d1.emit({'unique_id' => '1'}, Time.now)
+      end
+      d2 = create_driver(config)
+      d2.run do
+        d2.emit({'unique_id' => '1'}, Time.now)
+      end
+
+      assert_equal 1, d1.emits.length
+      assert_equal 0, d2.emits.length
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'test/unit'
+require 'fluent/load'
+require 'fluent/test'
+
+require 'fluent/plugin/out_dedup'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-dedup
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- edvakf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: fluent-plugin-dedup is a fluentd plugin to suppress emission of subsequent
+  logs identical to the first one.
+email:
+- taka.atsushi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-dedup.gemspec
+- lib/fluent/plugin/out_dedup.rb
+- test/fluent/plugin/test_out_dedup.rb
+- test/helper.rb
+homepage: https://github.com/edvakf/fluent-plugin-dedup
+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.2.2
+signing_key: 
+specification_version: 4
+summary: fluentd plugin for removing duplicate logs
+test_files:
+- test/fluent/plugin/test_out_dedup.rb
+- test/helper.rb