fluent-plugin-grepcounter 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e33868eff231419fbe756a0ffee44da515c0dd32
-  data.tar.gz: 58163aa587b8dccf1bbb8772a2e28d6d53b84b5d
+  metadata.gz: 16a2bb7af97b5bbe3d7436c7f9ac749a74a8b660
+  data.tar.gz: 77e82589f64a366baf731899318c22c9cf076a37
 SHA512:
-  metadata.gz: c461903fa92252cd705650cff061dec93374bfe0f940721269a1e1684b630ac742ce187be1eed42b2a56be9427ad097da1753b43b538b157d04e57628d20d5ed
-  data.tar.gz: 506d59a863255d75aa10192250f2c67e14e0dcece26d60573cb0093c08f5c4f5ae6e11a5947d330023107243905fa7e5db16dce74ac223cea0f554f8394235ab
+  metadata.gz: 28c15035659a4ced1b00e033f8ab53e51cde287be5a62ef57af4834a75ba755eba6f929f4c3422534f368cb3842f83112fc70bb41a54eefc915b1534de7b284e
+  data.tar.gz: b67364cf3cd70c42bdd6015238383100d04fc030a320804a6c41eaa792ddd15be5335bfe37d1f7faf41ae1a41b3f12f3bfdea4d4d366fdc6cb6afaadb6af6a85

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 0.4.0 (2013/11/30)
+
+Changes
+
+  - Change the option name `output_tag` to `tag`. `output_tag` is obsolete.
+  - Change the option name `output_with_joined_delimiter` to `delimiter`. `output_with_joined_delimiter` is obsolete.
+
 ## 0.3.1 (2013/11/02)
 
 Changes

data/README.md

@@ -6,10 +6,10 @@ Fluentd plugin to count the number of matched messages, and emit if exeeds the `
 
 Assume inputs from another plugin are as belows:
 
-    syslog.host1: {"message":"2013/01/13T07:02:11.124202 INFO GET /ping" }
-    syslog.host1: {"message":"2013/01/13T07:02:13.232645 WARN POST /auth" }
-    syslog.host1: {"message":"2013/01/13T07:02:21.542145 WARN GET /favicon.ico" }
-    syslog.host1: {"message":"2013/01/13T07:02:43.632145 WARN POST /login" }
+    syslog.host1: {"message":"20.4.01/13T07:02:11.124202 INFO GET /ping" }
+    syslog.host1: {"message":"20.4.01/13T07:02:13.232645 WARN POST /auth" }
+    syslog.host1: {"message":"20.4.01/13T07:02:21.542145 WARN GET /favicon.ico" }
+    syslog.host1: {"message":"20.4.01/13T07:02:43.632145 WARN POST /login" }
 
 An example of grepcounter configuration:
 
@@ -27,7 +27,7 @@ Then, output bocomes as belows (indented):
 
     warn.count.syslog.host1: {
       "count":2,
-      "message":["2013/01/13T07:02:13.232645 WARN POST /auth","2013/01/13T07:02:43.632145 WARN POST /login"],
+      "message":["20.4.01/13T07:02:13.232645 WARN POST /auth","20.4.01/13T07:02:43.632145 WARN POST /login"],
       "input_tag":"syslog.host1",
       "input_tag_last":"host1",
     }
@@ -35,7 +35,7 @@ Then, output bocomes as belows (indented):
 ### output_with_joined_delimiter
 
 As default, the `grepcounter` plugin outputs matched `message` as an array as shown above. 
-You may want to output `message` as a string, then use `output_with_joined_delimiter` option like:
+You may want to output `message` as a string, then use `delimiter` option like:
 
     <match syslog.**>
       type grepcounter
@@ -45,14 +45,14 @@ You may want to output `message` as a string, then use `output_with_joined_delim
       exclude favicon.ico
       threshold 1
       add_tag_prefix warn.count
