fluent-plugin-mutate_filter 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3165a0eb4bc45209deb87deb2a6683d49673fbd0
-  data.tar.gz: 47045da023e67de18b1bb1bc7ea33b60df8d6dcc
+  metadata.gz: 37b660658d4e6fd887a3955692e5bb9dc705af04
+  data.tar.gz: 960455819ab4a23dbe3672be563368a330f04699
 SHA512:
-  metadata.gz: 3f383885c34e9442302cfdeb177097488ba25de538989fcae14700967e320f66dd23f904c1b58333dd3c812bc2ec5c5582ef09b8e077bdeba332de69e473ec08
-  data.tar.gz: 2be81b2f14c0186a4a5a15195e7fce39e4cdc67ae63df2c44bcf0757e55f60a90fdb9d752b44c11633d8af8fb8cc8af76b8bfb048f57269883397042751b6b64
+  metadata.gz: 8ef1cc5d483709fe9d4234094c5d57ab9a568467894928a6b8f8a3686019180dc06953246cea0391b561d0dcc78029128ed6460a5cacd6af979a0ad7cd0125fc
+  data.tar.gz: '0120295c8e6331d44e5aa3a98609401b9cb51cb8673c8ad29c4634e32c1f2824a40e0b072a0135efa5aba747dfdb1fb11dda765804a83de63b130fdaabf23a9e'

data/CHANGELOG.md

@@ -1,10 +1,16 @@
 # Changelog
 
-v2.0.1
+v0.3.0
+-------------
+* Resolve bug in error handling
+* Add support for %e{} tags to replace with environment variables
+* Add support for %e{hostname} tag to replace with hostname
+
+v0.2.1
 -------------
 * Resolve bug in datetime converter
 
-v2.0.0
+v0.2.0
 -------------
 * Fix MutateEvent initializer bug
 * Add support for event_tag and event_time substitutions %{event_time}

data/fluent-plugin-mutate_filter.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-mutate_filter"
-  spec.version       = "0.2.1"
+  spec.version       = "0.3.0"
   spec.authors       = ["Jonathan Serafini"]
   spec.email         = ["jonathan@serafini.ca"]
   spec.summary       = %q{A mutate filter for Fluent which functions like Logstash.}

data/lib/fluent/plugin/filter_mutate.rb

@@ -1,3 +1,4 @@
+require 'socket'
 require 'fluent/filter'
 require 'fluent/plugin_mixin/mutate_event'
 
@@ -20,8 +21,8 @@ module Fluent
 
     # Update an existing field with a new value.
     # - If the field does not exist then no action will be taken.
-    # - If the new value contains a placeholder %{}, then the value will be 
-    #   expanded to the related event record field. 
+    # - If the new value contains a placeholder %{}, then the value will be
+    #   expanded to the related event record field.
     # @example
     #   update {
     #     "message": "%{hostname}: new message"
@@ -59,7 +60,7 @@ module Fluent
 
     # Convert a string field by applying a regular expression and replacement.
     # - If the field is not a string, then no action will be taken.
-    # 
+    #
     # The configuration takes an array consisting of 3 elements per field/sub.
     #
     # @example
@@ -84,14 +85,14 @@ module Fluent
     config_param :lowercase,  :array, default: Array.new
 
     # Strip whitespace from field.
-    # @example 
+    # @example
     #   strip [
     #     "field1"
     #   ]
     config_param :strip,      :array, default: Array.new
 
     # Split a field to an array using a separator character
-    # @example 
+    # @example
     #   split {
     #     "field1": ","
     #   }
@@ -111,7 +112,7 @@ module Fluent
     #   }
     config_param :merge,      :hash, default: Hash.new
 
-    # List of all possible mutate actions, in the order that we will apply 
+    # List of all possible mutate actions, in the order that we will apply
     # them. As it stands, this is the order in which Logstash would apply them.
     MUTATE_ACTIONS = %w(
       rename
@@ -138,6 +139,9 @@ module Fluent
     TRUE_REGEX = (/^(true|t|yes|y|1)$/i).freeze
     FALSE_REGEX = (/^(false|f|no|n|0)$/i).freeze
 
+    # Placeholder regex
+    ENVIRONMENT_TAG_REGEXP = /%e\{[^}]+\}/
+
     # Placeholder regex
     TEMPLATE_TAG_REGEXP = /%\{[^}]+\}/
 
@@ -149,13 +153,13 @@ module Fluent
 
       @convert.nil? or @convert.each do |field, type|
         if !VALID_CONVERSIONS.include?(type)
-          raise ConfigError, 
+          raise ConfigError,
             "convert #{type} is not one of #{VALID_CONVERSIONS.join(',')}."
         end
       end
 
       @gsub_parsed = []
-      @gsub.nil? or 
+      @gsub.nil? or
       @gsub.each_slice(3) do |field, needle, replacement|
         if [field, needle, replacement].any? {|n| n.nil?}
           raise ConfigError,
@@ -197,6 +201,15 @@ module Fluent
 
     protected
 
+    # Expand replacable patterns on the event
+    # @since 0.3.0
+    # @return [String] the modified string
+    def expand_patterns(event, string)
+      string = expand_references(event, string)
+      string = expand_environment(event, string)
+      string
+    end
+
     # Expand %{} strings to the related event fields.
     # @since 0.1.0
     # @return [String] the modified string
@@ -231,6 +244,39 @@ module Fluent
       new_string
     end
 
+    # Expand %e{} strings to the related environment variables.
+    # @since 0.3.0
+    # @return [String] the modified string
+    def expand_environment(event, string)
+      new_string = ''
+
+      position = 0
+      matches = string.scan(ENVIRONMENT_TAG_REGEXP).map{|m| $~}
+
+      matches.each do |match|
+        reference_tag = match[0][2..-2]
+        reference_value = case reference_tag
+                          when "hostname" then Socket.gethostname
+                          else ENV[reference_tag]
+                          end
+        if reference_value.nil?
+          @log.error "failed to replace tag", field: reference_tag
+          reference_value = match.to_s
+        end
+
+        start = match.offset(0).first
+        new_string << string[position..(start-1)] if start > 0
+        new_string << reference_value
+        position = match.offset(0).last
+      end
+
+      if position < string.size
+        new_string << string[position..-1]
+      end
+
+      new_string
+    end
+
     # Remove fields from the event hash
     # @since 0.1.0
     def remove(event)
@@ -254,7 +300,7 @@ module Fluent
     # @since 0.1.0
     def update(event)
       @update.each do |field, newvalue|
-        newvalue = expand_references(event, newvalue)
+        newvalue = expand_patterns(event, newvalue)
         next unless event.include?(field)
         event.set(field, newvalue)
       end
@@ -264,7 +310,7 @@ module Fluent
     # @since 0.1.0
     def replace(event)
       @replace.each do |field, newvalue|
-        newvalue = expand_references(event, newvalue)
+        newvalue = expand_patterns(event, newvalue)
         event.set(field, newvalue)
       end
     end
@@ -324,8 +370,8 @@ module Fluent
                  when String
                    original.upcase! || original
                  else
-                   @log.error("can't uppercase field", 
-                              field: field, 
+                   @log.error("can't uppercase field",
+                              field: field,
                               value: original)
                    original
                  end
@@ -346,8 +392,8 @@ module Fluent
                  when String
                    original.downcase! || original
                  else
-                   @log.error("can't lowercase field", 
-                              field: field, 
+                   @log.error("can't lowercase field",
+                              field: field,
                               value: original)
                    original
                  end
@@ -363,7 +409,7 @@ module Fluent
         if value.is_a?(String)
           event.set(field, value.split(separator))
         else
-          @loger.error("can't split field", 
+          @log.error("can't split field",
                        field: field,
                        value: value)
         end
@@ -435,9 +481,9 @@ module Fluent
           result = value.map do |v|
             if v.is_a?(String)
               gsub_dynamic_fields(event, v, needle, replacement)
-            else 
-              @log.error('cannot gsub non Strings', 
-                         field: field, 
+            else
+              @log.error('cannot gsub non Strings',
+                         field: field,
                          value: v)
             end
             event.set(field, result)
@@ -452,7 +498,7 @@ module Fluent
     end
 
     def gsub_dynamic_fields(event, original, needle, replacement)
-      replacement = expand_references(event, replacement)
+      replacement = expand_patterns(event, replacement)
       if needle.is_a?(Regexp)
         original.gsub(needle, replacement)
       else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-mutate_filter
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Jonathan Serafini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2017-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: A mutate filter for Fluent which functions like Logstash.