fluent-plugin-config-expander 0.1.0 → 0.1.1

data/README.md

@@ -5,6 +5,9 @@
 ConfigExpanderInput and ConfigExpanderOutput plugins provide simple configuration template to write items repeatedly.
 In <config> section, you can write actual configuration for actual input/output plugin, with special directives for loop controls.
 
+And also supports built-in placeholders below:
+ * hostname (ex: \_\_HOSTNAME\_\_, \_\_hostname\_\_, ${hostname}, ${HOSTNAME})
+
 ## Configuration
 
 For both of input and output (for <source> and <match>), you can use 'config_expander' and its 'for' directive like below:
@@ -42,6 +45,22 @@ Configuration above is equal to below:
       </server>
     </match>
 
+As placeholder, you can use '${varname}' style:
+
+    <match example.**>
+      type config_expander
+      <config>
+        type forward
+        flush_interval 30s
+        <for node in 01 02 03>
+          <server>
+            host worker${node}.local
+            port 24224
+          </server>
+        </for>
+      </config>
+    </match>
+
 Nested 'for' directive is valid:
 
     <match example.**>
@@ -60,6 +79,18 @@ Nested 'for' directive is valid:
       </config>
     </match>
 
+Set hostname into tag in 'tail' input plugin:
+
+    <source>
+      type config_expander
+      <config>
+        type tail
+        format /..../
+        path /var/log/access.log
+        tag access.log.${hostname}
+      </config>
+    </source>
+
 ## TODO
 
 * more tests

data/fluent-plugin-config-expander.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |gem|
   gem.name          = "fluent-plugin-config-expander"
-  gem.version       = "0.1.0"
+  gem.version       = "0.1.1"
   gem.authors       = ["TAGOMORI Satoshi"]
   gem.email         = ["tagomoris@gmail.com"]
   gem.description   = %q{This plugin provides directives for loop extraction}

data/lib/fluent/plugin/expander.rb

@@ -2,7 +2,7 @@ require 'fluent/config'
 
 module Fluent::Config::Expander
   def self.replace(str, mapping)
-    mapping.reduce(str){|r,p| str.gsub(p[0], p[1])}
+    mapping.reduce(str){|r,p| r.gsub(p[0], p[1])}
   end
 
   def self.expand(element, mapping)
@@ -15,10 +15,13 @@ module Fluent::Config::Expander
         unless e.arg =~ /^([a-zA-Z0-9]+) in (.+)$/
           raise Fluent::ConfigError, "invalid for tag syntax: <for NAME in ARG1 ARG2 ...>"
         end
-        vname = '__' + $1 + '__'
+        vkey = $1.dup
         vargs = $2.split(/ +/).select{|v| v.size > 0}
+
+        vname = '__' + vkey + '__'
+        vname2 = '${' + vkey + '}'
         vargs.each do |v|
-          expanded = expand(e, mapping.merge({vname => v}))
+          expanded = expand(e, mapping.merge({vname => v, vname2 => v}))
           attrs.update(expanded)
           elements += expanded.elements.map{|xe| expand(xe, mapping)}
         end

data/lib/fluent/plugin/in_config_expander.rb

@@ -3,6 +3,7 @@ require_relative 'expander'
 class Fluent::ConfigExpanderInput < Fluent::Input
   Fluent::Plugin.register_input('config_expander', self)
 
+  config_param :hostname, :string, :default => `hostname`.chomp
   attr_accessor :plugin
 
   def mark_used(conf)
@@ -10,8 +11,12 @@ class Fluent::ConfigExpanderInput < Fluent::Input
     conf.elements.each{|e| mark_used(e)}
   end
 
+  def builtin_mapping
+    {'__hostname__' => @hostname, '__HOSTNAME__' => @hostname, '${hostname}' => @hostname, '${HOSTNAME}' => @hostname}
+  end
+
   def expand_config(conf)
-    ex = Fluent::Config::Expander.expand(conf, {})
+    ex = Fluent::Config::Expander.expand(conf, builtin_mapping())
     ex.name = ''
     ex.arg = ''
     ex

data/lib/fluent/plugin/out_config_expander.rb

@@ -3,6 +3,7 @@ require_relative 'expander'
 class Fluent::ConfigExpanderOutput < Fluent::Output
   Fluent::Plugin.register_output('config_expander', self)
 
+  config_param :hostname, :string, :default => `hostname`.chomp
   attr_accessor :plugin
 
   def mark_used(conf)
@@ -10,8 +11,12 @@ class Fluent::ConfigExpanderOutput < Fluent::Output
     conf.elements.each{|e| mark_used(e)}
   end
 
+  def builtin_mapping
+    {'__hostname__' => @hostname, '__HOSTNAME__' => @hostname, '${hostname}' => @hostname, '${HOSTNAME}' => @hostname}
+  end
+
   def expand_config(conf)