-      output_with_joined_delimiter \n
+      delimiter \n
     </source>
 
 Then, output bocomes as belows (indented). You can see the `message` field is joined with \n.
 
     warn.count.syslog.host1: {
       "count":2,
-      "message":"2013/01/13T07:02:13.232645 WARN POST /auth\n2013/01/13T07:02:43.632145 WARN POST /login",
+      "message":"20.4.01/13T07:02:13.232645 WARN POST /auth\n20.4.01/13T07:02:43.632145 WARN POST /login",
       "input_tag":"syslog.host1",
       "input_tag_last":"host1",
     }
@@ -79,7 +79,7 @@ Then, output bocomes as belows (indented). You can see the `message` field is jo
 
     The threshold number to emit. Emit if `count` value >= specified value.
 
-- comparator (obsolete from 0.2.0. Use greater\_equal or less\_equal instead)
+- comparator (obsolete)
 
     The comparation operator for the threshold (either of `>=` or `<=`). Default is `>=`, i.e., emit if count >= threshold. 
     NOTE: 0 count message will not be emitted even if `<=` is specified because standby nodes receive no message usually.
@@ -100,7 +100,11 @@ Then, output bocomes as belows (indented). You can see the `message` field is jo
 
     Emit if `count` value is less than or equal to (<=) specified value. 
 
-- output\_tag
+- output\_tag (obsolete from 0.4.0)
+
+    The output tag. Required for aggregate `all`. 
+
+- tag (from 0.4.0)
 
     The output tag. Required for aggregate `all`. 
 
@@ -108,7 +112,11 @@ Then, output bocomes as belows (indented). You can see the `message` field is jo
 
     Add tag prefix for output message
 
-- output\_with\_joined\_delimiter
+- output\_with\_joined\_delimiter (obsolete from 0.4.0)
+
+    Output matched messages after `join`ed with the specified delimiter.
+
+- delimiter (from 0.4.0)
 
     Output matched messages after `join`ed with the specified delimiter.
 

data/fluent-plugin-grepcounter.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "fluent-plugin-grepcounter"
-  s.version     = "0.3.1"
+  s.version     = "0.4.0"
   s.authors     = ["Naotoshi SEO"]
   s.email       = ["sonots@gmail.com"]
   s.homepage    = "https://github.com/sonots/fluent-plugin-grepcounter"

data/lib/fluent/plugin/out_grepcounter.rb

@@ -17,9 +17,11 @@ class Fluent::GrepCounterOutput < Fluent::Output
   config_param :less_equal, :float, :default => nil
   config_param :greater_than, :float, :default => nil
   config_param :greater_equal, :float, :default => nil
-  config_param :output_tag, :string, :default => nil
+  config_param :output_tag, :string, :default => nil # obsolete
+  config_param :tag, :string, :default => nil
   config_param :add_tag_prefix, :string, :default => 'count'
-  config_param :output_with_joined_delimiter, :string, :default => nil
+  config_param :output_with_joined_delimiter, :string, :default => nil # obsolete
+  config_param :delimiter, :string, :default => nil
   config_param :aggregate, :string, :default => 'tag'
   config_param :replace_invalid_sequence, :bool, :default => false
   config_param :store_file, :string, :default => nil
@@ -44,7 +46,7 @@ class Fluent::GrepCounterOutput < Fluent::Output
       raise Fluent::ConfigError, "grepcounter: comparator allows >=, <="
     end
 
-    # to support obsolete options
+    # to support obsolete `threshold` and `comparator` options
     if @threshold.nil? and @less_than.nil? and @less_equal.nil? and @greater_than.nil? and @greater_equal.nil?
       @threshold = 1
     end
@@ -56,6 +58,12 @@ class Fluent::GrepCounterOutput < Fluent::Output
       end
     end
 
+    # to support osolete `output_tag` option
+    @tag = @output_tag if !@tag and @output_tag
+
+    # to support obsolete `output_with_joined_delimiter` option
+    @delimiter = @output_with_joined_delimiter if !@delimiter and @output_with_joined_delimiter
+
     unless ['tag', 'all'].include?(@aggregate)
       raise Fluent::ConfigError, "grepcounter: aggregate allows tag/all"
     end
@@ -145,13 +153,13 @@ class Fluent::GrepCounterOutput < Fluent::Output
         matches += flushed_matches[tag]
       end
       output = generate_output(count, matches)
-      Fluent::Engine.emit(@output_tag, time, output) if output
+      Fluent::Engine.emit(@tag, time, output) if output
     else
       flushed_counts.keys.each do |tag|
         count = flushed_counts[tag]
         matches = flushed_matches[tag]
         output = generate_output(count, matches, tag)
-        tag = @output_tag ? @output_tag : "#{@add_tag_prefix}.#{tag}"
+        tag = @tag ? @tag : "#{@add_tag_prefix}.#{tag}"
         Fluent::Engine.emit(tag, time, output) if output
       end
     end
@@ -166,7 +174,7 @@ class Fluent::GrepCounterOutput < Fluent::Output
     return nil if @greater_equal and count <  @greater_equal
     output = {}
     output['count'] = count
-    output['message'] = @output_with_joined_delimiter.nil? ? matches : matches.join(@output_with_joined_delimiter)
+    output['message'] = @delimiter.nil? ? matches : matches.join(@delimiter)
     if tag
       output['input_tag'] = tag
       output['input_tag_last'] = tag.split('.').last

data/spec/out_grepcounter_spec.rb

@@ -50,7 +50,7 @@ describe Fluent::GrepCounterOutput do
         its(:exclude) { should be_nil }
         its(:threshold) { should == 1 }
         its(:comparator) { should == '>=' }
-        its(:output_tag) { should be_nil }
+        its(:tag) { should be_nil }
         its(:add_tag_prefix) { should == 'count' }
       end
     end
@@ -124,7 +124,7 @@ describe Fluent::GrepCounterOutput do
       it { emit }
     end
 
-    context "threshold and comparator" do
+    context "threshold and comparator (obsolete)" do
       context '>= threshold' do
         let(:config) { CONFIG + %[threshold 4] }
         before do
@@ -162,7 +162,7 @@ describe Fluent::GrepCounterOutput do
       end
     end
 
-    context "less|greater_than|equal" do
+    context "less and greater" do
       context 'greater_equal' do
         let(:config) { CONFIG + %[greater_equal 4] }
         before do
@@ -254,7 +254,7 @@ describe Fluent::GrepCounterOutput do
       end
     end
 
-    context 'output_tag' do
+    context 'output_tag (obsolete)' do
       let(:config) { CONFIG + %[output_tag foo] }
       before do
         Fluent::Engine.stub(:now).and_return(time)
@@ -263,6 +263,15 @@ describe Fluent::GrepCounterOutput do
       it { emit }
     end
 
+    context 'tag' do
+      let(:config) { CONFIG + %[tag foo] }
+      before do
+        Fluent::Engine.stub(:now).and_return(time)
+        Fluent::Engine.should_receive(:emit).with("foo", time, expected)
+      end
+      it { emit }
+    end
+
     context 'add_tag_prefix' do
       let(:config) { CONFIG + %[add_tag_prefix foo] }
       before do
@@ -272,7 +281,7 @@ describe Fluent::GrepCounterOutput do
       it { emit }
     end
 
-    context 'output_with_joined_delimiter' do
+    context 'output_with_joined_delimiter (obsolete)' do
       # \\n shall be \n in config file
       let(:config) { CONFIG + %[output_with_joined_delimiter \\n] }
       before do
@@ -283,6 +292,17 @@ describe Fluent::GrepCounterOutput do
       it { emit }
     end
 
+    context 'delimiter' do
+      # \\n shall be \n in config file
+      let(:config) { CONFIG + %[delimiter \\n] }
+      before do
+        Fluent::Engine.stub(:now).and_return(time)
+        message = expected["message"].join('\n')
+        Fluent::Engine.should_receive(:emit).with("count.#{tag}", time, expected.merge("message" => message))
+      end
+      it { emit }
+    end
+
     context 'aggregate all' do
       let(:messages) { ['foobar', 'foobar'] }
       let(:emit) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-grepcounter
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Naotoshi SEO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-02 00:00:00.000000000 Z
+date: 2013-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd