fluent-plugin-statsite 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6059da4a4125aeea69ef03347f56317fa4b5d8a
-  data.tar.gz: 8794355360c98abd1a354dce70186f30ddc02c46
+  metadata.gz: 18bf875092d09bd490fd29b12b3749aeefc44248
+  data.tar.gz: 522741407db13e270fbd60fa523020d0428ecb5a
 SHA512:
-  metadata.gz: 20e3f8b875b41781b482a8797b7e4134052e3978184145edaff4ebaf5d6fdc06b9be94703911692652a99d7914e68205aedc75b14eef27d7bcce0be76a48cfd7
-  data.tar.gz: 7edcf9f85c7937bed2485e888c6e5b8105659fb3a822b799bf1c9198ed3c77964daced8d942cb5f155f93e8fc3bc99b7258f98555b5915347c2bfcd3323297d0
+  metadata.gz: 0f48dfb35f0409afa99d40aa18bc8599b98bafa13d78fdc2a177aa2404fd8bd173ee92380c08bc1e73015563fec80535768a69ecd9f7fb6ddec6a9aa0b690399
+  data.tar.gz: e61528aee4cd10d6ad2821d1cdbe5ecd48d4ef02c97b0f04fa7f3dbf87addeef6528c149ecba9897236f9d7edd5e642001b0080dc464b8e8a1f59b06547959d4

data/.travis.yml

@@ -4,12 +4,9 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1
-  - ruby-head
-  - rbx-2
 
 os:
   - linux
-  - osx
 
 branches:
   only:
@@ -19,8 +16,3 @@ gemfile:
   - Gemfile
 
 script: bundle exec rake
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: rbx-2

data/README.md

@@ -30,10 +30,10 @@ It is strongly recommended to use '[V1 config format](http://docs.fluentd.org/ar
   tag statsite
   metrics [
     "${status}:1|c",
-    {"key": "request_time", "value_field": "request_time", "type": "ms"}
+    {"key": "request_time", "value": "request_time", "type": "ms"}
   ]
   histograms [
-    {"prefix": "request_time" "min": 0, "max": 1, "width": 0.1}
+    {"prefix": "request_time", "min": 0, "max": 1, "width": 0.1}
   ]
   statsite_path "statsite"
   statsite_flush_interval 1s

data/fluent-plugin-statsite.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-statsite"
-  spec.version       = "0.0.3"
+  spec.version       = "0.0.4"
   spec.authors       = ["OKUNO Akihiro"]
   spec.email         = ["choplin.choplin@gmail.com"]
   spec.summary       = %q{Fluentd statsite plugin}

data/lib/fluent/plugin/statsite/metric.rb

@@ -1,3 +1,5 @@
+require_relative 'metric_format'
+
 module Fluent
   module StatsitePlugin
     class Metric
@@ -6,34 +8,25 @@ module Fluent
       HASH_FIELD = %w(
         type
         key
-        key_field
         value
-        value_field
       )
 
