fluent-plugin-multi-format-parser 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3ccd298b01b05ed96a4494b153bd4ee4abd2b8d
-  data.tar.gz: 5b8399121244fd4f5939a7acb8c2481c6450d1ce
+  metadata.gz: da4c776b74c85a0624c5cc7f899b041ff8b0c196
+  data.tar.gz: 866aa7acf91781fdb2959c69ad8d94375f0f569c
 SHA512:
-  metadata.gz: fefc45c5044df050487e7189d0071ee6021c29cac9ba4383e91273a08bdbf9cea851cd29ce160eac99df3c9994a775e48eb62f0c1db63bbc157aadccd2a14f3d
-  data.tar.gz: 8a69a5e16b154f21961b7227ee6e55a8ee7945825a966cc2e2badf5cde8ba9b921d5f671485947795979449c095d05d50089a4df401b826ec25aa1288b20c9d9
+  metadata.gz: 86375df425d675d69613190c69ab05a8d0e304ce51e9456d2338b1ba9dd2c2070c33d9347b2f05c9ec245794f9e1937c8c0afe3bb1d29b7852637202f2918c4a
+  data.tar.gz: 87b2222ffa0188677498299b7570109f4cc11ac4a4a7e0a4c012ec4dccb82a6b54a33cedb0de2cdccbcdd44e7cf8d0b5f9f3cf6e163f2ebe2e3152c6d4704326

data/README.md

@@ -2,6 +2,13 @@
 
 Parse format mixed logs.
 
+## Requirements
+
+| fluent-plugin-multi-format-parser | fluentd | ruby |
+|-------------------|---------|------|
+| >= 1.0.0 | >= v0.14.0 | >= 2.1 |
+|  < 1.0.0 | >= v0.12.0 | >= 1.9 |
+
 ## Installation
 
 Use RubyGems:
@@ -10,50 +17,75 @@ Use RubyGems:
 
 ## Configuration
 
-This plugin is a parser plugin. After installed, you can use `multi_format` in `format` supported plugins.
-Use multiple `<pattern>` to specify multiple format.
+This plugin is a parser plugin. After installed, you can use `multi_format` in `<parse>` supported plugins.
+Use multiple `<pattern>`s to specify multiple parser formats.
 
     <source>
       @type udp
       tag logs.multi
 
-      format multi_format
-      <pattern>
-        format apache
-      </pattern>
-      <pattern>
-        format json
-        time_key timestamp
-      </pattern>
-      <pattern>
-        format none
-      </pattern>
-    </match>
+      <parse>
+        @type multi_format
+        <pattern>
+          format apache
+        </pattern>
+        <pattern>
+          format json
+          time_key timestamp
+        </pattern>
+        <pattern>
+          format none
+        </pattern>
+      </parse>
+    </source>
 
 `multi_format` tries pattern matching from top to bottom and returns parsed result when matched.
 
 Available format patterns and parameters are depends on Fluentd parsers.
-See [in_tail format document](http://docs.fluentd.org/articles/in_tail) for more details.
+See [parser plugin document](http://docs.fluentd.org/v1.0/articles/parser-plugin-overview) for more details.
 
-### For v0.14
+### For v1.0/v0.14
 
-This plugin handles `pattern` section manually, so v0.14's automatic parameter conversion doesn't work well.
-If you want to use this plugin with v0.14, you need to use v0.14 parser syntax like below
+Put `<pattern>`s inside `<parse>`.
 
     <filter app.**>
       @type parser
       key_name message
-      <parse> # Use <parse> section for parser parameters
+      <parse>
         @type multi_format
         <pattern>
           format json
         </pattern>
+        <pattern>
+          format regexp
+          expression /...your regexp pattern.../
+        </pattern>
         <pattern>
           format none
         </pattern>
       </parse>
     </filter>
 
+### For v0.12
+
+Use `format` instead of `<parse></parse>`.
+
+    <filter app.**>
+      @type parser
+      key_name message
+
+      format multi_format
+      <pattern>
+        format json
+      </pattern>
+      <pattern>
+        format /...your regexp pattern.../
+      </pattern>
+      <pattern>
+        format none
+      </pattern>
+    </filter>
+
 ### NOTE
 
 This plugin doesn't work with `multiline` parsers because parser itself doesn't store previous lines.

data/VERSION

@@ -1 +1 @@
-0.1.1
+1.0.0

data/fluent-plugin-multi-format-parser.gemspec

@@ -17,6 +17,6 @@ Gem::Specification.new do |gem|
   gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.require_paths = ['lib']
 
-  gem.add_dependency "fluentd", [">= 0.10.46", "< 2"]
+  gem.add_dependency "fluentd", [">= 0.14.0", "< 2"]
   gem.add_development_dependency "rake", ">= 0.9.2"
 end

data/lib/fluent/plugin/parser_multi_format.rb

@@ -1,98 +1,44 @@
-require 'fluent/parser'
+require 'fluent/plugin/parser'
 
 module Fluent
-  class TextParser
-    if defined?(::Fluent::Parser)
-      class MultiFormatParser < Parser
-        Plugin.register_parser('multi_format', self)
+  module Plugin
+    class MultiFormatParser < Parser
+      Plugin.register_parser('multi_format', self)
 
-        def initialize
-          super
+      def initialize
+        super
 
-          @parsers = []
-        end
-
-        def configure(conf)
-          super
-
-          conf.elements.each { |e|
-            next unless ['pattern', 'format'].include?(e.name)
-            next if e['format'].nil? && (e['@type'] == 'multi_format')
-
-            parser = Plugin.new_parser(e['format'])
-            parser.configure(e)
-            @parsers << parser
-          }
-        end
-
-        def parse(text)
-          @parsers.each { |parser|
-            begin
-              parser.parse(text) { |time, record|
-                if time && record
-                  yield time, record
-                  return
-                end
-              }
-            rescue # ignore parser error
-            end
-          }
-
-          yield nil, nil
-        end
+        @parsers = []
       end
-    else # support old API. Will be removed.
-      class MultiFormatParser
-        include Configurable
 
-        def initialize
-          super
+      def configure(conf)
+        super
 
-          @parsers = []
-        end
+        conf.elements.each { |e|
+          next unless ['pattern', 'format'].include?(e.name)
+          next if e['format'].nil? && (e['@type'] == 'multi_format')
 
-        def configure(conf)
-          super
-
-          conf.elements.each { |e|
-            next unless ['pattern', 'format'].include?(e.name)
-
-            parser = TextParser.new
-            parser.configure(e)
-            @parsers << parser.parser
-          }
-        end
-
-        def parse(text)
-          @parsers.each { |parser|
-            begin
-              parser.call(text) { |time, record|
-                if time && record
-                  if block_given?
-                    yield time, record
-                    return
-                  else
-                    return time, record
-                  end
-                end
-              }
-            rescue # ignore parser error
-            end
-          }
+          parser = Plugin.new_parser(e['format'])
+          parser.configure(e)
+          @parsers << parser
+        }
+      end
 
-          if block_given?
-            yield nil, nil
-          else
-            return nil, nil
+      def parse(text)
+        @parsers.each { |parser|
+          begin
+            parser.parse(text) { |time, record|
+              if time && record
+                yield time, record
+                return
+              end
+            }
+          rescue # ignore parser error
           end
-        end
+        }
 
-        def call(*a, &b)
-          parse(*a, &b)
-        end
+        yield nil, nil
       end
-
-      register_template('multi_format', Proc.new { MultiFormatParser.new })
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-multi-format-parser
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Masahiro Nakagawa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-10 00:00:00.000000000 Z
+date: 2017-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.46
+        version: 0.14.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.10.46
+        version: 0.14.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
@@ -77,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Multi format parser plugin for Fluentd