logjam_agent 0.37.0 → 0.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0980fb837410c08361600e378f44a6bacf83a36ecd95fa3090348f4dc0ca5d9
-  data.tar.gz: 8f191a84d982672fee5a7b00bfc8faf9d37c98f6573ecd2c72911fc00584986e
+  metadata.gz: ca457f9e8f19c2915d63445f3c7f63bfccb4cc61d260b5e164cd80e5440c5659
+  data.tar.gz: 2b58eeaa872b742b11faac8156354e551cce37c4dd15a33d594e2e05c794bbe9
 SHA512:
-  metadata.gz: 9f7c46d32b4c7dd42279a9e20a4b834baad1082201234fb8ccd26466846d04572139d1542abe5c637bba39cc722177952fa67a639bc05d6f8c379d19867fbece
-  data.tar.gz: 2f56ac4b0f6e6b0a9e7c11e5b7b6314343726f8fa9c164181f2c5dd7b262e207ef5b6739d90f5afb38fb6857c87168a07457c25a371d094d66b86541af961735
+  metadata.gz: 0ca5aead4424e9cb01dfaf099f889a772099f3320173ba6af6d4d8aa80bd2972173cdfba69c8a3555f55caef723799871c916332b9e52b62ea516e941c7e6961
+  data.tar.gz: 855bb281cfadd0485df1a2e2d2a446d502687ce03d35a5ab0fca80ad4d3a520296c1ff4650addc4c2a3149094a1834b897c1f8e2e7bc5efe5bdfb3fd4332b329

data/README.md

@@ -182,6 +182,26 @@ Using one of the logjam helpers `LogjamAgent.logjam_only` or
 `LogjamAgent.logdevice_only` it is possible to send information to
 only one of those log line sinks for the duration of a given block.
 
+## JSON Logging
+
+When `LogjamAgent.log_format` is set to `:json`, the logjam agent
+logger will make sure that the content of line logged to the log
+device is converted to JSON.
+
+```ruby
+Rails.logger.info("foobar is great!")
+# ----->
+{ "message": "foobar is great!"}
+
+Rails.logger.info(message: "foobar", user: 5)
+# ----->
+{ "message": "foobar", "user": 5 }
+
+e = Standard::Error.new()
+Rails.logger.info(e)
+# ----->
+{ "message": "#{e.message}", "error": <execption with formatted backtrace> }
+```
 
 ## Troubleshooting
 

data/lib/logjam_agent/buffered_logger.rb

@@ -47,25 +47,16 @@ module LogjamAgent
       progname = nil
       message ||= block.call || '' if block
       request = LogjamAgent.request
-      if message.is_a?(Exception)
-        request.add_exception(message.class.to_s, severity) if request
-        message = format_exception(message)
-      else
-        message = message.to_s
-        if request && severity >= Logger::ERROR && (e = detect_logged_exception(message))
-          request.add_exception(e)
-        end
-      end
-      log_to_log_device = LogjamAgent.log_to_log_device?(severity, message)
-      log_to_log_device = false if request && request.ignored?
-      attributes = formatter.render_attributes
-      message = "[#{attributes}] #{message}" if attributes
+      logjam_message = format_message_for_logjam(message, request, severity)
       time = Time.now
+      request.add_line(severity, time, logjam_message) if request && !SelectiveLogging.logdevice_only?
+      log_to_log_device = LogjamAgent.log_to_log_device?(severity, logjam_message)
+      log_to_log_device = false if request && request.ignored?
       if log_to_log_device && !SelectiveLogging.logjam_only?
-        formatted_message = formatter.call(format_severity(severity), time, progname, message)
+        device_message = format_message_for_log_device(message)
+        formatted_message = formatter.call(format_severity(severity), time, progname, device_message)
         @logdev.write(formatted_message) if @logdev
       end
-      request.add_line(severity, time, message) if request && !SelectiveLogging.logdevice_only?
       message
     end
 
@@ -93,11 +84,61 @@ module LogjamAgent
     def format_exception(exception)
       msg = "#{exception.class}(#{exception.message})"
       if backtrace = exception.backtrace
-        backtrace = Rails.backtrace_cleaner.clean(backtrace, :all) if defined?(Rails)
+        backtrace = Rails.backtrace_cleaner.clean(backtrace, :all) if defined?(Rails) && Rails.respond_to?(:backtrace_cleaner)
         msg << ":\n  #{backtrace.join("\n  ")}"
       else
         msg
       end
     end
+
+    def format_message_for_log_device(message, format: LogjamAgent.log_format)
+      case message
+      when Exception
+        if format == :json
+          encode_log_message(message: message.message, error: format_exception(message))
+        else
+          prepend_attribute_tags(format_exception(message))
+        end
+      when Hash
+        if format == :json
+          encode_log_message(message)
+        else
+          prepend_attribute_tags(LogjamAgent.json_encode_payload(message))
+        end
+      else
+        if format == :json
+          encode_log_message(message: message.to_s)
+        else
+          prepend_attribute_tags(message)
+        end
+      end
+    end
+
+    def format_message_for_logjam(message, request, severity)
+      case message
+      when Exception
+        request.add_exception(message.class.to_s, severity) if request
+        message = format_exception(message)
+      when Hash
+        message = LogjamAgent.json_encode_payload(message)
+      else
+        if request && severity >= Logger::ERROR && (e = detect_logged_exception(message))
+          request.add_exception(e)
+        end
+      end
+      prepend_attribute_tags(message)
+    end
+
+    def prepend_attribute_tags(message)
+      attributes = formatter.render_attributes
+      message = "[#{attributes}] #{message}" if attributes
+      message
+    end
+
+    def encode_log_message(message_hash)
+      attrs = formatter.non_nil_attributes.to_h
+      msg = attrs.merge(message_hash)
+      LogjamAgent.json_encode_payload(msg)
+    end
   end
 end

data/lib/logjam_agent/logging_attributes.rb

@@ -25,9 +25,13 @@ module LogjamAgent
     end
 
     def render_attributes
-      attrs = attributes.select{|k,v| !k.nil? }
+      attrs = non_nil_attributes
       attrs.empty? ? nil : attrs.map{|k,v| "#{k}=#{v}"}.join(" ")
     end
 
+    def non_nil_attributes
+      attributes.select{|k,v| !k.nil? }
+    end
+
   end
 end

data/lib/logjam_agent/rack/logger.rb

@@ -162,7 +162,11 @@ module LogjamAgent
             logjam_request.log_info[:status] = status
             logjam_request.log_info[:duration] = run_time_ms
             # logjam_request.log_info[:metrics] = TimeBandits.metrics.reject{|k,v| v.zero?}
-            info "Completed #{http_status} #{logjam_request.log_info.to_json}"
+            if LogjamAgent.log_format == :json
+              info message: "Completed #{http_status}", **logjam_request.log_info
+            else
+              info "Completed: #{logjam_request.log_info.to_json}"
+            end
           end
         end
 

data/lib/logjam_agent/version.rb

@@ -1,3 +1,3 @@
 module LogjamAgent
-  VERSION = "0.37.0"
+  VERSION = "0.38.0"
 end

data/lib/logjam_agent.rb

@@ -28,6 +28,9 @@ module LogjamAgent
   mattr_accessor :logger
   self.logger = nil
 
+  mattr_accessor :log_format
+  self.log_format = :text
+
   mattr_accessor :forwarding_error_logger
   self.forwarding_error_logger = nil
 

data/test/json_logging_test.rb

@@ -0,0 +1,104 @@
+require_relative "test_helper.rb"
+
+module LogjamAgent
+  class JsonLoggingTest < MiniTest::Test
+    def setup
+      @request = LogjamAgent.request = Request.new("app", "env", {})
+      @lines = @request.instance_variable_get :@lines
+      @logger = BufferedLogger.new(File::NULL)
+      @device = MockLogDev.new
+      @logger.logdev = @device
+    end
+
+    def teardown
+      LogjamAgent.log_format = :text
+      LogjamAgent.request = nil
+      LogjamAgent.selective_logging_enabled = true
+    end
+
+    def test_can_log_strings_in_json
+      LogjamAgent.log_format = :json
+      @logger.info("a silly string")
+      assert_equal 1, @lines.size
+      assert_equal "a silly string", @lines.first.last
+      assert_equal 1, @device.lines.size
+      assert_match(/"message":"a silly string"}\n/, @device.lines.first)
+    end
+
+    def test_can_log_hashes_in_json
+      LogjamAgent.log_format = :json
+      @logger.info({a: 1})
+      assert_equal 1, @lines.size
+      assert_equal '{"a":1}', @lines.first.last
+      assert_equal 1, @device.lines.size
+      assert_match(/\{"a":1\}\n/, @device.lines.first)
+    end
+
+    def test_can_log_exceptions_in_json
+      LogjamAgent.log_format = :json
+      @logger.error(StandardError.new("look ma, an exeption!"))
+      assert_equal 1, @lines.size
+      assert_equal 'StandardError(look ma, an exeption!)', @lines.first.last
+      assert_equal 1, @device.lines.size
+      assert_match(/ERROR -- : \{"message":"look ma, an exeption!","error":"StandardError\(look ma, an exeption!\)"\}\n/, @device.lines.first)
+    end
+
+    def test_can_log_exceptions_with_backtrace_as_json
+      LogjamAgent.log_format = :json
+      e = raise "murks" rescue $!
+      @logger.error(e)
+      assert_equal 1, @lines.size
+      assert_match(/RuntimeError\(murks\):(\n.*\.rb:\d+:in\s.*)+/, @lines.first.last)
+      assert_equal 1, @device.lines.size
+      assert_match(/ERROR -- : {"message":"murks","error":"RuntimeError\(murks\):(\\n.*\.rb:\d+:in\s.*)+"}\n/, @device.lines.first)
+    end
+
+    def test_log_syntax_in_json
+      LogjamAgent.log_format = :json
+      h = {a: 1}
+      @logger.info(message: "foo", **h)
+      assert_equal 1, @lines.size
+      assert_equal '{"message":"foo","a":1}', @lines.first.last
+      assert_equal 1, @device.lines.size
+      assert_match(/\{"message":"foo","a":1\}\n/, @device.lines.first)
+    end
+
+    def test_can_log_strings_as_text
+      LogjamAgent.log_format = :text
+      @logger.info("a silly string")
+      assert_equal 1, @lines.size
+      assert_equal "a silly string", @lines.first.last
+      assert_equal 1, @device.lines.size
+      assert_match(/INFO  -- : a silly string\n/, @device.lines.first)
+    end
+
+    def test_can_log_hashes_as_text
+      LogjamAgent.log_format = :text
+      @logger.info({a: 1})
+      assert_equal 1, @lines.size
+      assert_equal '{"a":1}', @lines.first.last
+      assert_equal 1, @device.lines.size
+      assert_match(/\{"a":1\}\n/, @device.lines.first)
+    end
+
+    def test_can_log_exceptions_as_text
+      LogjamAgent.log_format = :text
+      @logger.error(StandardError.new("look ma, an exeption!"))
+      assert_equal 1, @lines.size
+      assert_equal 'StandardError(look ma, an exeption!)', @lines.first.last
+      assert_equal 1, @device.lines.size
+      assert_match(/ERROR -- : StandardError\(look ma, an exeption!\)\n/, @device.lines.first)
+    end
+
+    def test_can_log_exceptions_with_backtrace_as_text
+      LogjamAgent.log_format = :text
+      e = raise "murks" rescue $!
+      @logger.error(e)
+      assert_equal 1, @lines.size
+      assert_match(/RuntimeError\(murks\):(\n.*\.rb:\d+:in\s.*)+/, @lines.first.last)
+      assert_equal 1, @device.lines.size
+      assert_match(/ERROR -- : RuntimeError\(murks\):(\n.*\.rb:\d+:in\s.*)+/, @device.lines.first)
+    end
+
+  end
+end

data/test/selective_logging_test.rb

@@ -2,16 +2,6 @@ require_relative "test_helper.rb"
 
 module LogjamAgent
   class SelectiveLoggingTest < MiniTest::Test
-    class MockLogDev
-      attr_reader :lines
-      def initialize
-        @lines = []
-      end
-      def write(s)
-        @lines << s
-      end
-    end
-
     def setup
       @request = LogjamAgent.request = Request.new("app", "env", {})
       @lines = @request.instance_variable_get :@lines

data/test/test_helper.rb

@@ -14,3 +14,13 @@ require "logjam_agent/receiver"
 
 # for Sinatra
 ENV['RACK_ENV'] = "test"
+
+class MockLogDev
+  attr_reader :lines
+  def initialize
+    @lines = []
+  end
+  def write(s)
+    @lines << s
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logjam_agent
 version: !ruby/object:Gem::Version
-  version: 0.37.0
+  version: 0.38.0
 platform: ruby
 authors:
 - Stefan Kaes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-21 00:00:00.000000000 Z
+date: 2022-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -251,6 +251,7 @@ files:
 - lib/logjam_agent/util.rb
 - lib/logjam_agent/version.rb
 - lib/logjam_agent/zmq_forwarder.rb
+- test/json_logging_test.rb
 - test/request_test.rb
 - test/selective_logging_test.rb
 - test/sinatra_app.rb
@@ -292,4 +293,5 @@ test_files:
 - test/zmq_forwarder_test.rb
 - test/util_test.rb
 - test/test_helper.rb
+- test/json_logging_test.rb
 - test/sinatra_test.rb