-      FIELD = '\w+|\$\{\w+\}'
-
-      STRING_PATTERN = /^(#{FIELD}):(#{FIELD})\|(#{TYPE.join('|')})$/
-      STRING_EXAMPLE = "key_field:value_field|type"
+      STRING_PATTERN = /^(#{MetricFormat::PATTERN}):(#{MetricFormat::PATTERN})\|(#{TYPE.join('|')})$/
 
-      def initialize(key, key_field, value, value_field, type)
+      def initialize(key, value, type)
         @key = key
-        @key_field = key_field
         @value = value
-        @value_field = value_field
         @type = type
       end
 
       def convert(record)
-        k = @key.nil? ? record[@key_field] : @key
-        v = @value.nil? ? record[@value_field] : @value
+        k = @key.convert(record)
+        v = @value.convert(record)
         (k.nil? or v.nil?) ? nil : "#{k}:#{v}|#{@type}\n"
       end
 
       def to_s
-        k = @key.nil? ? "key_field=#{@key_field}" :"key=#{@key}"
-        v = @value.nil? ? "value_field=#{@value_field}" :"value=#{@value}"
-        "Metric(#{k}, #{v}, type=#{@type})"
+        "Metric(#{@key}, #{@value}, type=#{@type})"
       end
 
       def self.validate(m)
@@ -49,31 +42,23 @@ module Fluent
             end
           end
 
-          if not m.has_key?('key') ^ m.has_key?('key_field')
-              raise ConfigError, "metrics element must contain either one of 'key' or 'key_field'"
-          end
-
-          if not m.has_key?('value') ^ m.has_key?('value_field')
-              raise ConfigError, "metrics element must contain either one of 'value' or 'value_field'"
-          end
-
-          if not m.has_key?('type')
-              raise ConfigError, "metrics element must contain 'type'"
+          HASH_FIELD.each do |f|
+            if not m.has_key?(f)
+                raise ConfigError, "metrics element must contain '#{f}'"
+            end
           end
 
           if not TYPE.member?(m['type'])
             raise ConfigError, "metrics type must be one of the following: #{TYPE.join(' ')}, but specified as #{m['type']}"
           end
 
-          new(m['key'], m['value_field'], m['value'], m['value_field'], m['type'])
+          new(MetricFormat.validate(m['key']), MetricFormat.validate(m['value']), m['type'])
         when String
           if (STRING_PATTERN =~ m).nil?
             raise ConfigError, "metrics string must be #{STRING_PATTERN}, but specified as #{m}"
           end
 
-          key, key_field = $1.start_with?('$') ? [nil, $1[2..-2]] : [$1, nil]
-          value, value_field = $2.start_with?('$') ? [nil, $2[2..-2]] : [$2, nil]
-          new(key, key_field, value, value_field, $3)
+          new(MetricFormat.validate($1), MetricFormat.validate($2), $3)
         end
       end
     end

data/lib/fluent/plugin/statsite/metric_format.rb

@@ -0,0 +1,37 @@
+module Fluent
+  module StatsitePlugin
+    # This represent a key/value format of Metric
+    class MetricFormat
+      CONSTANT_VALUE = '\w+'
+      SUBSTITUTE = '\$\{\w+\}'
+      SUBSTITUTE_REGEXP = /\$\{(\w+)\}/
+      ELEMENT = "(?:#{CONSTANT_VALUE}|#{SUBSTITUTE})"
+      PATTERN = "#{ELEMENT}+"
+
+      def initialize(str)
+        @str = str
+        @no_substitute = str.index('$').nil?
+      end
+
+      def convert(record)
+        if @no_substitute
+          @str
+        else
+          @str.gsub(SUBSTITUTE_REGEXP) { record.fetch($1) } rescue nil
+        end
+      end
+
+      def to_s
+        @str
+      end
+
+      def self.validate(str)
+        if /^#{PATTERN}$/.match(str).nil?
+          raise ConfigError, "invalid format of key/value field, it must be #{PATTERN}, but specified as #{str}"
+        end
+
+        new(str)
+      end
+    end
+  end
+end

data/test/test_formatter.rb

@@ -6,8 +6,8 @@ include Fluent::StatsitePlugin
 class StatsiteFormatterTest < Test::Unit::TestCase
   def setup
     metrics = [
-      Metric.validate('${k}:${v}|g'),
-      Metric.validate('${k}:v|g')
+      Metric.validate('test_${k}:test_${v}|g'),
+      Metric.validate('test_${k}:test_v|g')
     ]
     @formatter = StatsiteFormatter.new(metrics)
   end
@@ -17,9 +17,9 @@ class StatsiteFormatterTest < Test::Unit::TestCase
     assert_equal "", @formatter.call(record)
 
     record = {'k' => 'key'}
-    assert_equal "key:v|g\n", @formatter.call(record)
+    assert_equal "test_key:test_v|g\n", @formatter.call(record)
 
     record = {'k' => 'key', 'v' => 'value'}
-    assert_equal "key:value|g\nkey:v|g\n", @formatter.call(record)
+    assert_equal "test_key:test_value|g\ntest_key:test_v|g\n", @formatter.call(record)
   end
 end

data/test/test_metric.rb

@@ -4,13 +4,17 @@ require 'fluent/plugin/statsite/metric'
 include Fluent::StatsitePlugin
 
 class Metric
-  attr_reader :key, :key_field, :value, :value_field, :type
+  attr_reader :key, :value, :type
 end
 
 class MetricTest < Test::Unit::TestCase
 
   def valid_config
-    {'key' => 'k', 'value' => 'v', 'type' => 'kv'}
+    {'key' => 'test_${k}', 'value' => 'test_${v}', 'type' => 'kv'}
+  end
+
+  def invalid_kv_format
+    'test_${'
   end
 
   def test_validate_object_type
@@ -25,21 +29,25 @@ class MetricTest < Test::Unit::TestCase
   end
 
   def test_validate_key
-    config = (valid_config)['key_field'] = 'k'
-    assert_raises(Fluent::ConfigError) { Metric.validate(config) }
-
     config = (valid_config)
     config.delete('key')
     assert_raises(Fluent::ConfigError) { Metric.validate(config) }
-  end
 
-  def test_validate_value
-    config = (valid_config)['value_field'] = 'k'
+    # invalid key format
+    config = valid_config
+    config['key'] = invalid_kv_format
     assert_raises(Fluent::ConfigError) { Metric.validate(config) }
+  end
 
+  def test_validate_value
     config = (valid_config)
     config.delete('value')
     assert_raises(Fluent::ConfigError) { Metric.validate(config) }
+
+    # invalid value format
+    config = valid_config
+    config['key'] = invalid_kv_format
+    assert_raises(Fluent::ConfigError) { Metric.validate(config) }
   end
 
   def test_validate_type
@@ -52,41 +60,51 @@ class MetricTest < Test::Unit::TestCase
     assert_raises(Fluent::ConfigError) { Metric.validate(config) }
   end
 
+  def test_validate_deprecated
+    config = valid_config
+    config.delete('value')
+    config['value_field'] = 'v'
+    assert_raises(Fluent::ConfigError) { Metric.validate(config) }
+
+    config = valid_config
+    config.delete('key')
+    config['key_field'] = 'k'
+    assert_raises(Fluent::ConfigError) { Metric.validate(config) }
+  end
+
   def test_validate_string
     config = "foo"
     assert_raises(Fluent::ConfigError) { Metric.validate(config) }
 
+    # invalid type
     config = "k:v|foo"
     assert_raises(Fluent::ConfigError) { Metric.validate(config) }
+
+    # invalid key format
+    config = "${k:v|foo"
+    assert_raises(Fluent::ConfigError) { Metric.validate(config) }
+
+    # invalid value format
+    config = "k:v_()|foo"
+    assert_raises(Fluent::ConfigError) { Metric.validate(config) }
   end
 
   def test_validate_result
     m = Metric.validate(valid_config)
-    assert_equal 'k', m.key
-    assert_nil m.key_field
-    assert_equal 'v', m.value
-    assert_nil m.value_field
+    assert_equal 'test_${k}', m.key.to_s
+    assert_equal 'test_${v}', m.value.to_s
     assert_equal 'kv', m.type
   end
 
   def test_validate_result_string
-    m = Metric.validate('k:v|kv')
-    assert_equal 'k', m.key
-    assert_nil m.key_field
-    assert_equal 'v', m.value
-    assert_nil m.value_field
-    assert_equal 'kv', m.type
-
-    m = Metric.validate('${k}:${v}|kv')
-    assert_nil m.key
-    assert_equal 'k', m.key_field
-    assert_nil m.value
-    assert_equal 'v', m.value_field
+    m = Metric.validate('test_${k}:test_${v}|kv')
+    assert_equal 'test_${k}', m.key.to_s
+    assert_equal 'test_${v}', m.value.to_s
     assert_equal 'kv', m.type
   end
 
   def test_convert
-    m = Metric.validate('${k}:${v}|kv')
+    m = Metric.validate('test_${k}:test_${v}|kv')
 
     record = {'k' => 'key'}
     assert_nil m.convert(record)
@@ -95,6 +113,12 @@ class MetricTest < Test::Unit::TestCase
     assert_nil m.convert(record)
 
     record = {'k' => 'key', 'v' => 'value'}
-    assert_equal "key:value|kv\n", m.convert(record)
+    assert_equal "test_key:test_value|kv\n", m.convert(record)
+  end
+
+  def test_convert_constant
+    m = Metric.validate('k:v|kv')
+    record = {}
+    assert_equal "k:v|kv\n", m.convert(record)
   end
 end

data/test/test_metric_format.rb

@@ -0,0 +1,37 @@
+require 'helper'
+require 'fluent/plugin/statsite/metric_format'
+
+include Fluent::StatsitePlugin
+
+class MetricFormat
+  attr_reader :str, :no_substitute
+end
+
+class MetricFormatTest < Test::Unit::TestCase
+  def test_validate
+    assert_raises(Fluent::ConfigError) { MetricFormat.validate('()') }
+    assert_raises(Fluent::ConfigError) { MetricFormat.validate('$') }
+    assert_raises(Fluent::ConfigError) { MetricFormat.validate('{}}') }
+  end
+
+  def test_validate_result
+    s = 'foo_${bar}_foobar'
+    mf = MetricFormat.validate(s)
+    assert_equal s, mf.str
+    assert (not mf.no_substitute)
+
+    s = 'foo_bar_foobar'
+    mf = MetricFormat.validate(s)
+    assert_equal s, mf.str
+    assert mf.no_substitute
+  end
+
+  def test_validate_convert
+    s = 'foo_${bar}_foobar'
+    mf = MetricFormat.validate(s)
+
+    assert_equal 'foo_hoge_foobar', mf.convert({'bar' => 'hoge'})
+
+    assert_nil mf.convert({'hoge' => 'fuga'})
+  end
+end

data/test/test_out_statsite_filter.rb

@@ -17,7 +17,7 @@ class StatsiteFilterOutputTest < Test::Unit::TestCase
     type statsite
     tag statsite
     metrics [
-      "${status}:1|c"
+      "status_${status}:1|c"
     ]
     histograms [
       {"prefix": "k", "min": 0, "max": 10, "width": 1.0}
@@ -60,6 +60,6 @@ class StatsiteFilterOutputTest < Test::Unit::TestCase
 
     count_result = emits.pop
     assert_equal 'statsite', count_result[0]
-    assert_equal({type: 'counts', key: '200', value: 4.0}, count_result[2])
+    assert_equal({type: 'counts', key: 'status_200', value: 4.0}, count_result[2])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-statsite
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - OKUNO Akihiro
@@ -73,10 +73,12 @@ files:
 - lib/fluent/plugin/statsite/format.rb
 - lib/fluent/plugin/statsite/histogram.rb
 - lib/fluent/plugin/statsite/metric.rb
+- lib/fluent/plugin/statsite/metric_format.rb
 - test/helper.rb
 - test/test_formatter.rb
 - test/test_histogram.rb
 - test/test_metric.rb
+- test/test_metric_format.rb
 - test/test_out_statsite_filter.rb
 - test/test_parser.rb
 homepage: https://github.com/choplin/fluent-plugin-statsite
@@ -108,5 +110,6 @@ test_files:
 - test/test_formatter.rb
 - test/test_histogram.rb
 - test/test_metric.rb
+- test/test_metric_format.rb
 - test/test_out_statsite_filter.rb
 - test/test_parser.rb