fluent-plugin-parser-protobuf 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '02618818d401d30bc764e685463dba4ecbd1c81e06c385353116c87c0784009c'
-  data.tar.gz: 2022746e1ee17174e20a105d58c4464be603c50d4a9a80f4cceadc4cb0fed5a3
+  metadata.gz: 63a87edc22262b37fa780ce69865de8a2be6bfb692c557f0e48926c866febb92
+  data.tar.gz: 458cd65c672a962359e809eaee8d0de290fcebc875d23e3a54140713139f7d58
 SHA512:
-  metadata.gz: e65e1baf904aea0f8f6df43319d27f653d0087f49a96102ed2a840bff80f102f2d10c1e855787d3ce14f1cf872ec572c918205a140d66f042976e741bff2a33e
-  data.tar.gz: be9cb26df285b531085ae5fa96fa2ec43694e0ef9c293a49d6d326f723dd850b4b9504079d0b7e7e0d51bf28cf9c2e5fdc037f3583804a1187d930564d24a67f
+  metadata.gz: 8f84f1c6e697e1a44fcdb2b30add9196c2d34004062393a1552354021a4e7d743d3b63c748f03d4c0179bcf11abef20333a486f88b553b58cc7ae99979c1e695
+  data.tar.gz: a57e068998c92a8fc43052a8161e0793a28f03182371b6805cc8e134c9922bba7564b22d8b35196627dd92eaf04e6c2f11376d7401303932111e4ab8a58a1683

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-## Changelog [[tags]](https://github.com/cosmo0920/fluent-plugin-parser-protobuf/tags)
+## Changelog [[tags]](https://github.com/fluent-plugins-nursery/fluent-plugin-parser-protobuf/tags)
+
+### v0.1.2
+- Add invalid parameters combination checker
+- Follow Fluentd v1 parser requirements
+- Introduce suppressing to decode error parameter
 
 ### v0.1.1
 - Fix invalid ConfigError usages

data/README.md

@@ -1,8 +1,8 @@
 # fluent-plugin-parser-protobuf
 
-![Testing on Windows](https://github.com/cosmo0920/fluent-plugin-parser-protobuf/workflows/Testing%20on%20Windows/badge.svg?branch=master)
-![Testing on macOS](https://github.com/cosmo0920/fluent-plugin-parser-protobuf/workflows/Testing%20on%20macOS/badge.svg?branch=master)
-![Testing on Ubuntu](https://github.com/cosmo0920/fluent-plugin-parser-protobuf/workflows/Testing%20on%20Ubuntu/badge.svg?branch=master)
+![Testing on Windows](https://github.com/fluent-plugins-nursery/fluent-plugin-parser-protobuf/workflows/Testing%20on%20Windows/badge.svg?branch=master)
+![Testing on macOS](https://github.com/fluent-plugins-nursery/fluent-plugin-parser-protobuf/workflows/Testing%20on%20macOS/badge.svg?branch=master)
+![Testing on Ubuntu](https://github.com/fluent-plugins-nursery/fluent-plugin-parser-protobuf/workflows/Testing%20on%20Ubuntu/badge.svg?branch=master)
 
 Fluentd parser plugin for [Protocol Buffers](https://developers.google.com/protocol-buffers/docs/overview).
 
@@ -41,6 +41,7 @@ Users should prepare protocol buffers with the following compilers:
   class_file /path/to/your/protobuf/class_file_pb.rb
   class_name Your.Protobuf.Class.Name # For protobuf3
   protobuf_version protobuf3
+  # suppress_decoding_error false
   # include_paths [/path/to/your/protobuf/class_file_pb.rb, /path/to/your/protobuf/class_file2_pb.rb, ...]
 </parse>
 ```
@@ -60,6 +61,7 @@ class_name Your.Protobuf.Class.Name
   class_file /path/to/your/protobuf/class_file.pb.rb
   class_name Your::Protobuf::Class::Name # For protobuf2
   protobuf_version protobuf2
+  # suppress_decoding_error false
   # include_paths [/path/to/your/protobuf/class_file.pb.rb, /path/to/your/protobuf/class_file2.pb.rb, ...]
 </parse>
 ```
@@ -72,7 +74,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/cosmo0920/fluent-plugin-parser-protobuf.
+Bug reports and pull requests are welcome on GitHub at https://github.com/fluent-plugins-nursery/fluent-plugin-parser-protobuf.
 
 ## LICENSE
 

data/fluent-plugin-parser-protobuf.gemspec

@@ -1,19 +1,19 @@
 Gem::Specification.new do |spec|
   spec.name          = "fluent-plugin-parser-protobuf"
-  spec.version       = "0.1.1"
+  spec.version       = "0.1.2"
   spec.authors       = ["Hiroshi Hatake"]
   spec.email         = ["cosmo0920.wp@gmail.com"]
 
   spec.summary       = %q{Protobuf parser for Fluentd.}
   spec.description   = %q{Protobuf parser for Fluentd.}
-  spec.homepage      = "https://github.com/cosmo0920/fluent-plugin-parser-protobuf"
+  spec.homepage      = "https://github.com/fluent-plugins-nursery/fluent-plugin-parser-protobuf"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/cosmo0920/fluent-plugin-parser-protobuf"
-  spec.metadata["changelog_uri"] = "https://github.com/cosmo0920/fluent-plugin-parser-protobuf/blob/master/CHANGELOG.md"
+  spec.metadata["source_code_uri"] = "https://github.com/fluent-plugins-nursery/fluent-plugin-parser-protobuf"
+  spec.metadata["changelog_uri"] = "https://github.com/fluent-plugins-nursery/fluent-plugin-parser-protobuf/blob/master/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -23,9 +23,9 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.add_development_dependency 'test-unit', '~> 3.3.0'
   spec.license = "Apache-2.0"
 
+  spec.add_development_dependency 'test-unit', '~> 3.3.0'
   spec.add_runtime_dependency "fluentd", [">= 1.0", "< 2"]
   spec.add_runtime_dependency "google-protobuf", ["~> 3.12"]
   spec.add_runtime_dependency "ruby-protocol-buffers"

data/lib/fluent/plugin/parser_protobuf.rb

@@ -11,15 +11,23 @@ module Fluent
     class ProtobufParser < Parser
       Plugin.register_parser('protobuf', self)
 
-      class Error < StandardError; end
-
       config_param :include_paths, :array, default: []
       config_param :class_file, :string, default: nil
       config_param :protobuf_version, :enum, list: [:protobuf2, :protobuf3], default: :protobuf3
       config_param :class_name, :string
+      config_param :suppress_decoding_error, :bool, default: false
 
       def configure(conf)
         super
+
+        if !@include_paths.empty? && !@class_file.nil?
+          raise Fluent::ConfigError, "Cannot use `include_paths` and `class_file` at the same time."
+        end
+
+        if @include_paths.empty? && @class_file.nil?
+          raise Fluent::ConfigError, "Need to specify `include_paths` or `class_file`."
+        end
+
         loading_required = Google::Protobuf::DescriptorPool.generated_pool.lookup(class_name).nil?
 
         load_protobuf_class(@class_file) if loading_required && @class_file
@@ -27,25 +35,39 @@ module Fluent
         include_paths.each {|path| load_protobuf_definition(path)} if !include_paths.empty? && loading_required
 
         if @protobuf_version == :protobuf2
-          @protobuf_descriptor = create_prptobuf2_instance(@class_name)
+          @protobuf_descriptor = create_protobuf2_instance(@class_name)
         elsif @protobuf_version == :protobuf3
           @protobuf_descriptor = Google::Protobuf::DescriptorPool.generated_pool.lookup(@class_name).msgclass
         end
       end
 
+      def parser_type
+        :binary
+      end
+
       def parse(binary)
-        if @protobuf_version == :protobuf3
-          decoded = @protobuf_descriptor.decode(binary.to_s)
-          time = @estimate_current_event ? Fluent::EventTime.now : nil
-          yield time, decoded.to_h
-        elsif @protobuf_version == :protobuf2
-          decoded = @protobuf_descriptor.parse(binary.to_s)
-          time = @estimate_current_event ? Fluent::EventTime.now : nil
-          yield time, decoded.to_hash
+        begin
+          if @protobuf_version == :protobuf3
+            decoded = @protobuf_descriptor.decode(binary.to_s)
+            time = @estimate_current_event ? Fluent::EventTime.now : nil
+            yield time, decoded.to_h
+          elsif @protobuf_version == :protobuf2
+            decoded = @protobuf_descriptor.parse(binary.to_s)
+            time = @estimate_current_event ? Fluent::EventTime.now : nil
+            yield time, decoded.to_hash
+          end
+        rescue => e
+          log.warn("Couldn't decode protobuf: #{e.inspect}, message: #{binary}")
+          if @suppress_decoding_error
+            yield nil, nil
+          else
+            raise e
+          end
         end
       end
+      alias parse_partial_data parse
 
-      def create_prptobuf2_instance(class_name)
+      def create_protobuf2_instance(class_name)
         unless Object.const_defined?(class_name)
           raise Fluent::ConfigError, "Cannot find class #{class_name}."
         else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-parser-protobuf
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Hiroshi Hatake
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-01 00:00:00.000000000 Z
+date: 2020-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-unit
@@ -92,14 +92,14 @@ files:
 - bin/setup
 - fluent-plugin-parser-protobuf.gemspec
 - lib/fluent/plugin/parser_protobuf.rb
-homepage: https://github.com/cosmo0920/fluent-plugin-parser-protobuf
+homepage: https://github.com/fluent-plugins-nursery/fluent-plugin-parser-protobuf
 licenses:
 - Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://github.com/cosmo0920/fluent-plugin-parser-protobuf
-  source_code_uri: https://github.com/cosmo0920/fluent-plugin-parser-protobuf
-  changelog_uri: https://github.com/cosmo0920/fluent-plugin-parser-protobuf/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/fluent-plugins-nursery/fluent-plugin-parser-protobuf
+  source_code_uri: https://github.com/fluent-plugins-nursery/fluent-plugin-parser-protobuf
+  changelog_uri: https://github.com/fluent-plugins-nursery/fluent-plugin-parser-protobuf/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: