fluent-plugin-detect-exceptions 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f846941463ccc37acd71280e182d5ae7b0ffd0c95c609bfbfe67de64f86ff478
-  data.tar.gz: 1454c4ddae5ba4efa214972f2109f0a71d4984e87b49cefa3541cb87d92d6cc7
+  metadata.gz: c1ac7bd2ba9a6630a4d3362da4892df13fb6e65f595e23e871fb76dbfffb444a
+  data.tar.gz: a339c63ea937fbf91770a77b86cf91f3cba806e8bbb0b2f2531e9a2f26485630
 SHA512:
-  metadata.gz: 585f0de72a4f845f39c0f7e753ca3661ad335b10c18d26930afc19bab246b205cb9d68d1fa506c87e5ea674fc9b1ce51b04c278aed5590d997875ea9b50b21d8
-  data.tar.gz: 987c453e5667c1736507500859a1f46612a56451f791afaf194574380afd31527da73f9ebd87de53faf2c40e5929ce0cdd0f2c3fbd0c9d4c89a2137bad40a9a1
+  metadata.gz: 4c9608e5ab97d683e9c0ea187afce6c9495196fb84a13aa05eeb1cefb74ce62ec50aa6c1bb7879be1516ce633368cfc9e8fcbcd2776b7d8b360472c1a884adf2
+  data.tar.gz: 0abf0b0c543582b141da5c24ac8c1a10e6c2db4b4b4dd0925499bb5158713883398180dfda2cd3cba26abe40d9e60008b5eed546022b66a925dde2a50f6efa96

data/Gemfile.lock

