fluent-plugin-record-modifier 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 393309787a689b84bc9282849cd03b6d50bf68f4
-  data.tar.gz: 24c92b2b9d47a616706701f4ec38c08ccbaccef7
+  metadata.gz: df0680e5b52d63630e68ce5c1179c10703c5c3d6
+  data.tar.gz: 3ee9b91266f11bbccd1958a768963089a11516e9
 SHA512:
-  metadata.gz: 49ee18b86ca8e11cc803947c6dcc7f7beea0ce138d957ceaadb46f55053eb3ddf72d54b64bcbfd3b049bbc075823a54347acedb807cbb6b7ea972b8f6bce4eb2
-  data.tar.gz: b41c41bc4a2a972cadf7b078125d8866ba76b5324f5990c3cf7a412707e7a56c43c934d4cca85479ce6b82ec2473a786cf350ce004f1264fe7b98dbc1b12499c
+  metadata.gz: cbcfd4bade6ee3779c2d37675a6f33ae10a6362a50d3449121f8fe4fcd3b3cf065f72007b88b19dd5fd4b97cf8e4063c8bb2ffb481962bee58d22092e5ebeea8
+  data.tar.gz: 053673498e8c4091ef80a83c3c5da0eebaf3fd29c35a03055ee36a70ebd9125ecd89a2ed8eafe1d7bc3775d9840b3b25e028a504be69d6965edd79705fdf1c75

data/.travis.yml

@@ -3,8 +3,8 @@ language: ruby
 rvm:
   - 2.0.0
   - 2.1
-  - 2.2.3
-  - 2.3.0
+  - 2.2.5
+  - 2.3.1
   - ruby-head
   - rbx
 
@@ -19,6 +19,7 @@ matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: rbx
+    - rvm: 2.0.0
 
 before_install: gem update bundler
 script: bundle exec rake test

data/ChangeLog

@@ -1,3 +1,8 @@
+Release 0.5.0 - 2016/08/23
+
+  * Remove fluent-plugin-config-placeholder dependency
+    https://github.com/repeatedly/fluent-plugin-record-modifier/pull/13
+
 Release 0.4.1 - 2016/02/26
 
   * Set/Convert encoding recursively

data/README.md

@@ -1,6 +1,6 @@
 # Filter plugin for modifying each event record for [Fluentd](http://fluentd.org)
 
-Adding arbitary field to event record without custmizing existence plugin.
+Adding arbitary field to event record without customizing existence plugin.
 
 For example, generated event from *in_tail* doesn't contain "hostname" of running machine.
 In this case, you can use *record_modifier* to add "hostname" field to event record.
@@ -19,7 +19,7 @@ Use `record_modifier` filter.
       @type record_modifier
 
       <record>
-        gen_host ${hostname}
+        gen_host "#{Socket.gethostname}"
         foo bar
       </record>
     </filter>
@@ -55,28 +55,16 @@ But unlike `record_transformer`, `record_modifier` doesn't support following fea
 - tag_suffix and tag_prefix
 - dynamic key placeholder
 
-### record_modifier output
-
-In v0.10, you can use `record_modifier` output to emulate filter. `record_modifier` output doesn't support `<record>` way.
-
-    <match pattern>
-      type record_modifier
-      tag foo.filtered
-
-      gen_host ${hostname}
-      foo bar
-    </match>
-
 ### char_encoding
 
-Fluentd including some plugins treats the logs as a BINARY by default to forward.
-But an user sometimes processes the logs depends on their requirements, e.g. handling char encoding correctly.
+Fluentd including some plugins treats logs as a BINARY by default to forward.
+But a user sometimes wants to process logs depends on their requirements, e.g. handling char encoding correctly.
 
 `char_encoding` parameter is useful for this case.
 
 ```conf
 <filter pattern>
-  type record_modifier
+  @type record_modifier
 
   # set UTF-8 encoding information to string.
   char_encoding utf-8
@@ -86,6 +74,8 @@ But an user sometimes processes the logs depends on their requirements, e.g. han
 </filter>
 ```
 
+In `char_encoding from:to` case, it replaces invalid character with safe character.
+
 ### remove_keys
 
 The logs include needless record keys in some cases.
@@ -93,7 +83,7 @@ You can remove it by using `remove_keys` parameter.
 
 ```conf
 <filter pattern>
-  type record_modifier
+  @type record_modifier
 
   # remove key1 and key2 keys from record
   remove_keys key1,key2
@@ -118,7 +108,7 @@ If you want to handle the set of explicitly specified keys, you can use `whiteli
 
 ```conf
 <filter pattern>
-  type record_modifier
+  @type record_modifier
 
   # remove all keys except for key1 and key2
   whitelist_keys key1,key2
@@ -137,19 +127,24 @@ then you got new record like below:
 {"key1":"hoge", "key2":"foo"}
 ```
 
-### Mixins
+### record_modifier output
+
+In v0.10, you can use `record_modifier` output to emulate filter. `record_modifier` output doesn't support `<record>` way.
 
-* [fluent-mixin-config-placeholders](https://github.com/tagomoris/fluent-mixin-config-placeholders)
+    <match pattern>
+      type record_modifier
+      tag foo.filtered
+
+      gen_host "#{Socket.gethostname}"
+      foo bar
+    </match>
 
 ## TODO
 
 * Adding following features if needed
 
-    * Use HandleTagNameMixin to keep original tag
-
     * Replace record value
 
-
 ## Copyright
 
 <table>

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.5.0

data/fluent-plugin-record-modifier.gemspec

@@ -18,7 +18,6 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency "fluentd", [">= 0.10.58", "< 2"]
-  gem.add_dependency "fluent-mixin-config-placeholders", ">= 0.3.0"
   gem.add_development_dependency "rake", ">= 0.9.2"
   gem.add_development_dependency("test-unit", ["~> 3.1.4"])
 end

data/lib/fluent/plugin/filter_record_modifier.rb

@@ -1,4 +1,4 @@
-require 'fluent/mixin/config_placeholders'
+require 'fluent/filter'
 
 module Fluent
   class RecordModifierFilter < Filter
@@ -26,8 +26,6 @@ Modified events will have only specified keys (if exist in original events).
 This option is exclusive with `remove_keys`.
 DESC
 
-    include Fluent::Mixin::ConfigPlaceholders
-
     BUILTIN_CONFIGURATIONS = %W(type @type log_level @log_level id @id char_encoding remove_keys whitelist_keys)
 
     def configure(conf)
@@ -40,6 +38,7 @@ DESC
       @map = {}
       conf.each_pair { |k, v|
         unless BUILTIN_CONFIGURATIONS.include?(k)
+          check_config_placeholders(k, v);
           conf.has_key?(k)
           $log.warn "top level definition is deprecated. Please put parameters inside <record>: '#{k} #{v}'"
           @map[k] = DynamicExpander.new(k, v)
@@ -65,6 +64,7 @@ DESC
       @has_tag_parts = false
       conf.elements.select { |element| element.name == 'record' }.each do |element|
         element.each_pair do |k, v|
+          check_config_placeholders(k, v)
           element.has_key?(k) # to suppress unread configuration warning
           @has_tag_parts = true if v.include?('tag_parts')
           @map[k] = DynamicExpander.new(k, v)
@@ -133,6 +133,16 @@ DESC
       end
     end
 
+    HOSTNAME_PLACEHOLDERS = %W(__HOSTNAME__ ${hostname})
+
+    def check_config_placeholders(k, v)
+      HOSTNAME_PLACEHOLDERS.each { |ph|
+        if v.include?(ph)
+          raise ConfigError, %!#{ph} placeholder in #{k} is removed. Use "\#{Socket.gethostname}" instead.!
+        end
+      }
+    end
+
     class DynamicExpander
       def initialize(param_key, param_value)
         if param_value.include?('${')

data/lib/fluent/plugin/out_record_modifier.rb

@@ -1,4 +1,4 @@
-require 'fluent/mixin/config_placeholders'
+require 'fluent/output'
 
 module Fluent
   class RecordModifierOutput < Output
@@ -30,7 +30,6 @@ This option is exclusive with `remove_keys`.
 DESC
 
     include SetTagKeyMixin
-    include Fluent::Mixin::ConfigPlaceholders
 
     BUILTIN_CONFIGURATIONS = %W(type tag include_tag_key tag_key char_encoding remove_keys whitelist_keys)
 
@@ -40,6 +39,7 @@ DESC
       @map = {}
       conf.each_pair { |k, v|
         unless BUILTIN_CONFIGURATIONS.include?(k)
+          check_config_placeholders(k, v)
           conf.has_key?(k)
           @map[k] = v
         end
@@ -83,6 +83,16 @@ DESC
 
     private
 
+    HOSTNAME_PLACEHOLDERS = %W(__HOSTNAME__ ${hostname})
+
+    def check_config_placeholders(k, v)
+      HOSTNAME_PLACEHOLDERS.each { |ph|
+        if v.include?(ph)
+          raise ConfigError, %!#{ph} placeholder in #{k} is removed. Use "\#{Socket.gethostname}" instead.!
+        end
+      }
+    end
+
     def modify_record(record)
       @map.each_pair { |k, v|
         record[k] = v

data/test/test_filter_record_modifier.rb

@@ -10,20 +10,20 @@ class RecordModifierFilterTest < Test::Unit::TestCase
     @tag = 'test.tag'
   end
 
-  CONFIG = %[
+  CONFIG = %q!
     type record_modifier
     remove_keys hoge
 
     <record>
-      gen_host ${hostname}
+      gen_host "#{Socket.gethostname}"
       foo bar
       included_tag ${tag}
       tag_wrap -${tag_parts[0]}-${tag_parts[1]}-
     </record>
-  ]
+  !
 
   def create_driver(conf = CONFIG)
-    Fluent::Test::FilterTestDriver.new(Fluent::RecordModifierFilter, @tag).configure(conf)
+    Fluent::Test::FilterTestDriver.new(Fluent::RecordModifierFilter, @tag).configure(conf, true)
   end
 
   def get_hostname

data/test/test_out_record_modifier.rb

@@ -7,19 +7,19 @@ class RecordModifierOutputTest < Test::Unit::TestCase
     Fluent::Test.setup
   end
 
-  CONFIG = %[
+  CONFIG = %q!
     type record_modifier
     tag foo.filtered
 
-    gen_host ${hostname}
+    gen_host "#{Socket.gethostname}"
     foo bar
     include_tag_key
     tag_key included_tag
     remove_keys hoge
-  ]
+  !
 
   def create_driver(conf = CONFIG)
-    Fluent::Test::OutputTestDriver.new(Fluent::RecordModifierOutput, tag='test_tag').configure(conf)
+    Fluent::Test::OutputTestDriver.new(Fluent::RecordModifierOutput, tag='test_tag').configure(conf, true)
   end
 
   def get_hostname

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-record-modifier
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Masahiro Nakagawa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-26 00:00:00.000000000 Z
+date: 2016-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -30,20 +30,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
-- !ruby/object:Gem::Dependency
-  name: fluent-mixin-config-placeholders
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.3.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Filter plugin for modifying event record