fluent-plugin-unique-counter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f792411616af4e4d34e799b98163e9a3f994ea71
+  data.tar.gz: c1d9609ad4b69a358f9826a786ea82d4476071e1
+SHA512:
+  metadata.gz: 2ad73f96b43a325faa1de85f889ce999c93021f95f43fa649407b284bcba993f7e4f963ec01e9d563d6f29b1cb258228534fdc6d34f0a29f57c7f5a036a6e4eb
+  data.tar.gz: 74c2ecfa0a309ede8b8483995fe594b08aad17fe665d13b05baedeb8644aabc6a6f98ddc9e4f30bacee4ce93d0397f075fa6c3bff46db2df429032a2b484a9b2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 futoase
+
+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 unique counter plugin
+
+This plugin purpose is simple monitoring (countup only).
+This was referred from [fluent-plugin-numeric-counter](https://github.com/tagomoris/fluent-plugin-numeric-counter). Thanks! :)
+
+# Contributor
+
+- [@takesato](https://github.com/takesato)
+- [@futoase](https://github.com/futoase)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fluent-plugin-unique-counter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-unique-counter
+
+## confing params
+
+- ```count_interval```
+
+  This interval time to monitoring. Default setting is ```60sec```.
+
+- ```unit```
+
+  Monitoring specific interval an unit. Selectable setting is ```minutes```, ```hours``` and ```days```.
+
+- ```unique_key```
+
+  Monitoring key name.
+
+- ```tag```
+
+  Output tag name. Default setting is ```unique_count```.
+
+## License
+
+Apache License v2.0.
+
+## Copylight
+
+Copylight (c) 2013 Aiming Inc.

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-unique-counter.gemspec

@@ -0,0 +1,25 @@
+# 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-unique-counter"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Keiji Matsuzaki"]
+  spec.email         = ["futoase@gmail.com"]
+  spec.summary       = %q{fluentd unique counter plugin.}
+  spec.description   = %q{This plugin is use of count up to unique attribute.}
+  spec.homepage      = ""
+  spec.license       = "Apache License v2.0"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "timecop"
+
+  spec.add_dependency "fluentd"
+end

data/lib/fluent/plugin/out_unique_counter.rb

@@ -0,0 +1,84 @@
+# coding: utf-8
+#
+class Fluent::UniqCounterOutput < Fluent::Output
+  Fluent::Plugin.register_output('unique_counter', self)
+
+  config_param :count_interval, :time, :default => 60
+  config_param :unit, :string, :default => nil
+  config_param :unique_key, :string
+
+  config_param :tag, :string, :default => 'unique_count'
+
+  attr_accessor :tick
+  attr_accessor :counts
+  attr_accessor :last_checked
+
+  UNITS = {
+    minutes: 60,
+    hours: 3600,
+    days: 86400
+  }
+
+  def configure(conf)
+    super
+
+    if @unit and UNITS[@unit.to_sym].nil?
+      raise Fluent::ConfigError, "'unit' must be one of minutes/hours/days"
+    end
+    @count_interval = UNITS[@unit.to_sym] if @unit
+
+    @counts = []
+    @mutex = Mutex.new
+  end
+
+  def start
+    super
+    start_watch
+  end
+
+  def shutdown
+    super
+    @watcher.terminate
+    @watcher.join
+  end
+
+  def flush_emit
+    flushed,@counts = @counts,[]
+    message = {'unique_count' => flushed.uniq.count }
+    Fluent::Engine.emit(@tag, Fluent::Engine.now, message)
+  end
+
+  def start_watch
+    # for internal, or tests only
+    @watcher = Thread.new(&method(:watch))
+  end
+
+  def watch
+    # instance variable, and public accessable, for test
+    @last_checked = Fluent::Engine.now
+    while true
+      sleep 0.5
+      if (Fluent::Engine.now - @last_checked) >= @count_interval
+        now = Fluent::Engine.now
+        flush_emit
+        @last_checked = now
+      end
+    end
+  end
+
+  def emit(tag, es, chain)
+    c = []
+
+    es.each do |time,record|
+      value = record[@unique_key]
+      next if value.nil?
+
+      c << value.to_s.force_encoding('ASCII-8BIT')
+    end
+    @mutex.synchronize {
+      @counts += c
+    }
+
+    chain.next
+  end
+end

data/test/helper.rb

@@ -0,0 +1,12 @@
+require 'bundler'
+
+Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
+
+require 'fluent/test'
+require 'test/unit'
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.dirname(__FILE__))
+
+require 'fluent/plugin/out_unique_counter'

data/test/test_unique_counter.rb

@@ -0,0 +1,157 @@
+require_relative 'helper'
+require 'timecop'
+
+class OutUniqueCounterTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  def teardown
+    Timecop.return
+  end
+
+  CONFIG_INTERVAL_10 = %[
+    tag api.production.login
+    unique_key user_id
+    count_interval 10
+  ]
+
+  CONFIG_INTERVAL_30 = %[
+    tag api.production.login
+    unique_key user_id
+    count_interval 30
+  ]
+
+  CONFIG_UNIT_MINUTES = %[
+    tag api.production.login
+    unique_key user_id
+    unit minutes
+  ]
+
+  CONFIG_UNIT_HOURS = %[
+    tag api.production.login
+    unique_key user_id
+    unit hours
+  ]
+
+  CONFIG_UNIT_DAYS = %[
+    tag api.production.login
+    unique_key user_id
+    unit days
+  ]
+
+  def create_driver(conf = CONFIG, tag = 'test')
+    Fluent::Test::OutputTestDriver.new(Fluent::UniqCounterOutput, tag).configure(conf)
+  end
+
+  def test_unique_count_interval_10
+    d1 = create_driver(CONFIG_INTERVAL_10, 'uniq.countup')
+
+    d1.run do
+      Timecop.freeze(Time.now + 10)
+      d1.emit({"user_id" => "1000"})
+      d1.emit({"user_id" => "1000"})
+      d1.emit({"user_id" => "1000"})
+      d1.emit({"user_id" => "1001"})
+      d1.emit({"user_id" => "1002"})
+      d1.emit({"user_id" => "1002"})
+      sleep 1
+      Timecop.return
+    end
+
+    emits = d1.emits
+
+    p emits[0]
+    assert_equal "api.production.login", emits[0][0]
+    assert_equal 3, emits[0][2]["unique_count"]
+  end
+
+  def test_unique_count_interval_30
+    d1 = create_driver(CONFIG_INTERVAL_30, 'uniq.countup')
+
+    d1.run do
+      Timecop.freeze(Time.now + 30)
+      d1.emit({"user_id" => "1000"})
+      d1.emit({"user_id" => "1000"})
+      d1.emit({"user_id" => "1000"})
+      d1.emit({"user_id" => "1001"})
+      d1.emit({"user_id" => "1002"})
+      d1.emit({"user_id" => "1002"})
+      sleep 1
+      Timecop.return
+    end
+
+    emits = d1.emits
+
+    p emits[0]
+    assert_equal "api.production.login", emits[0][0]
+    assert_equal 3, emits[0][2]["unique_count"]
+  end
+
+  def test_unique_count_unit_minutes
+    d1 = create_driver(CONFIG_UNIT_MINUTES, 'uniq.countup')
+
+    d1.run do
+      Timecop.freeze(Time.now + 60)
+      d1.emit({"user_id" => "1000"})
+      d1.emit({"user_id" => "1000"})
+      d1.emit({"user_id" => "1000"})
+      d1.emit({"user_id" => "1001"})
+      d1.emit({"user_id" => "1002"})
+      d1.emit({"user_id" => "1002"})
+      sleep 1
+      Timecop.return
+    end
+
+    emits = d1.emits
+
+    p emits[0]
+    assert_equal "api.production.login", emits[0][0]
+    assert_equal 3, emits[0][2]["unique_count"]
+  end
+
+  def test_unique_count_unit_hours
+    d1 = create_driver(CONFIG_UNIT_HOURS, 'uniq.countup')
+
+    d1.run do
+      Timecop.freeze(Time.now + 3600)
+      d1.emit({"user_id" => "1000"})
+      d1.emit({"user_id" => "1000"})
+      d1.emit({"user_id" => "1000"})
+      d1.emit({"user_id" => "1001"})
+      d1.emit({"user_id" => "1002"})
+      d1.emit({"user_id" => "1002"})
+      sleep 1
+      Timecop.return
+    end
+
+    emits = d1.emits
+
+    p emits[0]
+    assert_equal "api.production.login", emits[0][0]
+    assert_equal 3, emits[0][2]["unique_count"]
+  end
+
+  def test_unique_count_unit_days
+    d1 = create_driver(CONFIG_UNIT_DAYS, 'uniq.countup')
+
+    d1.run do
+      Timecop.freeze(Time.now + 86400)
+      d1.emit({"user_id" => "1000"})
+      d1.emit({"user_id" => "1000"})
+      d1.emit({"user_id" => "1000"})
+      d1.emit({"user_id" => "1001"})
+      d1.emit({"user_id" => "1002"})
+      d1.emit({"user_id" => "1002"})
+      sleep 1
+      Timecop.return
+    end
+
+    emits = d1.emits
+
+    p emits[0]
+    assert_equal "api.production.login", emits[0][0]
+    assert_equal 3, emits[0][2]["unique_count"]
+  end
+
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-unique-counter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keiji Matsuzaki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: timecop
+  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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This plugin is use of count up to unique attribute.
+email:
+- futoase@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fluent-plugin-unique-counter.gemspec
+- lib/fluent/plugin/out_unique_counter.rb
+- test/helper.rb
+- test/test_unique_counter.rb
+homepage: ''
+licenses:
+- Apache License v2.0
+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.0.3
+signing_key: 
+specification_version: 4
+summary: fluentd unique counter plugin.
+test_files:
+- test/helper.rb
+- test/test_unique_counter.rb