-    ex = Fluent::Config::Expander.expand(conf, {})
+    ex = Fluent::Config::Expander.expand(conf, builtin_mapping())
     ex.name = ''
     ex.arg = ''
     ex

data/test/plugin/test_expander.rb

@@ -13,6 +13,7 @@ class ConfigExpanderTest < Test::Unit::TestCase
     assert_equal "foofoo", @m.replace("foobar", {'bar' => 'foo'})
     assert_equal "foobar", @m.replace("foobar", {'hoge' => 'moge'})
     assert_equal "xxbar", @m.replace("foofoobar", {'foo' => 'x'})
+    assert_equal "xxy", @m.replace("foofoobar", {'foo' => 'x', 'bar' => 'y'})
   end
 
   def test_expand
@@ -128,5 +129,69 @@ EOL
 </config>
 EOL
     assert_equal exconf3, @m.expand(conf3, {}).to_s
+
+    nonexconf4 = <<EOL
+<config>
+  type forward
+  flush_interval 1s
+  <for nodenum in 01>
+    <for portnum in 24221 24222 24223 24224>
+      <server>
+        host node__nodenum__.local
+        port ${portnum}
+      </server>
+    </for>
+  </for>
+  <for nodenum in 02>
+    <for portnum in 24221 24222 24223 24224>
+      <server>
+        host node${nodenum}.local
+        port __portnum__
+      </server>
+    </for>
+  </for>
+</config>
+EOL
+    conf4 = Fluent::Config.parse(nonexconf4, 'hoge').elements.first
+    assert_equal nonexconf4, conf4.to_s
+    exconf4 = <<EOL
+<config>
+  type forward
+  flush_interval 1s
+  <server>
+    host node01.local
+    port 24221
+  </server>
+  <server>
+    host node01.local
+    port 24222
+  </server>
+  <server>
+    host node01.local
+    port 24223
+  </server>
+  <server>
+    host node01.local
+    port 24224
+  </server>
+  <server>
+    host node02.local
+    port 24221
+  </server>
+  <server>
+    host node02.local
+    port 24222
+  </server>
+  <server>
+    host node02.local
+    port 24223
+  </server>
+  <server>
+    host node02.local
+    port 24224
+  </server>
+</config>
+EOL
+    assert_equal exconf4, @m.expand(conf4, {}).to_s
   end
 end

data/test/plugin/test_in_config_expander.rb

@@ -18,6 +18,7 @@ type config_expander
   </for>
 </config>
 ]
+
   def create_driver(conf=CONFIG)
     Fluent::Test::InputTestDriver.new(Fluent::ConfigExpanderInput).configure(conf)
   end
@@ -39,4 +40,26 @@ type config_expander
     assert_equal true, d.instance.plugin.stopped
   end
 
+  CONFIG2 = %[
+type config_expander
+hostname testing.node.local
+<config>
+  type config_expander_test
+  tag baz
+  <node>
+    attr1 ${hostname}
+    attr2 ${HOSTNAME}
+    attr3 __hostname__
+    attr4 __HOSTNAME__
+  </node>
+]
+  def test_configure_hostname
+    d = create_driver CONFIG2
+    assert_equal 1, d.instance.plugin.nodes.size
+    assert_equal 'testing.node.local', d.instance.plugin.nodes.first['attr1']
+    assert_equal 'testing.node.local', d.instance.plugin.nodes.first['attr2']
+    assert_equal 'testing.node.local', d.instance.plugin.nodes.first['attr3']
+    assert_equal 'testing.node.local', d.instance.plugin.nodes.first['attr4']
+  end
+
 end

data/test/plugin/test_out_config_expander.rb

@@ -39,6 +39,28 @@ type config_expander
     assert_equal true, d.instance.plugin.stopped
   end
 
+  CONFIG2 = %[
+type config_expander
+hostname testing.node.local
+<config>
+  type config_expander_test
+  tag baz
+  <node>
+    attr1 ${hostname}
+    attr2 ${HOSTNAME}
+    attr3 __hostname__
+    attr4 __HOSTNAME__
+  </node>
+]
+  def test_configure_hostname
+    d = create_driver CONFIG2
+    assert_equal 1, d.instance.plugin.nodes.size
+    assert_equal 'testing.node.local', d.instance.plugin.nodes.first['attr1']
+    assert_equal 'testing.node.local', d.instance.plugin.nodes.first['attr2']
+    assert_equal 'testing.node.local', d.instance.plugin.nodes.first['attr3']
+    assert_equal 'testing.node.local', d.instance.plugin.nodes.first['attr4']
+  end
+
   def test_emit
     d = create_driver
     d.run do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-config-expander
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-02 00:00:00.000000000 Z
+date: 2012-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake