fluent-mixin-config-placeholders 0.1.0 → 0.2.0

data/README.md

@@ -2,13 +2,15 @@
 
 Fluent::Mixin::ConfigPlaceHolders provide some placeholders to fluentd plugins that includes this mix-in. Placeholders below are expanded in 'super' of including plugin's #configure method.
 
+Placeholder patterns are `${..}` and `__XXX__`. With optional setting in plugin code, `%{...}` is available.
+
 Available placeholders are:
 
-* hostname (${hostname} or \_\_HOSTNAME\_\_)
+* hostname (${hostname}, %{hostname} or \_\_HOSTNAME\_\_)
   * you can specify hostname string explicitly on 'hostname' parameter
-* random uuid (${uuid}, ${uuid:random}, \_\_UUID\_\_ or \_\_UUID\_RANDOM\_\_)
-* hostname string based uuid (${uuid:hostname} or \_\_UUID\_HOSTNAME\_\_)
-* timestamp based uuid (${uuid:timestamp} or \_\_UUID\_TIMESTAMP\_\_)
+* random uuid (${uuid}, ${uuid:random}, %{uuid}, %{uuid:random}, \_\_UUID\_\_ or \_\_UUID\_RANDOM\_\_)
+* hostname string based uuid (${uuid:hostname}, %{uuid:hostname} or \_\_UUID\_HOSTNAME\_\_)
+* timestamp based uuid (${uuid:timestamp} %{uuid:timestamp} or \_\_UUID\_TIMESTAMP\_\_)
 
 ## Usage
 
@@ -32,9 +34,31 @@ In plugin (both of input and output), just include mixin.
 
 You can use this feature for tags for each fluentd node, paths for remote storage services like /root/${hostname}/access_log or non-race-condition paths like /files/${uuid:random}.
 
+### Plugin setting
+
+Plugin can determine which placeholders are enabled in their configurations, like this:
+
+    class FooInput < Fluent::Input
+      # ....
+      
+      # instance method #placeholders should return array of symbols
+      
+      def placeholders
+        [:dollar, :percentage, :underscore]
+      end
+      
+      # default is [:dollar, :underscore]
+      
+      include Fluent::Mixin::ConfigPlaceholders
+      
+      # ....
+    end
+
 ## AUTHORS
 
 * TAGOMORI Satoshi <tagomoris@gmail.com>
+* Contributors
+  * @ijin
 
 ## LICENSE
 

data/fluent-mixin-config-placeholders.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |gem|
   gem.name          = "fluent-mixin-config-placeholders"
-  gem.version       = "0.1.0"
+  gem.version       = "0.2.0"
   gem.authors       = ["TAGOMORI Satoshi"]
   gem.email         = ["tagomoris@gmail.com"]
   gem.description   = %q{to add various placeholders for plugin configurations}

data/lib/fluent/mixin/config_placeholders.rb

@@ -6,17 +6,19 @@ module Fluent
     module ConfigPlaceholders
       attr_accessor :hostname
 
-      # ${hostname}, __HOSTNAME__
+      PLACEHOLDERS_DEFAULT = [ :dollar, :underscore ] # and :percent
 
-      # ${uuid} or ${uuid:random} , __UUID__ or __UUID_RANDOM__
+      # ${hostname}, %{hostname}, __HOSTNAME__
+
+      # ${uuid} or ${uuid:random} , %{uuid} or %{uuid:random} __UUID__ or __UUID_RANDOM__
       # UUIDTools::UUID.random_create
       # => #<UUID:0x19013a UUID:984265dc-4200-4f02-ae70-fe4f48964159>
 
-      # ${uuid:hostname} , __UUID_HOSTNAME__
+      # ${uuid:hostname} , %{uuid:hostname} , __UUID_HOSTNAME__
       # UUIDTools::UUID.sha1_create(UUIDTools::UUID_DNS_NAMESPACE, "www.widgets.com")
       # => #<UUID:0x2a0116 UUID:21f7f8de-8051-5b89-8680-0195ef798b6a>
 
-      # ${uuid:timestamp} , __UUID_TIMESTAMP__
+      # ${uuid:timestamp} , %{uuid:timestamp} , __UUID_TIMESTAMP__
       # UUIDTools::UUID.timestamp_create
       # => #<UUID:0x2adfdc UUID:64a5189c-25b3-11da-a97b-00c04fd430c8>
 
@@ -40,18 +42,40 @@ module Fluent
         # Element#has_key? inserts key name into 'used' list, so we should escape that method...
         hostname = conf.keys.include?('hostname') ? conf['hostname'] : `hostname`.chomp
 
-        mapping = {
-          '${hostname}'  => lambda{ hostname },
-          '__HOSTNAME__' => lambda{ hostname },
-          '${uuid}'         => lambda{ uuid_random() },
-          '__UUID__'        => lambda{ uuid_random() },
-          '${uuid:random}'  => lambda{ uuid_random() },
-          '__UUID_RANDOM__' => lambda{ uuid_random() },
-          '${uuid:hostname}'  => lambda { uuid_hostname(hostname) },
-          '__UUID_HOSTNAME__' => lambda { uuid_hostname(hostname) },
-          '${uuid:timestamp}'  => lambda { uuid_timestamp() },
-          '__UUID_TIMESTAMP__' => lambda { uuid_timestamp() },
-        }
+        placeholders = self.respond_to?(:placeholders) ? self.placeholders : PLACEHOLDERS_DEFAULT
+
+        mapping = {}
+
+        placeholders.each do |p|
+          case p
+          when :dollar
+            mapping.update({
+                '${hostname}'       => lambda{ hostname },
+                '${uuid}'           => lambda{ uuid_random() },
+                '${uuid:random}'    => lambda{ uuid_random() },
+                '${uuid:hostname}'  => lambda{ uuid_hostname(hostname) },
+                '${uuid:timestamp}' => lambda{ uuid_timestamp() },
+              })
+          when :percent
+            mapping.update({
+                '%{hostname}'       => lambda{ hostname },
+                '%{uuid}'           => lambda{ uuid_random() },
+                '%{uuid:random}'    => lambda{ uuid_random() },
+                '%{uuid:hostname}'  => lambda{ uuid_hostname(hostname) },
+                '%{uuid:timestamp}' => lambda{ uuid_timestamp() },
+              })
+          when :underscore
+            mapping.update({
+                '__HOSTNAME__'       => lambda{ hostname },
+                '__UUID__'           => lambda{ uuid_random() },
+                '__UUID_RANDOM__'    => lambda{ uuid_random() },
+                '__UUID_HOSTNAME__'  => lambda{ uuid_hostname(hostname) },
+                '__UUID_TIMESTAMP__' => lambda{ uuid_timestamp() },
+              })
+          else
+            raise ArgumentError, "unknown placeholder format: #{p}"
+          end
+        end
 
         def check_element(map,c)
           c.arg = replace(map, c.arg)

data/test/mixin/test_config_placeholders.rb

@@ -30,13 +30,24 @@ path POSPOSPOS ${hostname} MOGEMOGE
     assert_equal [], p.conf.used
   end
 
-  def test_hostname
+  def test_default
     conf = %[
+hostname testing
+tag ${hostname}.%{hostname}.__HOSTNAME__
+path /${hostname}/%{hostname}/__HOSTNAME__.log
+]
+    p = Fluent::Test::InputTestDriver.new(Fluent::ConfigPlaceholdersTestDefaultInput).configure(conf).instance
+    assert_equal 'testing.%{hostname}.testing', p.tag
+    assert_equal '/testing/%{hostname}/testing.log', p.path
+  end
+
+  def test_hostname
+    conf1 = %[
 hostname testing.local
 tag out.${hostname}
 path /path/to/file.__HOSTNAME__.txt
 ]
-    p1, p2, p3 = create_plugin_instances(conf)
+    p1, p2, p3 = create_plugin_instances(conf1)
 
     assert_equal 'out.${hostname}', p1.tag
     assert_equal 'out.testing.local', p2.tag
@@ -45,6 +56,21 @@ path /path/to/file.__HOSTNAME__.txt
     assert_equal '/path/to/file.__HOSTNAME__.txt', p1.path
     assert_equal '/path/to/file.testing.local.txt', p2.path
     assert_equal '/PATH/TO/FILE.TESTING.LOCAL.TXT', p3.path
+
+    conf2 = %[
+hostname testing.local
+tag out.%{hostname}
+path /path/to/file.%{hostname}.txt
+]
+    p1, p2, p3 = create_plugin_instances(conf2)
+
+    assert_equal 'out.%{hostname}', p1.tag
+    assert_equal 'out.testing.local', p2.tag
+    assert_equal 'out.testing.local', p3.tag
+
+    assert_equal '/path/to/file.%{hostname}.txt', p1.path
+    assert_equal '/path/to/file.testing.local.txt', p2.path
+    assert_equal '/PATH/TO/FILE.TESTING.LOCAL.TXT', p3.path
   end
 
   PATH_CHECK_REGEXP = Regexp.compile('^/path/to/file\.[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}.txt$')
@@ -82,37 +108,67 @@ path /path/to/file.__UUID__.txt
     p1, p2, p3 = create_plugin_instances(conf4)
     assert_match PATH_CHECK_REGEXP, p2.path
     assert_match PATH_CHECK_REGEXP2, p3.path
+
+    conf5 = %[
+tag test.out
+path /path/to/file.%{uuid}.txt
+]
+    p1, p2, p3 = create_plugin_instances(conf5)
+    assert_match PATH_CHECK_REGEXP, p2.path
+    assert_match PATH_CHECK_REGEXP2, p3.path
+
+    conf6 = %[
+tag test.out
+path /path/to/file.%{uuid:random}.txt
+]
+    p1, p2, p3 = create_plugin_instances(conf6)
+    assert_match PATH_CHECK_REGEXP, p2.path
+    assert_match PATH_CHECK_REGEXP2, p3.path
   end
 
   PATH_CHECK_H_REGEXP = Regexp.compile('^/path/to/file\.[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}.log$')
   PATH_CHECK_H_REGEXP2 = Regexp.compile('^/PATH/TO/FILE\.[0-9A-F]{8}-([0-9A-F]{4}-){3}[0-9A-F]{12}.LOG$')
 
+
   def test_uuid_hostname
     conf1 = %[
+hostname testing.local
 tag test.out
 path /path/to/file.${uuid:hostname}.log
 ]
     p1, p2, p3 = create_plugin_instances(conf1)
     assert_match PATH_CHECK_H_REGEXP, p2.path
-    assert_equal '/path/to/file.87577bd5-6d8c-5dff-8988-0bc01cb8ed53.log', p2.path
+    assert_equal '/path/to/file.acc701f6-9be5-578b-9580-85ec8a505600.log', p2.path
     assert_match PATH_CHECK_H_REGEXP2, p3.path
-    assert_equal '/PATH/TO/FILE.87577BD5-6D8C-5DFF-8988-0BC01CB8ED53.LOG', p3.path
+    assert_equal '/PATH/TO/FILE.ACC701F6-9BE5-578B-9580-85EC8A505600.LOG', p3.path
 
     conf2 = %[
+hostname testing.local
 tag test.out
 path /path/to/file.__UUID_HOSTNAME__.log
 ]
     p1, p2, p3 = create_plugin_instances(conf2)
     assert_match PATH_CHECK_H_REGEXP, p2.path
-    assert_equal '/path/to/file.87577bd5-6d8c-5dff-8988-0bc01cb8ed53.log', p2.path
+    assert_equal '/path/to/file.acc701f6-9be5-578b-9580-85ec8a505600.log', p2.path
+    assert_match PATH_CHECK_H_REGEXP2, p3.path
+    assert_equal '/PATH/TO/FILE.ACC701F6-9BE5-578B-9580-85EC8A505600.LOG', p3.path
+
+    conf3 = %[
+hostname testing.local
+tag test.out
+path /path/to/file.%{uuid:hostname}.log
+]
+    p1, p2, p3 = create_plugin_instances(conf3)
+    assert_match PATH_CHECK_H_REGEXP, p2.path
+    assert_equal '/path/to/file.acc701f6-9be5-578b-9580-85ec8a505600.log', p2.path
     assert_match PATH_CHECK_H_REGEXP2, p3.path
-    assert_equal '/PATH/TO/FILE.87577BD5-6D8C-5DFF-8988-0BC01CB8ED53.LOG', p3.path
+    assert_equal '/PATH/TO/FILE.ACC701F6-9BE5-578B-9580-85EC8A505600.LOG', p3.path
   end
 
   PATH_CHECK_T_REGEXP = Regexp.compile('^/path/to/file\.[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}.out$')
   PATH_CHECK_T_REGEXP2 = Regexp.compile('^/PATH/TO/FILE\.[0-9A-F]{8}-([0-9A-F]{4}-){3}[0-9A-F]{12}.OUT$')
 
-  def test_uuid_hostname
+  def test_uuid_timestamp
     conf1 = %[
 tag test.out
 path /path/to/file.${uuid:timestamp}.out
@@ -123,11 +179,19 @@ path /path/to/file.${uuid:timestamp}.out
 
     conf2 = %[
 tag test.out
-path /path/to/file.__UUID_HOSTNAME__.out
+path /path/to/file.__UUID_TIMESTAMP__.out
 ]
     p1, p2, p3 = create_plugin_instances(conf2)
     assert_match PATH_CHECK_T_REGEXP, p2.path
     assert_match PATH_CHECK_T_REGEXP2, p3.path
+
+    conf3 = %[
+tag test.out
+path /path/to/file.%{uuid:timestamp}.out
+]
+    p1, p2, p3 = create_plugin_instances(conf3)
+    assert_match PATH_CHECK_T_REGEXP, p2.path
+    assert_match PATH_CHECK_T_REGEXP2, p3.path
   end
 
   def test_nested

data/test/plugin.rb

@@ -9,6 +9,15 @@ class Fluent::ConfigPlaceholdersTestXInput < Fluent::Input
   end
 end
 
+class Fluent::ConfigPlaceholdersTestDefaultInput < Fluent::Input
+  Fluent::Plugin.register_input('config_placeholder_test_1', self)
+
+  config_param :tag, :string
+  config_param :path, :string
+
+  include Fluent::Mixin::ConfigPlaceholders
+end
+
 class Fluent::ConfigPlaceholdersTest0Input < Fluent::Input
   Fluent::Plugin.register_input('config_placeholder_test_0', self)
 
@@ -30,6 +39,7 @@ class Fluent::ConfigPlaceholdersTest1Input < Fluent::Input
   config_param :tag, :string
   config_param :path, :string
 
+  def placeholders; [:dollar, :percent, :underscore]; end
   include Fluent::Mixin::ConfigPlaceholders
 end
 
@@ -43,6 +53,7 @@ class Fluent::ConfigPlaceholdersTest2Input < Fluent::Input
 
   attr_accessor :conf
 
+  def placeholders; [:dollar, :percent, :underscore]; end
   def configure(conf)
     super
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-mixin-config-placeholders
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-20 00:00:00.000000000 Z
+date: 2013-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd