fluent-plugin-detect-exceptions 0.0.13 → 0.0.15

data/test/plugin/test_out_detect_exceptions.rb

@@ -22,45 +22,47 @@ class DetectExceptionsOutputTest < Test::Unit::TestCase
     Fluent::Test.setup
   end
 
-  CONFIG = <<END.freeze
-remove_tag_prefix prefix
-END
+  CONFIG = <<~END_CONFIG.freeze
+    remove_tag_prefix prefix
+  END_CONFIG
 
   DEFAULT_TAG = 'prefix.test.tag'.freeze
 
+  DEFAULT_TAG_STRIPPED = 'test.tag'.freeze
+
   ARBITRARY_TEXT = 'This line is not an exception.'.freeze
 
-  JAVA_EXC = <<END.freeze
-SomeException: foo
-  at bar
-Caused by: org.AnotherException
-  at bar2
-  at bar3
-END
-
-  PHP_EXC = <<END.freeze
-exception 'Exception' with message 'Custom exception' in /home/joe/work/test-php/test.php:5
-Stack trace:
-#0 /home/joe/work/test-php/test.php(9): func1()
-#1 /home/joe/work/test-php/test.php(13): func2()
-#2 {main}
-END
-
-  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)
-Exception: ('spam', 'eggs')
-END
-
-  RUBY_EXC = <<END.freeze
-examble.rb:18:in `thrower': An error has occurred. (RuntimeError)
-  from examble.rb:14:in `caller'
-  from examble.rb:10:in `helper'
-  from examble.rb:6:in `writer'
-  from examble.rb:2:in `runner'
-  from examble.rb:21:in `<main>'
-END
+  JAVA_EXC = <<~END_JAVA.freeze
+    SomeException: foo
+      at bar
+    Caused by: org.AnotherException
+      at bar2
+      at bar3
+  END_JAVA
+
+  PHP_EXC = <<~END_PHP.freeze
+    exception 'Exception' with message 'Custom exception' in /home/joe/work/test-php/test.php:5
+    Stack trace:
+    #0 /home/joe/work/test-php/test.php(9): func1()
+    #1 /home/joe/work/test-php/test.php(13): func2()
+    #2 {main}
+  END_PHP
+
+  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)
+    Exception: ('spam', 'eggs')
+  END_PYTHON
+
+  RUBY_EXC = <<~END_RUBY.freeze
+    examble.rb:18:in `thrower': An error has occurred. (RuntimeError)
+      from examble.rb:14:in `caller'
+      from examble.rb:10:in `helper'
+      from examble.rb:6:in `writer'
+      from examble.rb:2:in `runner'
+      from examble.rb:21:in `<main>'
+  END_RUBY
 
   def create_driver(conf = CONFIG, tag = DEFAULT_TAG)
     d = Fluent::Test::OutputTestDriver.new(Fluent::DetectExceptionsOutput, tag)
@@ -74,11 +76,22 @@ END
     log_entry
   end
 
-  def feed_lines(driver, t, *messages, stream: nil)
+  def feed_lines_without_line_breaks(driver, timestamp, *messages, stream: nil)
+    count = 0
+    messages.each do |m|
+      m.each_line do |line|
+        line.delete!("\n")
+        driver.emit(log_entry(line, count, stream), timestamp + count)
+        count += 1
+      end
+    end
+  end
+
+  def feed_lines(driver, timestamp, *messages, stream: nil)
     count = 0
     messages.each do |m|
       m.each_line do |line|
-        driver.emit(log_entry(line, count, stream), t + count)
+        driver.emit(log_entry(line, count, stream), timestamp + count)
         count += 1
       end
     end
@@ -91,11 +104,11 @@ END
     end
   end
 
-  def make_logs(t, *messages, stream: nil)
+  def make_logs(timestamp, *messages, stream: nil)
     count = 0
     logs = []
     messages.each do |m|
-      logs << [t + count, log_entry(m, count, stream)]
+      logs << [timestamp + count, log_entry(m, count, stream)]
       count += m.lines.count
     end
     logs
@@ -125,7 +138,9 @@ END
     }
 
     test_cases.each do |language, exception|
-      cfg = "languages #{language}"
+      cfg = %(
+#{CONFIG}
+languages #{language})
       d = create_driver(cfg)
       t = Time.now.to_i
 
@@ -133,7 +148,7 @@ END
       single_line_exception = exception.gsub("\n", '\\n')
 
       # There is a nested exception within the body, we should ignore those!
-      json_line_with_exception = {
+      json_with_exception = {
         'timestamp' => {
           'nanos' => 998_152_494,
           'seconds' => 1_496_420_064
@@ -141,8 +156,9 @@ END
         'message' => single_line_exception,
         'thread' => 139_658_267_147_048,
         'severity' => 'ERROR'
-      }.to_json + "\n"
-      json_line_without_exception = {
+      }
+      json_line_with_exception = "#{json_with_exception.to_json}\n"
+      json_without_exception = {
         'timestamp' => {
           'nanos' => 5_990_266,
           'seconds' => 1_496_420_065
@@ -150,18 +166,19 @@ END
         'message' => 'next line',
         'thread' => 139_658_267_147_048,
         'severity' => 'INFO'
-      }.to_json + "\n"
+      }
+      json_line_without_exception = "#{json_without_exception.to_json}\n"
 
       router_mock = flexmock('router')
 
       # Validate that each line received is emitted separately as expected.
       router_mock.should_receive(:emit)
-                 .once.with(DEFAULT_TAG, Integer,
+                 .once.with(DEFAULT_TAG_STRIPPED, Integer,
                             'message' => json_line_with_exception,
                             'count' => 0)
 
       router_mock.should_receive(:emit)
-                 .once.with(DEFAULT_TAG, Integer,
+                 .once.with(DEFAULT_TAG_STRIPPED, Integer,
                             'message' => json_line_without_exception,
                             'count' => 1)
 
@@ -174,7 +191,9 @@ END
   end
 
   def test_single_language_config
-    cfg = 'languages java'
+    cfg = %(
+#{CONFIG}
+languages java)
     d = create_driver(cfg)
     t = Time.now.to_i
     d.run do
@@ -185,7 +204,9 @@ END
   end
 
   def test_multi_language_config
-    cfg = 'languages python, java'
+    cfg = %(
+#{CONFIG}
+languages python, java)
     d = create_driver(cfg)
     t = Time.now.to_i
     d.run do
@@ -196,7 +217,9 @@ END
   end
 
   def test_split_exception_after_timeout
-    cfg = 'multiline_flush_interval 1'
+    cfg = %(
+#{CONFIG}
+multiline_flush_interval 1)
     d = create_driver(cfg)
     t1 = 0
     t2 = 0
@@ -224,7 +247,13 @@ END
       feed_lines(d, t2, "  at x\n  at y\n")
       d.instance.before_shutdown
     end
-    assert_equal(make_logs(t1, JAVA_EXC + "  at x\n  at y\n"), d.events)
+    assert_equal(make_logs(t1, "#{JAVA_EXC}  at x\n  at y\n"), d.events)
+  end
+
+  def test_remove_tag_prefix_is_required
+    cfg = ''
+    e = assert_raises(Fluent::ConfigError) { create_driver(cfg) }
+    assert_match(/remove_tag_prefix/, e.message)
   end
 
   def get_out_tags(remove_tag_prefix, original_tag)
@@ -243,8 +272,42 @@ END
     assert_equal(['prefix.plus.rest.of.the.tag'], tags)
   end
 
+  def test_force_line_breaks_false
+    cfg = %(
+#{CONFIG}
+force_line_breaks true)
+    d = create_driver(cfg)
+    t = Time.now.to_i
+    d.run do
+      feed_lines(d, t, JAVA_EXC)
+    end
+    expected = JAVA_EXC
+    assert_equal(make_logs(t, *expected), d.events)
+  end
+
+  def test_force_line_breaks_true
+    cfg = %(
+#{CONFIG}
+force_line_breaks true)
+    d = create_driver(cfg)
+    t = Time.now.to_i
+    d.run do
+      feed_lines_without_line_breaks(d, t, JAVA_EXC)
+    end
+    # Expected: the first two lines of the exception are buffered and combined.
+    # Then the max_lines setting kicks in and the rest of the Python exception
+    # is logged line-by-line (since it's not an exception stack in itself).
+    # For the following Java stack trace, the two lines of the first exception
+    # are buffered and combined. So are the first two lines of the second
+    # exception. Then the rest is logged line-by-line.
+    expected = JAVA_EXC.chomp
+    assert_equal(make_logs(t, *expected), d.events)
+  end
+
   def test_flush_after_max_lines
-    cfg = 'max_lines 2'
+    cfg = %(
+#{CONFIG}
+max_lines 2)
     d = create_driver(cfg)
     t = Time.now.to_i
     d.run do
@@ -256,22 +319,24 @@ END
     # For the following Java stack trace, the two lines of the first exception
     # are buffered and combined. So are the first two lines of the second
     # exception. Then the rest is logged line-by-line.
-    expected = [PYTHON_EXC.lines[0..1].join] + PYTHON_EXC.lines[2..-1] + \
+    expected = [PYTHON_EXC.lines[0..1].join] + PYTHON_EXC.lines[2..] + \
                [JAVA_EXC.lines[0..1].join] + [JAVA_EXC.lines[2..3].join] + \
-               JAVA_EXC.lines[4..-1]
+               JAVA_EXC.lines[4..]
     assert_equal(make_logs(t, *expected), d.events)
   end
 
   def test_separate_streams
-    cfg = 'stream stream'
+    cfg = %(
+#{CONFIG}
+stream stream)
     d = create_driver(cfg)
     t = Time.now.to_i
     d.run do
       feed_lines(d, t, JAVA_EXC.lines[0], stream: 'java')
       feed_lines(d, t, PYTHON_EXC.lines[0..1].join, stream: 'python')
-      feed_lines(d, t, JAVA_EXC.lines[1..-1].join, stream: 'java')
+      feed_lines(d, t, JAVA_EXC.lines[1..].join, stream: 'java')
       feed_lines(d, t, JAVA_EXC, stream: 'java')
-      feed_lines(d, t, PYTHON_EXC.lines[2..-1].join, stream: 'python')
+      feed_lines(d, t, PYTHON_EXC.lines[2..].join, stream: 'python')
       feed_lines(d, t, 'something else', stream: 'java')
     end
     # Expected: the Python and the Java exceptions are handled separately

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-detect-exceptions
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.15
 platform: ruby
 authors:
 - Stackdriver Agents
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-04 00:00:00.000000000 Z
+date: 2023-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -25,61 +25,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: flexmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.42.0
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.42.0
+        version: '10.3'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 1.48.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 1.48.1
 - !ruby/object:Gem::Dependency
-  name: flexmock
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 description: |2
      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
@@ -116,14 +116,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: fluentd output plugin for combining stack traces as multi-line JSON logs