fluent-plugin-growthforecast 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 865e153a44d5b24396037e62f80b811d3e8289a1
-  data.tar.gz: 2482017862d4aa533da0f493c1447e5a7fefac73
+  metadata.gz: 772deca02038a2f899139be565322d168b3b199b
+  data.tar.gz: 9ecf9b2b47b1bfcbe4ceae8aa25b9d07b5c765a1
 SHA512:
-  metadata.gz: c4be0e7f1b76d4edfc035b01f1d50aceef0a79890a715cd034b7a4bfef9497494f97db137a6795dd24eee73aefdf275077c714d4637322aa9f8f21893c5de8ea
-  data.tar.gz: 6cadc77b0cb9c0611b106b0aa27d74a9d45974394bb269c0d1afa3cd7651b22e7caa8abbbd234403ba5060ef6c98dc65f999d4f5eb1a9d2ff600cd58d4085002
+  metadata.gz: 860093327616cabe40be6f9a6bdd8236c2fc4b29f0f6891d68339714fb74b5b535de5eede2a8cae357c0be963cf435e502d16052f5f0460dbbbac839f372b621
+  data.tar.gz: e88c43227e32d4b80cd93fee3bd0179149c1236e1739b194aebe88afa864e9e61e41cded15f1b87b6b952305d3c6235ce0bd08ba0f9f97c56bfecf312324a8e5

data/README.md

@@ -58,6 +58,22 @@ If you want to use tags for `section` or `service`  in GrowthForecast, use `tag_
 
 This configuration matches only with metrics.field1, metrics.key20, .... and doesn't match with metrics.field or metrics.foo.
 
+If you want to customise for more flexible graph path, use `graph_path` option with `${tag}` and `${name}` placeholders.
+
+    <match test.service1>
+      type growthforecast
+      gfapi_url http://growthforecast.local/api/
+      graph_path ${tag}/metrics1/${tag}_${key_name}
+      name_keys field1,field2,field3diff
+      remove_prefix test
+    </match>
+
+With this configuration, out_growthforecast posts urls below.
+
+    http://growthforecast.local/api/service1/metrics1/service1_field1
+    http://growthforecast.local/api/service1/metrics1/service1_field2
+    http://growthforecast.local/api/service1/metrics1/service1_field3diff
+
 If your GrowthForecast protected with basic authentication, specify `authentication` option:
 
     <match metrics.**>
@@ -82,12 +98,17 @@ Version v0.2.0 or later, this plugin uses HTTP connection keep-alive for a batch
 	  keepalive no
     </match>
 
+
 ## Parameters
 
 * gfapi\_url (required)
 
     The URL of a GrowthForecast API endpoint like `http://growth.forecast.local/api/`.
     
+* graph\_path
+
+    The graph path for GrowthForecast API endpoint with the order of service, section, graph_name.
+
 * tag\_for
 
     Either of `name_prefix`, `section`, `service`, or `ignore`. Default is `name_prefix`. 

data/fluent-plugin-growthforecast.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name          = "fluent-plugin-growthforecast"
-  gem.version       = "0.2.4"
+  gem.version       = "0.2.5"
   gem.authors       = ["TAGOMORI Satoshi"]
   gem.email         = ["tagomoris@gmail.com"]
   gem.summary       = %q{Fluentd output plugin to post numbers to GrowthForecast (by kazeburo)}

data/lib/fluent/plugin/out_growthforecast.rb

@@ -9,6 +9,7 @@ class Fluent::GrowthForecastOutput < Fluent::Output
   end
 
   config_param :gfapi_url, :string # growth.forecast.local/api/
+  config_param :graph_path, :string, :default => nil
   config_param :service, :string, :default => nil
   config_param :section, :string, :default => nil
   config_param :graphs, :string, :default => nil
@@ -35,12 +36,22 @@ class Fluent::GrowthForecastOutput < Fluent::Output
   config_param :username, :string, :default => ''
   config_param :password, :string, :default => ''
 
+  DEFAULT_GRAPH_PATH = {
+    :ignore => '${service}/${section}/${key_name}',
+    :service => '${tag}/${section}/${key_name}',
+    :section => '${service}/${tag}/${key_name}',
+    :name_prefix => '${service}/${section}/${tag}_${key_name}',
+  }
+
   def configure(conf)
     super
 
     if @gfapi_url !~ /\/api\/\Z/
       raise Fluent::ConfigError, "gfapi_url must end with /api/"
     end
+    if not @graph_path.nil? and @graph_path !~ /^[^\/]+\/[^\/]+\/[^\/]+$/
+      raise Fluent::ConfigError, "graph_path must be like '${service}/${section}/${tag}_${key_name}'"
+    end
 
     if @name_keys.nil? and @name_key_pattern.nil?
       raise Fluent::ConfigError, "missing both of name_keys and name_key_pattern"
@@ -72,6 +83,7 @@ class Fluent::GrowthForecastOutput < Fluent::Output
             else
               :gauge
             end
+
     @tag_for = case @tag_for
                when 'ignore' then :ignore
                when 'section' then :section
@@ -79,11 +91,14 @@ class Fluent::GrowthForecastOutput < Fluent::Output
                else
                  :name_prefix
                end
-    if @tag_for != :section and @section.nil?
-      raise Fluent::ConfigError, "section parameter is needed when tag_for is not 'section'"
-    end
-    if @tag_for != :service and @service.nil?
-      raise Fluent::ConfigError, "service parameter is needed when tag_for is not 'service'"
+    if @graph_path.nil?
+      if @tag_for != :section and @section.nil?
+        raise Fluent::ConfigError, "section parameter is needed when tag_for is not 'section'"
+      end
+      if @tag_for != :service and @service.nil?
+        raise Fluent::ConfigError, "service parameter is needed when tag_for is not 'service'"
+      end
+      @graph_path = DEFAULT_GRAPH_PATH[@tag_for]
     end
 
     if @remove_prefix
@@ -138,22 +153,17 @@ class Fluent::GrowthForecastOutput < Fluent::Output
     end
   end
 
-  def format_url(tag, name)
+  def placeholder_mapping(tag, name)
     if @remove_prefix and
         ( (tag.start_with?(@removed_prefix_string) and tag.length > @removed_length) or tag == @remove_prefix)
       tag = tag[@removed_length..-1]
     end
+    {'${service}' => @service, '${section}' => @section, '${tag}' => tag, '${key_name}' => name}
+  end
 
-    case @tag_for
-    when :ignore
-      @gfapi_url + URI.escape(@service + '/' + @section + '/' + name)
-    when :section
-      @gfapi_url + URI.escape(@service + '/' + tag + '/' + name)
-    when :service
-      @gfapi_url + URI.escape(tag + '/' + @section + '/' + name)
-    when :name_prefix
-      @gfapi_url + URI.escape(@service + '/' + @section + '/' + tag + '_' + name)
-    end
+  def format_url(tag, name)
+    graph_path = @graph_path.gsub(/(\${[_a-z]+})/, placeholder_mapping(tag, name))
+    return @gfapi_url + URI.escape(graph_path)
   end
 
   def connect_to(tag, name)

data/test/plugin/test_out_growthforecast.rb

@@ -112,6 +112,13 @@ class GrowthForecastOutputTest < Test::Unit::TestCase
       enable_float_number true
   ]
 
+  CONFIG_GFAPI_PATH = %[
+      gfapi_url  http://127.0.0.1:5125/api/
+      graph_path ${tag}/metrics/${tag}_${key_name}
+      name_keys  field1,field2,otherfield
+      remove_prefix test
+  ]
+
   def create_driver(conf=CONFIG1, tag='test.metrics')
     Fluent::Test::OutputTestDriver.new(Fluent::GrowthForecastOutput, tag).configure(conf)
   end
@@ -515,6 +522,31 @@ class GrowthForecastOutputTest < Test::Unit::TestCase
     assert_equal 'test.metrics_otherfield', v3rd[:name]
   end
 
+  def test_gfapi_path
+    d = create_driver(CONFIG_GFAPI_PATH, 'test.service')
+    # recent ruby's Hash saves elements order....
+    d.emit({ 'field1' => 50, 'field2' => 20, 'field3' => 10, 'otherfield' => 1 })
+    d.run
+
+    assert_equal 3, @posted.size
+    v1st = @posted[0]
+    v2nd = @posted[1]
+    v3rd = @posted[2]
+
+    assert_equal 50, v1st[:data][:number]
+    assert_equal 'gauge', v1st[:data][:mode]
+    assert_nil v1st[:auth]
+    assert_equal 'service', v1st[:service]
+    assert_equal 'metrics', v1st[:section]
+    assert_equal 'service_field1', v1st[:name]
+
+    assert_equal 20, v2nd[:data][:number]
+    assert_equal 'service_field2', v2nd[:name]
+
+    assert_equal 1, v3rd[:data][:number]
+    assert_equal 'service_otherfield', v3rd[:name]
+  end
+
   # setup / teardown for servers
   def setup
     Fluent::Test.setup

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-growthforecast
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - TAGOMORI Satoshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-02 00:00:00.000000000 Z
+date: 2013-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake