fluent-plugin-burrow 1.1 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 79b17469b72f5d09f0bc84ef8471a934cba254db
-  data.tar.gz: c91601ac6a9d7f8368aa39e79d7f12cf26418d9b
+  metadata.gz: 15a9ff282bcacf54d1aa7c6a1fa1cfd59238b5a6
+  data.tar.gz: 9495741eaa5f261773e1fbd7d68b43f6fd360e84
 SHA512:
-  metadata.gz: 8bec4b6f3f963915ad55ac28cbc20143ea346d442bc22402cb513ca2b5a40cc4b03c5619c9afc7edf03eb25690f505cb1b63455b51c8db921f3bbe596b5120c0
-  data.tar.gz: 423673c8e99d563a7b3ebdf49d4e389597b195d42167ab03180ed59f60d83af7dc6f9d00ad07a67849638c77fde68dfef5cd6d8811c3d3f6f68b5e0e757ce349
+  metadata.gz: 8ba386ea6ca214ea20c4b94a88b3c609c1839cf150ea85a570847351c65afb7a5ea2e61485e75620ca74bab0dd6146b78dde272223a44e0520dae4a6805eac6b
+  data.tar.gz: 1c5b33f9c93a27bfedc16952228de175fedf13a090cd29cb217a565c9186b546335c842b78b19e9a797191c54478f4dbc65840414d07081e2eef06cfe19058b3

data/.gitignore

@@ -2,4 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
-vendor/*
+vendor/*
+.DS_Store

data/fluent-plugin-burrow.gemspec

@@ -4,7 +4,7 @@ $:.push File.expand_path("../lib", __FILE__)
 Gem::Specification.new do |s|
   s.name        = "fluent-plugin-burrow"
   s.description = "Extract a single key (in formats Fluent can natively understand) from an event and re-emit a new event that replaces the entire original record with that key's values."
-  s.version     = "1.1"
+  s.version     = "1.2"
   s.license     = "MIT"
   s.authors     = ["Tim Gunter"]
   s.email       = ["tim@vanillaforums.com"]

data/lib/fluent/plugin/filter_burrow.rb

@@ -0,0 +1,106 @@
+# Burrow Filter Plugin
+# @author Tim Gunter <tim@vanillaforums.com>
+#
+# This plugin allows to extract a single key from an existing event and re-parse it with a given
+# format, and then re-emit a new event with the key's value replaced, or with the whole record replaced.
+#
+
+require 'fluent/filter'
+
+module Fluent
+class BurrowFilter < Filter
+  # Register type
+  Fluent::Plugin.register_filter('burrow', self)
+
+  # Required
+  config_param :key_name, :string
+  config_param :format, :string
+
+  # Optional - record format
+  config_param :action, :string, :default => 'inplace'        # The action to take once key parsing is complete
+  config_param :keep_key, :bool, :default => false            # Keep original source key (only valid with 'overlay' and 'replace' actions)
+
+  # Optional - time format
+  config_param :keep_time, :bool, :default => false           # Keep the original event's "time" key
+  config_param :record_time_key, :string, :default => 'time'  # Allow a custom time field in the record
+  config_param :time_key, :string, :default => 'time'         # Allow a custom time field in the sub-record
+  config_param :time_format, :string, :default => nil         # Allow a custom time format for the new record
+
+
+  def configure(conf)
+    super
+
+    # Validate action
+    actions = ['replace','overlay','inplace','prefix']
+    if not actions.include? @action
+      raise Fluent::ConfigError, "Invalid 'action', must be one of #{actions.join(',')}"
+    end
+
+    # Validate action-based restrictions
+    if @action == 'inplace' and @keep_key
+      raise Fluent::ConfigError, "Specifying 'keep_key' with action 'inplace' is not supported"
+    end
+    if @action == 'prefix' and not @data_prefix
+      raise Fluent::ConfigError, "You must specify 'data_prefix' with action 'prefix'"
+    end
+
+    # Prepare fluent's built-in parser
+    @parser = Fluent::Plugin.new_parser(@format)
+    @parser.configure(conf) if @parser.respond_to?(:configure)
+  end
+
+
+  def start
+    super
+  end
+
+
+  def shutdown
+    super
+  end
+
+
+  def filter(tag, time, record)
+    raw_value = record[@key_name]
+    if raw_value then
+      new_time, new_values = nil, nil
+      @parser.parse(raw_value) do |parsed_time, parsed_values|
+        new_time   = parsed_time
+        new_values = parsed_values
+      end
+
+      if new_values then
+        original_time = record[@record_time_key]
+        new_time ||= original_time
+
+        # Overlay new record on top of original record?
+        new_record = case @action
+        when 'inplace'
+          record.merge({@key_name => new_values})
+        when 'overlay'
+          record.merge(new_values)
+        when 'replace'
+          new_values
+        when 'prefix'
+          record.merge({@data_prefix => new_values})
+        end
+
+        # Keep the key?
+        if ['overlay','replace','prefix'].include? @action
+          if not @keep_key and new_record.has_key?(@key_name)
+            new_record.delete(@key_name)
+          end
+        end
+
+        # Preserve 'time' key?
+        if @keep_time
+          new_record[@record_time_key] = original_time
+        end
+
+        new_record
+      end
+    end
+  end
+
+end
+end

data/lib/fluent/plugin/out_burrow.rb

@@ -5,6 +5,8 @@
 # format, and then re-emit a new event with the key's value replaced, or with the whole record replaced.
 #
 
+require 'fluent/parser'
+
 class Fluent::BurrowPlugin < Fluent::Output
   # Register type
   Fluent::Plugin.register_output('burrow', self)
@@ -140,11 +142,11 @@ class Fluent::BurrowPlugin < Fluent::Output
 
       # Emit event back to Fluent
       if r
-        Fluent::Engine.emit(tag, t, r)
+        router.emit(tag, t, r)
       end
     end
 
     chain.next
   end
 
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-burrow
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: '1.2'
 platform: ruby
 authors:
 - Tim Gunter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-03 00:00:00.000000000 Z
+date: 2016-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -55,6 +55,7 @@ files:
 - Rakefile
 - examples/syslog.json.txt
 - fluent-plugin-burrow.gemspec
+- lib/fluent/plugin/filter_burrow.rb
 - lib/fluent/plugin/out_burrow.rb
 - test/helper.rb
 homepage: https://github.com/vanilla/fluent-plugin-burrow
@@ -77,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Fluentd output filter plugin. Extract a single key (in formats Fluent can