fluent-plugin-map 0.0.4 → 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: decebfbf41fc12fb15d386f4ff981c47f8664d29
+  data.tar.gz: 0cae24b1126273459013218f0928e84e1087b243
+SHA512:
+  metadata.gz: 524e10fd9c10a5eeda5e048f537b33bcb555b2a16229d033cd78a7c5f80fcab8319cf2e3fa067cd76e7904f945a3d518d1c54fda9a9faf9143fd6565132a6ae4
+  data.tar.gz: fbec0673c454365306cb61d1f8d9162c38e3a0d37078986321b95871b08378d02efe625747a06657113303eb5c2810a1a08cffcc704af09c5fb8db40864975d6

data/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.markdown

@@ -14,7 +14,7 @@ This sample config output code file and time file.
     </source>
     <match tag>
       type map
-      map [["code." + tag, time, {"code" => record["code"].to_i}], ["time." + tag, time, {"time" => record["time"].to_i}]]
+      map ([["code." + tag, time, {"code" => record["code"].to_i}], ["time." + tag, time, {"time" => record["time"].to_i}]])
       multi true
     </match>
     <match code.tag>
@@ -35,11 +35,19 @@ If you don't use multi option, you can use key, time, record parameter. The 2 fo
 
     <match tag>
       type map
-      map ["code." + tag, time, {"code" => record["code"].to_i}]
+      map (["code." + tag, time, {"code" => record["code"].to_i}])
     </match>
     <match tag>
       type map
-      tag "code." + tag
+      tag ("code." + tag)
       time time
-      record {"code" => record["code"].to_i}
+      record ({"code" => record["code"].to_i})
     </match>
+
+Note: you have to wrap some configuration values with parenthesis like `("code." + tag)`, to avoid parsing by Fluentd itself.
+See also: [Fluentd | Configuration File | Format tips](http://docs.fluentd.org/articles/config-file#format-tips)
+
+## Copyright
+
+* Copyright (c) 2015- Tomita Kohei
+* Apache License, Version 2.0

data/fluent-plugin-map.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "fluent-plugin-map"
-  s.version     = "0.0.4"
+  s.version     = "0.0.5"
   s.authors     = ["Kohei Tomita"]
   s.email       = ["tommy.fmale@gmail.com"]
   s.homepage    = "https://github.com/tomity/fluent-plugin-map"

data/lib/fluent/plugin/out_map.rb

@@ -10,22 +10,91 @@ module Fluent
     config_param :record, :string, :default => nil
     config_param :multi, :bool, :default => false
     config_param :timeout, :time, :default => 1
+    config_param :format, :string, :default => nil
+
+    MMAP_MAX_NUM = 50
 
     def configure(conf)
       super
-      if @map
-        $log.debug { "map: #{@map}" }
-        @mode = "tuple"
+      @format = determine_format()
+      configure_format()
+      @map = create_map(conf)
+    end
+
+    def determine_format()
+      if @format
+        @format
+      elsif @map
+        "map"
       elsif (@tag || @key) && @time && @record
+        "record"
+      else
+        raise ConfigError, "Any of map, 3 parameters(key, time, and record) or format is required "
+      end
+    end
+
+    def configure_format()
+      case @format
+      when "map"
+        # pass
+      when "record"
         @tag ||= @key
         raise ConfigError, "multi and 3 parameters(tag, time, and record) are not compatible" if @multi
-        $log.debug { "tag: #{@tag}, time: #{@time}, record: #{@record}" }
-        @mode = "each"
+      when "multimap"
+        # pass.
       else
-        raise ConfigError, "Either map or 3 parameters(key, time, and record) is required "
+        raise ConfigError, "format #{@format} is invalid."
+      end
+    end
+
+    def create_map(conf)
+      # return string like double array.
+      case @format
+      when "map"
+        parse_map()
+      when "record"
+        "[[#{@tag}, #{@time}, #{@record}]]"
+      when "multimap"
+        parse_multimap(conf)
+      end
+    end
+
+    def parse_map()
+      if @multi
+        @map
+      else
+        "[#{@map}]"
+      end
+    end
+
+    def parse_multimap(conf)
+      check_mmap_range(conf)
+      
+      prev_mmap = nil
+      result_mmaps = (1..MMAP_MAX_NUM).map { |i|
+        mmap = conf["mmap#{i}"]
+        if (i > 1) && prev_mmap.nil? && !mmap.nil?
+          raise ConfigError, "Jump of mmap index found. mmap#{i - 1} is missing."
+        end
+        prev_mmap = mmap
+        next if mmap.nil?
+
+        mmap
+      }.compact.join(',')
+      "[#{result_mmaps}]"
+    end
+
+    def check_mmap_range(conf)
+      invalid_mmap = conf.keys.select { |k|
+        m = k.match(/^mmap(\d+)$/)
+        m ? !((1..MMAP_MAX_NUM).include?(m[1].to_i)) : false
+      }
+      unless invalid_mmap.empty?
+        raise ConfigError, "Invalid mmapN found. N should be 1 - #{MMAP_MAX_NUM}: " + invalid_mmap.join(",")
       end
     end
 
+
     def emit(tag, es, chain)
       begin
         tag_output_es = do_map(tag, es)
@@ -42,11 +111,8 @@ module Fluent
     end
 
     def do_map(tag, es)
-      tuples = if @multi
-                 generate_tuples_multi(tag, es)
-               else
-                 generate_tuples_single(tag, es)
-               end
+      tuples = generate_tuples(tag, es)
+
       tag_output_es = Hash.new{|h, key| h[key] = MultiEventStream::new}
       tuples.each do |tag, time, record|
         if time == nil || record == nil
@@ -58,32 +124,13 @@ module Fluent
       tag_output_es
     end
 
-    def generate_tuples_multi(tag, es)
+    def generate_tuples(tag, es)
       tuples = []
       es.each {|time, record|
         new_tuple = eval(@map)
         tuples.concat new_tuple
       }
-     tuples
-    end
-
-    def generate_tuples_single(tag, es)
-      tuples = []
-      es.each {|time, record|
-        timeout_block(tag, time, record){
-          case @mode
-          when "tuple"
-            new_tuple = eval(@map)
-            tuples << new_tuple
-          when "each"
-            new_tag = eval(@tag)
-            new_time = eval(@time)
-            new_record = eval(@record)
-            tuples << [new_tag, new_time, new_record]
-          end
-        }
-      }
-     tuples
+      tuples
     end
 
     def timeout_block(tag, time, record)

data/test/plugin/test_out_map.rb

@@ -160,7 +160,7 @@ class MapOutputTest < Test::Unit::TestCase
   def test_config_error_multi
     tag = "tag"
     time = Time.local(2012, 10, 10, 10, 10, 0)
-    time = Time.local(2012, 10, 10, 10, 10, 0)
+    #time = Time.local(2012, 10, 10, 10, 10, 0)
     record = {'code' => '300'}
 
     #require time
@@ -191,4 +191,66 @@ class MapOutputTest < Test::Unit::TestCase
     emits = d1.emits
     assert_equal 0, emits.length
   end
+
+  # Add format test
+  ## test format type (map, record, maps)
+  ## test Backward compatibility without format
+  ## 
+
+  def test_convert_format_map
+    tag = 'tag'
+    time = Time.local(2012, 10, 10, 10, 10, 10)
+    record = {'code1' => '300', 'code2' => '400'}
+
+    d1 = create_driver %[
+      format map
+      map [["tag1", time, record["code1"]], ["tag2", time, record["code2"]]]
+      multi true
+    ], tag
+    d1.run do
+      d1.emit(record, time)
+    end
+    emits = d1.emits
+    assert_equal 2, emits.length
+    assert_equal ["tag1", time.to_i, record["code1"]], emits[0]
+    assert_equal ["tag2", time.to_i, record["code2"]], emits[1]
+  end
+
+  def test_tag_convert_format_record
+    tag = 'tag'
+    time = Time.local(2012, 10, 10, 10, 10, 10)
+    record = {'code' => '300'}
+
+    d1 = create_driver %[
+      format record
+      tag "newtag"
+      time time
+      record record
+    ], tag
+    d1.run do
+      d1.emit(record, time)
+    end
+    emits = d1.emits
+    assert_equal 1, emits.length
+    assert_equal ["newtag", time.to_i, record], emits[0]
+  end
+
+  def test_convert_format_multimap
+    tag = 'tag'
+    time = Time.local(2012, 10, 10, 10, 10, 10)
+    record = {'code1' => '300', 'code2' => '400'}
+
+    d1 = create_driver %[
+      format multimap
+      mmap1 ["tag1", time, record["code1"]]
+      mmap2 ["tag2", time, record["code2"]]
+    ], tag
+    d1.run do
+      d1.emit(record, time)
+    end
+    emits = d1.emits
+    assert_equal 2, emits.length
+    assert_equal ["tag1", time.to_i, record["code1"]], emits[0]
+    assert_equal ["tag2", time.to_i, record["code2"]], emits[1]
+  end
 end

metadata

@@ -1,49 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-map
 version: !ruby/object:Gem::Version
-  version: 0.0.4
-  prerelease: 
+  version: 0.0.5
 platform: ruby
 authors:
 - Kohei Tomita
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-24 00:00:00.000000000 Z
+date: 2015-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.2.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.2.2
 - !ruby/object:Gem::Dependency
   name: fluentd
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.24
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.24
-description: ! 'fluent-plugin-map is the non-buffered plugin that can convert an event
+description: 'fluent-plugin-map is the non-buffered plugin that can convert an event
   log to different event log(s).  '
 email:
 - tommy.fmale@gmail.com
@@ -51,8 +46,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
+- LICENSE
 - README.markdown
 - Rakefile
 - fluent-plugin-map.gemspec
@@ -61,27 +57,26 @@ files:
 - test/plugin/test_out_map.rb
 homepage: https://github.com/tomity/fluent-plugin-map
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: fluent-plugin-map
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: fluent-plugin-map is the non-buffered plugin that can convert an event log
   to different event log(s).
 test_files: