fluent-plugin-switch 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6e9e0cdd83c2f9ea36224028c55e9e727e66685
+  data.tar.gz: f2f2ae33f058ddaf87fd9d2494f0d07ff30c40d4
+SHA512:
+  metadata.gz: 737c520b6c1bbcef5edb047c6fc55670979ebec718e72b8fc81cc50a967b6c794b5b8301af38a329c208f3ef83a0484559c3e2a909d0dc511c7df8d6d830c482
+  data.tar.gz: 6a1ea1e64c3b8bdeb7abe6b74e5f578550ffd370417354388fe5c455a879e68602c099d03f6294741375d34f0a83382686ad4b9b0489dac4f657780191caf85f

data/README.md

@@ -0,0 +1,123 @@
+## Fluent::Plugin::Switch
+
+Filter plugin for [Fluentd](http://fluentd.org), similar to switch statements in PLs.
+
+### Installation
+
+    $ gem install fluent-plugin-switch  
+ 
+
+### Configuration Guide
+
+    <filter *>
+      @type switch
+      key_space                 # optional : add one or a list of comma sparated keys to be used for patttern matching, defaults to all					
+      action                    # optional : append a new key or replace the value of an exisiting key, defaults to append        
+      category_name             # optional : if appending, add this key to the record, if replacing, replaces the value of this key after matching, defaults to 'category' 
+      default_value             # optional : if no matching condition found, uses this value, defaults to no action 
+      <case>
+        condition               # a regex condition to be used for matching
+        value                   # if matched use this value
+      </case>
+    </filter>  
+
+
+
+Example config (append):
+
+    <filter *>
+      @type                     switch
+      key_space                 couleur					
+      action                    append        
+      category_name             english_color
+      default_value             'no matching cases'
+      <case>
+        condition               '(couleur).+(rouge)'   
+        value                   'red'        
+      </case>
+      <case>
+        condition               '(couleur).+(jaune)'   
+        value                   'yellow'       
+      </case>
+      <case>
+        condition               '(couleur).+(bleu)'   
+        value                   'blue'       
+      </case>
+     </filter>
+     
+     
+Given the above config, if following JSON record is passed:  
+    
+    {"couleur":"La couleur est rouge"}
+    
+Then you get a new record like this : 
+
+    {"couleur":"La couleur est rouge", "english_color" : "red"}
+    
+    
+Example config (replace):
+
+    <filter *>
+      @type                     switch
+      key_space                 couleur					
+      action                    replace        
+      category_name             couleur
+      default_value             'no matching cases'
+      <case>
+        condition               '(couleur).+(rouge)'   
+        value                   'red'        
+      </case>
+      <case>
+        condition               '(couleur).+(jaune)'   
+        value                   'yellow'       
+      </case>
+      <case>
+        condition               '(couleur).+(bleu)'   
+        value                   'blue'       
+      </case>
+     </filter>
+     
+     
+Given the above config, if following JSON record is passed:  
+    
+    {"couleur":"La couleur est rouge"}
+    
+Then you get a new record like this : 
+
+    {"couleur":"red"}    
+    
+    
+
+Example config (default_value):
+
+    <filter *>
+      @type                     switch
+      key_space                 couleur					
+      action                    replace        
+      category_name             couleur
+      default_value             'no matching cases'
+      <case>
+        condition               '(couleur).+(rouge)'   
+        value                   'red'        
+      </case>
+      <case>
+        condition               '(couleur).+(jaune)'   
+        value                   'yellow'       
+      </case>
+      <case>
+        condition               '(couleur).+(bleu)'   
+        value                   'blue'       
+      </case>
+     </filter>
+     
+     
+Given the above config, if following JSON record is passed:  
+    
+    {"couleur":"La couleur est blanche"}
+    
+Then you get a new record like this : 
+
+    {"couleur":"no matching cases"} 
+    
+    
+***Note** : if the default_value config parameter is not present, and there is no matched patterns, the filter will act as a pass-thru.*

data/fluent-plugin-switch.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "fluent-plugin-switch"
+  gem.version       = "0.0.2"
+  gem.date          = '2017-08-08'
+  gem.authors       = ["Arash Vatanpoor"]
+  gem.email         = ["arash@a-venture.org"]
+  gem.summary       = %q{Fluentd filter plugin to switch events}
+  gem.description   = %q{Fluentd filter plugin to categorize events based on conditional or pattern matching of its value}
+  gem.homepage      = 'https://github.intuit.com/avatanpoor/fluent-plugin-switch'
+  gem.license       = 'MIT'
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+  # dependency
+  gem.add_runtime_dependency "fluentd", '~> 0.12'
+end

data/lib/fluent/plugin/filter_switch.rb

@@ -0,0 +1,80 @@
+class Fluent::AddFilter < Fluent::Filter
+  Fluent::Plugin.register_filter('switch', self)
+
+  config_param :tag, :string, :default => 'switch.event'
+  config_param :key_space, :string, :default => 'all'
+  config_param :action, :string,    :default => 'append'
+  config_param :category_name, :string, :default => 'category'
+  config_param :default_value, :string, :default => nil
+
+  def initialize
+    super
+  end
+
+  def configure(conf)
+    super
+    # config file validations
+    if !['append', 'replace'].include? action
+       raise Fluent::ConfigError, "undefined action, select: 'append' or 'replace'"
+    end
+
+    # do more config validation
+    ###
+
+    # create the condition / value array
+    @list = []
+    conf.elements.select { |element| element.name == 'case' }.each do |element|
+      element_hash = element.to_hash
+      if ['condition', 'value'].all? {|s| element_hash.key? s}
+        map = { 'condition' => element_hash['condition'], 'value' => element_hash['value']}
+        @list.push(map)
+      else
+        raise Fluent::ConfigError, "use 'condtion' key for pattern matching, and use 'value' key for replacement value"
+      end
+    end
+    # puts @list
+  end
+
+  # method to remap based the conditions in the config
+  def revalue(record)
+
+    # create the string to be compared against conditions
+    payload = ''
+    if key_space == 'all'
+     array = record.each{|key, value| value}
+     payload = array.join(',')
+    else
+      keys = key_space.split(',')
+      # puts keys
+      if keys.all? {|elem| record.key? elem}
+          keys.each do |key|
+            payload = payload + record[key]    
+          end
+      else
+        raise Fluent::ConfigError, "one or more keys provided don't exist in the record"
+      end
+    end
+    @list.each do |hash|
+      regex_pattern = Regexp.new hash['condition']
+      if regex_pattern =~ (payload)
+        return hash['value']
+      end
+    end
+    return (default_value) ? default_value : record[category_name]
+  end
+
+
+  def filter(tag, time, record)
+    value = revalue(record)
+    if action == 'append'
+      record = record.merge!(category_name => value)
+    else
+      if record.has_key? category_name
+        record[category_name] = value
+      else
+        raise Fluent::ConfigError, "can't find the key in record to replace its value"
+      end
+    end
+    return record
+  end
+end

data/reinstall.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+# basic clean-up and reinstall
+fluent-gem uninstall fluent-plugin-switch
+rm -f ./fluent-plugin-switch-0.0.1.gem
+gem build ./fluent-plugin-switch.gemspec
+fluent-gem install ./fluent-plugin-switch-0.0.1.gem
+fluentd -c ./config/switch.conf
+ 

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-switch
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Arash Vatanpoor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: Fluentd filter plugin to categorize events based on conditional or pattern
+  matching of its value
+email:
+- arash@a-venture.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- fluent-plugin-switch.gemspec
+- lib/fluent/plugin/filter_switch.rb
+- reinstall.sh
+homepage: https://github.intuit.com/avatanpoor/fluent-plugin-switch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Fluentd filter plugin to switch events
+test_files: []