@@ -0,0 +1,74 @@
+PATH
+  remote: .
+  specs:
+    fluent-plugin-detect-exceptions (0.0.15)
+      fluentd (>= 0.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    cool.io (1.5.4)
+    dig_rb (1.0.1)
+    flexmock (2.3.6)
+    fluentd (1.6.3)
+      cool.io (>= 1.4.5, < 2.0.0)
+      dig_rb (~> 1.0.0)
+      http_parser.rb (>= 0.5.1, < 0.7.0)
+      msgpack (>= 0.7.0, < 2.0.0)
+      serverengine (>= 2.0.4, < 3.0.0)
+      sigdump (~> 0.2.2)
+      strptime (>= 0.2.2, < 1.0.0)
+      tzinfo (~> 1.0)
+      tzinfo-data (~> 1.0)
+      yajl-ruby (~> 1.0)
+    http_parser.rb (0.6.0)
+    json (2.6.3)
+    msgpack (1.3.1)
+    parallel (1.22.1)
+    parser (3.2.1.1)
+      ast (~> 2.4.1)
+    power_assert (1.1.4)
+    rainbow (3.1.1)
+    rake (10.5.0)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rubocop (1.48.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    serverengine (2.1.1)
+      sigdump (~> 0.2.2)
+    sigdump (0.2.4)
+    strptime (0.2.3)
+    test-unit (3.3.3)
+      power_assert
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    tzinfo-data (1.2019.2)
+      tzinfo (>= 1.0.0)
+    unicode-display_width (2.4.2)
+    yajl-ruby (1.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  flexmock (~> 2.0)
+  fluent-plugin-detect-exceptions!
+  rake (~> 10.3)
+  rubocop (= 1.48.1)
+  test-unit (~> 3.0)
+
+BUNDLED WITH
+   2.4.1

data/Rakefile

@@ -36,6 +36,7 @@ task :fix_perms do
   files.each do |file|
     mode = File.stat(file).mode & 0o777
     next unless mode & 0o444 != 0o444
+
     puts "Changing mode of #{file} from #{mode.to_s(8)} to "\
          "#{(mode | 0o444).to_s(8)}"
     chmod mode | 0o444, file
@@ -43,6 +44,6 @@ task :fix_perms do
 end
 
 desc 'Run unit tests and RuboCop to check for style violations'
-task all: [:test, :rubocop, :fix_perms]
+task all: %i[rubocop test fix_perms]
 
 task default: :all

data/fluent-plugin-detect-exceptions.gemspec

@@ -1,20 +1,20 @@
 Gem::Specification.new do |gem|
   gem.name          = 'fluent-plugin-detect-exceptions'
-  gem.description   = <<-eos
+  gem.description   = <<-DESCRIPTION
    Fluentd output plugin which detects exception stack traces in a stream of
    JSON log messages and combines all single-line messages that belong to the
    same stack trace into one multi-line message.
    This is an official Google Ruby gem.
-eos
+  DESCRIPTION
   gem.summary       = \
     'fluentd output plugin for combining stack traces as multi-line JSON logs'
   gem.homepage      = \
     'https://github.com/GoogleCloudPlatform/fluent-plugin-detect-exceptions'
   gem.license       = 'Apache-2.0'
-  gem.version       = '0.0.14'
+  gem.version       = '0.0.15'
   gem.authors       = ['Stackdriver Agents']
   gem.email         = ['stackdriver-agents@google.com']
-  gem.required_ruby_version = Gem::Requirement.new('>= 2.0')
+  gem.required_ruby_version = Gem::Requirement.new('>= 2.6')
 
   gem.files         = Dir['**/*'].keep_if { |file| File.file?(file) }
   gem.test_files    = gem.files.grep(/^(test)/)
@@ -22,8 +22,8 @@ eos
 
   gem.add_runtime_dependency 'fluentd', '>= 0.10'
 
+  gem.add_development_dependency 'flexmock', '~> 2.0'
   gem.add_development_dependency 'rake', '~> 10.3'
-  gem.add_development_dependency 'rubocop', '= 0.42.0'
+  gem.add_development_dependency 'rubocop', '= 1.48.1'
   gem.add_development_dependency 'test-unit', '~> 3.0'
-  gem.add_development_dependency 'flexmock', '~> 2.0'
 end

data/lib/fluent/plugin/exception_detector.rb

@@ -21,9 +21,9 @@ module Fluent
     class RuleTarget
       attr_accessor :pattern, :to_state
 
-      def initialize(p, s)
-        @pattern = p
-        @to_state = s
+      def initialize(pattern, state)
+        @pattern = pattern
+        @to_state = state
       end
 
       def ==(other)
@@ -52,28 +52,28 @@ module Fluent
     end
 
     JAVA_RULES = [
-      rule([:start_state, :java_start_exception],
+      rule(%i[start_state java_start_exception],
            /(?:Exception|Error|Throwable|V8 errors stack trace)[:\r\n]/,
            :java_after_exception),
       rule(:java_after_exception, /^[\t ]*nested exception is:[\t ]*/,
            :java_start_exception),
       rule(:java_after_exception, /^[\r\n]*$/, :java_after_exception),
-      rule([:java_after_exception, :java], /^[\t ]+(?:eval )?at /, :java),
+      rule(%i[java_after_exception java], /^[\t ]+(?:eval )?at /, :java),
 
-      rule([:java_after_exception, :java],
+      rule(%i[java_after_exception java],
            # C# nested exception.
            /^[\t ]+--- End of inner exception stack trace ---$/,
            :java),
 
-      rule([:java_after_exception, :java],
+      rule(%i[java_after_exception java],
            # C# exception from async code.
            /^--- End of stack trace from previous (?x:
            )location where exception was thrown ---$/,
            :java),
 
-      rule([:java_after_exception, :java], /^[\t ]*(?:Caused by|Suppressed):/,
+      rule(%i[java_after_exception java], /^[\t ]*(?:Caused by|Suppressed):/,
            :java_after_exception),
-      rule([:java_after_exception, :java],
+      rule(%i[java_after_exception java],
            /^[\t ]*... \d+ (?:more|common frames omitted)/, :java)
     ].freeze
 
@@ -97,13 +97,13 @@ module Fluent
       rule(:start_state, /\bpanic: /, :go_after_panic),
       rule(:start_state, /http: panic serving/, :go_goroutine),
       rule(:go_after_panic, /^$/, :go_goroutine),
-      rule([:go_after_panic, :go_after_signal, :go_frame_1],
+      rule(%i[go_after_panic go_after_signal go_frame_line1],
            /^$/, :go_goroutine),
       rule(:go_after_panic, /^\[signal /, :go_after_signal),
-      rule(:go_goroutine, /^goroutine \d+ \[[^\]]+\]:$/, :go_frame_1),
-      rule(:go_frame_1, /^(?:[^\s.:]+\.)*[^\s.():]+\(|^created by /,
-           :go_frame_2),
-      rule(:go_frame_2, /^\s/, :go_frame_1)
+      rule(:go_goroutine, /^goroutine \d+ \[[^\]]+\]:$/, :go_frame_line1),
+      rule(:go_frame_line1, /^(?:[^\s.:]+\.)*[^\s.():]+\(|^created by /,
+           :go_frame_line2),
+      rule(:go_frame_line2, /^\s/, :go_frame_line1)
     ].freeze
 
     RUBY_RULES = [
@@ -129,22 +129,22 @@ module Fluent
       rule(:dart_exc, /^Concurrent modification/, :dart_stack),
       rule(:dart_exc, /^Out of Memory/, :dart_stack),
       rule(:dart_exc, /^Stack Overflow/, :dart_stack),
-      rule(:dart_exc, /^'.+?':.+?$/, :dart_type_err_1),
-      rule(:dart_type_err_1, /^#\d+\s+.+?\(.+?\)$/, :dart_stack),
-      rule(:dart_type_err_1, /^.+?$/, :dart_type_err_2),
-      rule(:dart_type_err_2, /^.*?\^.*?$/, :dart_type_err_3),
-      rule(:dart_type_err_3, /^$/, :dart_type_err_4),
-      rule(:dart_type_err_4, /^$/, :dart_stack),
-      rule(:dart_exc, /^FormatException/, :dart_format_err_1),
-      rule(:dart_format_err_1, /^#\d+\s+.+?\(.+?\)$/, :dart_stack),
-      rule(:dart_format_err_1, /^./, :dart_format_err_2),
-      rule(:dart_format_err_2, /^.*?\^/, :dart_format_err_3),
-      rule(:dart_format_err_3, /^$/, :dart_stack),
-      rule(:dart_exc, /^NoSuchMethodError:/, :dart_method_err_1),
-      rule(:dart_method_err_1, /^Receiver:/, :dart_method_err_2),
-      rule(:dart_method_err_2, /^Tried calling:/, :dart_method_err_3),
-      rule(:dart_method_err_3, /^Found:/, :dart_stack),
-      rule(:dart_method_err_3, /^#\d+\s+.+?\(.+?\)$/, :dart_stack),
+      rule(:dart_exc, /^'.+?':.+?$/, :dart_type_err_line1),
+      rule(:dart_type_err_line1, /^#\d+\s+.+?\(.+?\)$/, :dart_stack),
+      rule(:dart_type_err_line1, /^.+?$/, :dart_type_err_line2),
+      rule(:dart_type_err_line2, /^.*?\^.*?$/, :dart_type_err_line3),
+      rule(:dart_type_err_line3, /^$/, :dart_type_err_line4),
+      rule(:dart_type_err_line4, /^$/, :dart_stack),
+      rule(:dart_exc, /^FormatException/, :dart_format_err_line1),
+      rule(:dart_format_err_line1, /^#\d+\s+.+?\(.+?\)$/, :dart_stack),
+      rule(:dart_format_err_line1, /^./, :dart_format_err_line2),
+      rule(:dart_format_err_line2, /^.*?\^/, :dart_format_err_line3),
+      rule(:dart_format_err_line3, /^$/, :dart_stack),
+      rule(:dart_exc, /^NoSuchMethodError:/, :dart_method_err_line1),
+      rule(:dart_method_err_line1, /^Receiver:/, :dart_method_err_line2),
+      rule(:dart_method_err_line2, /^Tried calling:/, :dart_method_err_line3),
+      rule(:dart_method_err_line3, /^Found:/, :dart_stack),
+      rule(:dart_method_err_line3, /^#\d+\s+.+?\(.+?\)$/, :dart_stack),
       rule(:dart_stack, /^#\d+\s+.+?\(.+?\)$/, :dart_stack),
       rule(:dart_stack, /^<asynchronous suspension>$/, :dart_stack)
     ].freeze
@@ -168,7 +168,7 @@ module Fluent
       all: ALL_RULES
     }.freeze
 
-    DEFAULT_FIELDS = %w(message log).freeze
+    DEFAULT_FIELDS = %w[message log].freeze
   end
 
   # State machine that consumes individual log lines and detects
@@ -236,6 +236,7 @@ module Fluent
     def transition(line)
       @rules[@state].each do |r|
         next unless line =~ r.pattern
+
         @state = r.to_state
         return true
       end
@@ -280,14 +281,14 @@ module Fluent
         @exception_detector.reset
         detection_status = :no_trace
       else
-        force_flush if @max_bytes > 0 &&
+        force_flush if @max_bytes.positive? &&
                        @buffer_size + message.length > @max_bytes
         detection_status = @exception_detector.update(message)
       end
 
       update_buffer(detection_status, time_sec, record, message)
 
-      force_flush if @max_lines > 0 && @messages.length == @max_lines
+      force_flush if @max_lines.positive? && @messages.length == @max_lines
     end
 
     def flush
@@ -332,8 +333,7 @@ module Fluent
     end
 
     def update_buffer(detection_status, time_sec, record, message)
-      trigger_emit = detection_status == :no_trace ||
-                     detection_status == :end_trace
+      trigger_emit = %i[no_trace end_trace].include?(detection_status)
       if @messages.empty? && trigger_emit
         @emit.call(time_sec, record)
         return
@@ -361,16 +361,16 @@ module Fluent
         @first_timestamp = time_sec
         @buffer_start_time = Time.now
       end
-      unless message.nil?
-        message_with_line_break =
-          if @force_line_breaks && !@messages.empty? && !message.include?("\n")
-            "\n" + message
-          else
-            message
-          end
-        @messages << message_with_line_break
-        @buffer_size += message_with_line_break.length
-      end
+      return if message.nil?
+
+      message_with_line_break =
+        if @force_line_breaks && !@messages.empty? && !message.include?("\n")
+          "\n#{message}"
+        else
+          message
+        end
+      @messages << message_with_line_break
+      @buffer_size += message_with_line_break.length
     end
   end
 end

data/lib/fluent/plugin/out_detect_exceptions.rb

@@ -44,9 +44,7 @@ module Fluent
     def configure(conf)
       super
 
-      if multiline_flush_interval
-        @check_flush_interval = [multiline_flush_interval * 0.1, 1].max
-      end
+      @check_flush_interval = [multiline_flush_interval * 0.1, 1].max if multiline_flush_interval
 
       @languages = languages.map(&:to_sym)
 
@@ -57,11 +55,11 @@ module Fluent
     def start
       super
 
-      if multiline_flush_interval
-        @flush_buffer_mutex = Mutex.new
-        @stop_check = false
-        @thread = Thread.new(&method(:check_flush_loop))
-      end
+      return unless multiline_flush_interval
+
+      @flush_buffer_mutex = Mutex.new
+      @stop_check = false
+      @thread = Thread.new(&method(:check_flush_loop))
     end
 
     def before_shutdown
@@ -77,8 +75,8 @@ module Fluent
       super
     end
 
-    def emit(tag, es, chain)
-      es.each do |time_sec, record|
+    def emit(tag, entries, chain)
+      entries.each do |time_sec, record|
         process_record(tag, time_sec, record)
       end
       chain.next
@@ -121,13 +119,14 @@ module Fluent
           @flush_buffer_mutex.sleep(@check_flush_interval)
           now = Time.now
           break if @stop_check
+
           @accumulators.each_value do |acc|
             acc.force_flush if now - acc.buffer_start_time >
                                @multiline_flush_interval
           end
         end
       end
-    rescue
+    rescue StandardError
       log.error 'error in check_flush_loop', error: $ERROR_INFO.to_s
       log.error_backtrace
     end

data/test/helper.rb

@@ -14,29 +14,29 @@
 
 require 'rubygems'
 require 'bundler'
-
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
+  # rubocop:disable Style/StderrPuts
   $stderr.puts e.message
   $stderr.puts 'Run `bundle install` to install missing gems'
+  # rubocop:enable Style/StderrPuts
   exit e.status_code
 end
-
 require 'test/unit'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'fluent/test'
-
 unless ENV.key?('VERBOSE')
   nulllogger = Object.new
   nulllogger.instance_eval do |_|
-    def respond_to_missing?
+    def respond_to_missing?(_method, _include_private = false)
       true
     end
 
-    def method_missing(_method, *_args) # rubocop:disable Style/MethodMissing
+    def method_missing(_method, *_args)
+      # pass
     end
   end
   # global $log variable is used by fluentd

data/test/plugin/bench_exception_detector.rb

@@ -21,25 +21,25 @@ line_length = 50
 
 size = size_in_m << 20
 
-JAVA_EXC = <<END.freeze
-Jul 09, 2015 3:23:29 PM com.google.devtools.search.cloud.feeder.MakeLog: RuntimeException: Run from this message!
-  at com.my.app.Object.do$a1(MakeLog.java:50)
-  at java.lang.Thing.call(Thing.java:10)
-  at com.my.app.Object.help(MakeLog.java:40)
-  at sun.javax.API.method(API.java:100)
-  at com.jetty.Framework.main(MakeLog.java:30)
-END
+JAVA_EXC = <<~END_JAVA.freeze
+  Jul 09, 2015 3:23:29 PM com.google.devtools.search.cloud.feeder.MakeLog: RuntimeException: Run from this message!
+    at com.my.app.Object.do$a1(MakeLog.java:50)
+    at java.lang.Thing.call(Thing.java:10)
+    at com.my.app.Object.help(MakeLog.java:40)
+    at sun.javax.API.method(API.java:100)
+    at com.jetty.Framework.main(MakeLog.java:30)
+END_JAVA
 
-PYTHON_EXC = <<END.freeze
-Traceback (most recent call last):
-  File "/base/data/home/runtimes/python27/python27_lib/versions/third_party/webapp2-2.5.2/webapp2.py", line 1535, in __call__
-    rv = self.handle_exception(request, response, e)
-  File "/base/data/home/apps/s~nearfieldspy/1.378705245900539993/nearfieldspy.py", line 17, in start
-    return get()
-  File "/base/data/home/apps/s~nearfieldspy/1.378705245900539993/nearfieldspy.py", line 5, in get
-    raise Exception('spam', 'eggs')
-Exception: ('spam', 'eggs')
-END
+PYTHON_EXC = <<~END_PYTHON.freeze
+  Traceback (most recent call last):
+    File "/base/data/home/runtimes/python27/python27_lib/versions/third_party/webapp2-2.5.2/webapp2.py", line 1535, in __call__
+      rv = self.handle_exception(request, response, e)
+    File "/base/data/home/apps/s~nearfieldspy/1.378705245900539993/nearfieldspy.py", line 17, in start
+      return get()
+    File "/base/data/home/apps/s~nearfieldspy/1.378705245900539993/nearfieldspy.py", line 5, in get
+      raise Exception('spam', 'eggs')
+  Exception: ('spam', 'eggs')
+END_PYTHON
 
 chars = [('a'..'z'), ('A'..'Z')].map(&:to_a).flatten
 
@@ -61,7 +61,7 @@ Benchmark.bm do |x|
       random_text.each { |l| buffer.push(0, l) }
     end
   end
-  [:java, :python, :all].each do |detector_lang|
+  %i[java python all].each do |detector_lang|
     buffer = Fluent::TraceAccumulator.new(nil, detector_lang) {}
     exc_languages = detector_lang == :all ? exceptions.keys : [detector_lang]
     exc_languages.each do |exc_lang|