fluent-plugin-redis-counter 0.1.1 → 0.2.0

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.2.0
+* count key can be built from JSON data contents.
+
 ## 0.1.1
 * add 'count_key_format' in order to make time-dependent redis keyname
 * bug fix

data/README.md

@@ -35,7 +35,19 @@ fluent-plugin-redis-counter is hosted by [RubyGems.org](https://rubygems.org/).
       <pattern>
         match_status ^2[0-9][0-9]$
         count_key_format foo-statux2xx-%d
-        localtime                          # time-zone(default: localtime, it can be "utc" or "localtime")
+        localtime                         # time-zone(default: localtime, it can be "utc" or "localtime")
+      </pattern>
+
+      # you can also use values from the matched JSON record in the key name, by using the 
+      # syntax foo%_{key1}-%_{key2}, where key1 and key2 are keys in the JSON record that 
+      # was received by fluentd.
+      # for example, "customer:%_{customer_id}:status2xx" will be formatted to 
+      # "customer:123:status2xx" if the JSON record contains a key named "customer_id" 
+      # with value 123, like so: {"status": 200, "customer_id": 123 ... }.
+      # these can be combined with the time formatting options in the previous example.
+      <pattern>
+        match_status ^2[0-9][0-9]$
+        count_key_format customer:%_{customer_id}:status2xx-%Y-%m-%d
       </pattern>
     </match>
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/fluent-plugin-redis-counter.gemspec

@@ -3,11 +3,11 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "fluent-plugin-redis-counter"
-  s.version     = "0.1.1"
+  s.version     = "0.2.0"
   s.description = "fluent-plugin-redis-counter is a fluent plugin to count-up/down redis keys."
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Buntaro Okada"]
-  s.date        = %q{2012-06-21}
+  s.date        = %q{2013-02-19}
   s.email       = "kbinani.bt@gmail.com"
   s.homepage    = "https://github.com/kbinani/fluent-plugin-redis-counter"
   s.summary     = "Redis counter plugin for fluent"

data/lib/fluent/plugin/out_redis_counter.rb

@@ -52,7 +52,7 @@ module Fluent
             @patterns.select { |pattern|
               pattern.is_match?(record)
             }.each{ |pattern|
-              table[pattern.get_count_key(time)] += pattern.count_value
+              table[pattern.get_count_key(time, record)] += pattern.count_value
             }
           }
         rescue EOFError
@@ -69,6 +69,20 @@ module Fluent
     class RedisCounterException < Exception
     end
 
+    class RecordValueFormatter
+      attr_reader :format
+      def initialize(format)
+        @format = format
+      end
+
+      def key(record)
+        @format.gsub(/(%_\{[^\}]+\})/) do |s|
+          key = s.match(/\{([^\}]+)\}/)[1]
+          record[key]
+        end
+      end
+    end
+
     class Pattern
       attr_reader :matches, :count_value
 
@@ -90,7 +104,7 @@ module Fluent
           if conf_element.has_key?('utc')
             is_localtime = false
           end
-          @count_key_format = TimeFormatter.new(conf_element['count_key_format'], is_localtime)
+          @count_key_format = [conf_element['count_key_format'], is_localtime]
         end
 
         @count_value = 1
@@ -120,11 +134,13 @@ module Fluent
         return true
       end
 
-      def get_count_key(time)
+      def get_count_key(time, record)
         if @count_key_format == nil
           @count_key
         else
-          @count_key_format.format(time)
+          count_key = RecordValueFormatter.new(@count_key_format[0]).key(record)
+          formatter = TimeFormatter.new(count_key, @count_key_format[1])
+          formatter.format(time)
         end
       end
     end

data/test/plugin/out_redis_counter.rb

@@ -54,11 +54,11 @@ class RedisCounterTest < Test::Unit::TestCase
     assert_equal 2, driver.instance.patterns[0].matches.size
     assert_equal Regexp.new('^2[0-9]{2}$'), driver.instance.patterns[0].matches['status']
     assert_equal Regexp.new('^https'), driver.instance.patterns[0].matches['url']
-    assert_equal 'status-normal', driver.instance.patterns[0].get_count_key(Time.now.to_i)
+    assert_equal 'status-normal', driver.instance.patterns[0].get_count_key(Time.now.to_i, {})
     assert_equal 1, driver.instance.patterns[0].count_value
 
     assert_equal 0, driver.instance.patterns[1].matches.size
-    assert_equal 'foo', driver.instance.patterns[1].get_count_key(Time.now.to_i)
+    assert_equal 'foo', driver.instance.patterns[1].get_count_key(Time.now.to_i, {})
     assert_equal 2, driver.instance.patterns[1].count_value
   end
 
@@ -97,7 +97,7 @@ class RedisCounterTest < Test::Unit::TestCase
       </pattern>
     ]
     time = Time.parse('2011-06-21 03:12:01 UTC').to_i
-    assert_equal 'foo-2011-06-21-03-12-01', driver.instance.patterns[0].get_count_key(time)
+    assert_equal 'foo-2011-06-21-03-12-01', driver.instance.patterns[0].get_count_key(time, {})
   end
 
   def test_configure_count_key_format_localtime
@@ -108,7 +108,7 @@ class RedisCounterTest < Test::Unit::TestCase
       </pattern>
     ]
     local_time = Time.parse('2012-06-21 03:12:00').to_i
-    assert_equal 'foo-2012-06-21-03-12-00', driver.instance.patterns[0].get_count_key(local_time)
+    assert_equal 'foo-2012-06-21-03-12-00', driver.instance.patterns[0].get_count_key(local_time, {})
   end
 
   def test_configure_duplicated_timezone
@@ -126,6 +126,18 @@ class RedisCounterTest < Test::Unit::TestCase
     end
   end
 
+  def test_configure_count_key_format_with_record_value_formatter
+    driver = create_driver %[
+      <pattern>
+        count_key_format %_{prefix}-foo-%Y-%m-%_{type}-%_{customer_id}
+        localtime
+      </pattern>
+    ]
+    local_time = Time.parse('2012-06-21 03:12:00').to_i
+    record = {'prefix' => 'pre', 'type' => 'bar', 'customer_id' => 321}
+    assert_equal 'pre-foo-2012-06-bar-321', driver.instance.patterns[0].get_count_key(local_time, record)
+  end
+
   def test_configure_invalid_count_value
     begin
       create_driver %[

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-redis-counter
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-21 00:00:00.000000000 Z
+date: 2013-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -80,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Redis counter plugin for fluent