rails_semantic_logger 4.5.0 → 4.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 073a9356b40dc5616e3e4b179ea108d7419dc9e4bba685c230e41acd93ca48d4
-  data.tar.gz: 106766c0a81ed7a2d7b25c7810aa1edac1eedf5638426373209b168d7ea57b43
+  metadata.gz: 6a51cc8580e730f4cf67e6525e4f560bf4b75d36f6876f89dc4381654ce58bfc
+  data.tar.gz: db93994bb8dde3d26e6e474f31fb1f80c225268037f8789f8a2ade91bb60f52c
 SHA512:
-  metadata.gz: fd450ba87b0d22e139fd7afa626ed4fb8566e3ebc70880c05fe2c73c1ff5067a8d3626a8bddd742160a3d25eced3f8e4431e1fac96432f0fe53e6ec740c78d46
-  data.tar.gz: 2bee7d442cab44140f00b9ca74d0b343d6e19933953487c5b21c094bea0c7f811f2bb6014090eda6a778eb1ebd8209f86a9b4c3afb471fd1fa9955ad3fc160e4
+  metadata.gz: 652228c641c795518f5030573d8eaf434f81a0bea1104e210c1da2bef83bc0e0cd2b6f26efd3d76cf1dbe04d10f4053a717883ddbe3b6d5bedf9619151bdb121
+  data.tar.gz: bd56572399d0c83ec385ab9e9db12b3b7f48428c54bd71b9c905595e5c619cebaff6e9e0df8792e719d69e4e6f3693a28fba8bb5606450c56e384cedea7abade

data/README.md

@@ -1,13 +1,13 @@
 # Rails Semantic Logger
-[![Gem Version](https://img.shields.io/gem/v/rails_semantic_logger.svg)](https://rubygems.org/gems/rails_semantic_logger) [![Build Status](https://travis-ci.org/rocketjob/rails_semantic_logger.svg?branch=master)](https://travis-ci.org/rocketjob/rails_semantic_logger) [![Downloads](https://img.shields.io/gem/dt/rails_semantic_logger.svg)](https://rubygems.org/gems/rails_semantic_logger) [![License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache-2.0) ![](https://img.shields.io/badge/status-Production%20Ready-blue.svg) [![Gitter chat](https://img.shields.io/badge/IRC%20(gitter)-Support-brightgreen.svg)](https://gitter.im/rocketjob/support)
+[![Gem Version](https://img.shields.io/gem/v/rails_semantic_logger.svg)](https://rubygems.org/gems/rails_semantic_logger) [![Build Status](https://github.com/reidmorrison/rails_semantic_logger/workflows/build/badge.svg)](https://github.com/reidmorrison/rails_semantic_logger/actions?query=workflow%3Abuild) [![Downloads](https://img.shields.io/gem/dt/rails_semantic_logger.svg)](https://rubygems.org/gems/rails_semantic_logger) [![License](https://img.shields.io/badge/license-Apache%202.0-brightgreen.svg)](http://opensource.org/licenses/Apache-2.0) ![](https://img.shields.io/badge/status-Production%20Ready-blue.svg)
 
-Rails Semantic Logger replaces the Rails default logger with [Semantic Logger](http://github.com/rocketjob/semantic_logger)
+Rails Semantic Logger replaces the Rails default logger with [Semantic Logger](https://logger.rocketjob.io/)
 
-* http://github.com/rocketjob/rails_semantic_logger
+* http://github.com/reidmorrison/rails_semantic_logger
 
 ## Documentation
 
-For complete documentation see: http://rocketjob.github.io/semantic_logger/rails
+For complete documentation see: https://logger.rocketjob.io/rails
 
 ## Upgrading to Semantic Logger v4.4
 
@@ -21,13 +21,13 @@ SemanticLogger::Processor.instance.instance_variable_set(:@queue, Queue.new)
 
 ## Supports
 
-For the complete list of supported Ruby and Rails versions, see the [Testing file](https://github.com/rocketjob/rails_semantic_logger/blob/master/.travis.yml).
+For the complete list of supported Ruby and Rails versions, see the [Testing file](https://github.com/reidmorrison/rails_semantic_logger/blob/master/.travis.yml).
 
 ## Author
 
 [Reid Morrison](https://github.com/reidmorrison)
 
-[Contributors](https://github.com/rocketjob/rails_semantic_logger/graphs/contributors)
+[Contributors](https://github.com/reidmorrison/rails_semantic_logger/graphs/contributors)
 
 ## Versioning
 

data/lib/rails_semantic_logger/action_controller/log_subscriber.rb

@@ -15,10 +15,10 @@ module RailsSemanticLogger
           # Unused, but needed for Devise 401 status code monkey patch to still work.
           ::ActionController::Base.log_process_action(payload)
 
-          # According to PR https://github.com/rocketjob/rails_semantic_logger/pull/37/files
+          # According to PR https://github.com/reidmorrison/rails_semantic_logger/pull/37/files
           # payload[:params] is not always a Hash.
           payload[:params] = payload[:params].to_unsafe_h unless payload[:params].is_a?(Hash)
-          payload[:params].except!(*INTERNAL_PARAMS)
+          payload[:params] = payload[:params].except(*INTERNAL_PARAMS)
           payload.delete(:params) if payload[:params].empty?
 
           format           = payload[:format]

data/lib/rails_semantic_logger/action_view/log_subscriber.rb

@@ -40,7 +40,7 @@ module RailsSemanticLogger
           partial: from_rails_root(event.payload[:identifier])
         }
         payload[:within] = from_rails_root(event.payload[:layout]) if event.payload[:layout]
-        payload[:cache]  = payload[:cache_hit] unless event.payload[:cache_hit].nil?
+        payload[:cache]  = event.payload[:cache_hit] unless event.payload[:cache_hit].nil?
         payload[:allocations] = event.allocations if event.respond_to?(:allocations)
 
         logger.measure(
@@ -60,7 +60,7 @@ module RailsSemanticLogger
           template: from_rails_root(identifier),
           count:    event.payload[:count]
         }
-        payload[:cache_hits] = payload[:cache_hits] if payload[:cache_hits]
+        payload[:cache_hits] = event.payload[:cache_hits] if event.payload[:cache_hits]
         payload[:allocations] = event.allocations if event.respond_to?(:allocations)
 
         logger.measure(

data/lib/rails_semantic_logger/active_job/log_subscriber.rb

@@ -5,29 +5,34 @@ module RailsSemanticLogger
     class LogSubscriber < ::ActiveSupport::LogSubscriber
       def enqueue(event)
         log_with_formatter event: event do |fmt|
-          "Enqueued #{fmt.job_info}"
+          {message: "Enqueued #{fmt.job_info}"}
         end
       end
 
       def enqueue_at(event)
         log_with_formatter event: event do |fmt|
-          "Enqueued #{fmt.job_info} at #{fmt.scheduled_at}"
+          {message: "Enqueued #{fmt.job_info} at #{fmt.scheduled_at}"}
         end
       end
 
       def perform_start(event)
         log_with_formatter event: event do |fmt|
-          "Performing #{fmt.job_info}"
+          {message: "Performing #{fmt.job_info}"}
         end
       end
 
       def perform(event)
         ex = event.payload[:exception_object]
         if ex
-          logger.error ex
+          log_with_formatter event: event, log_duration: true, level: :error do |fmt|
+            {
+              message: "Error performing #{fmt.job_info} in #{event.duration.round(2)}ms",
+              exception: ex
+            }
+          end
         else
           log_with_formatter event: event, log_duration: true do |fmt|
-            "Performed #{fmt.job_info} in #{event.duration.round(2)}ms"
+            {message: "Performed #{fmt.job_info} in #{event.duration.round(2)}ms"}
           end
         end
       end
@@ -107,10 +112,10 @@ module RailsSemanticLogger
         end
       end
 
-      def log_with_formatter(**kw_args)
+      def log_with_formatter(level: :info, **kw_args)
         fmt = EventFormatter.new(**kw_args)
         msg = yield fmt
-        logger.info msg, fmt.payload
+        logger.public_send(level, **msg, payload: fmt.payload)
       end
 
       def logger

data/lib/rails_semantic_logger/active_record/log_subscriber.rb

@@ -32,6 +32,7 @@ module RailsSemanticLogger
         log_payload         = {sql: payload[:sql]}
         log_payload[:binds] = bind_values(payload) unless (payload[:binds] || []).empty?
         log_payload[:allocations] = event.allocations if event.respond_to?(:allocations)
+        log_payload[:cached] = event.payload[:cached]
 
         log = {
           message:  name,
@@ -41,7 +42,7 @@ module RailsSemanticLogger
 
         # Log the location of the query itself.
         if logger.send(:level_index) >= SemanticLogger.backtrace_level_index
-          log[:backtrace] = SemanticLogger::Utils.strip_backtrace
+          log[:backtrace] = SemanticLogger::Utils.strip_backtrace(caller)
         end
 
         logger.debug(log)
@@ -177,7 +178,7 @@ module RailsSemanticLogger
           attr = nil
         end
 
-        [attr&.name, value]
+        [attr&.name || :nil, value]
       end
 
       def type_casted_binds_v5_0_3(binds, casted_binds)

data/lib/rails_semantic_logger/engine.rb

@@ -123,22 +123,27 @@ module RailsSemanticLogger
 
       # Replace the Bugsnag logger
       Bugsnag.configure { |config| config.logger = SemanticLogger[Bugsnag] } if defined?(Bugsnag)
+
+      # Set the IOStreams PGP logger
+      IOStreams::Pgp.logger = SemanticLogger["IOStreams::Pgp"] if defined?(IOStreams)
     end
 
     # After any initializers run, but after the gems have been loaded
     config.after_initialize do
+      config = Rails.application.config
+
       # Replace the Bugsnag logger
-      Bugsnag.configure { |config| config.logger = SemanticLogger[Bugsnag] } if defined?(Bugsnag)
+      Bugsnag.configure { |bugsnag_config| bugsnag_config.logger = SemanticLogger[Bugsnag] } if defined?(Bugsnag)
 
       # Rails Patches
-      require("rails_semantic_logger/extensions/action_cable/tagged_logger_proxy") if defined?(ActionCable)
-      require("rails_semantic_logger/extensions/action_controller/live") if defined?(ActionController::Live)
-      require("rails_semantic_logger/extensions/action_dispatch/debug_exceptions") if defined?(ActionDispatch::DebugExceptions)
-      if defined?(ActionView::StreamingTemplateRenderer::Body)
+      require("rails_semantic_logger/extensions/action_cable/tagged_logger_proxy") if defined?(::ActionCable)
+      require("rails_semantic_logger/extensions/action_controller/live") if defined?(::ActionController::Live)
+      require("rails_semantic_logger/extensions/action_dispatch/debug_exceptions") if defined?(::ActionDispatch::DebugExceptions)
+      if defined?(::ActionView::StreamingTemplateRenderer::Body)
         require("rails_semantic_logger/extensions/action_view/streaming_template_renderer")
       end
       require("rails_semantic_logger/extensions/active_job/logging") if defined?(::ActiveJob)
-      require("rails_semantic_logger/extensions/active_model_serializers/logging") if defined?(ActiveModelSerializers)
+      require("rails_semantic_logger/extensions/active_model_serializers/logging") if defined?(::ActiveModelSerializers)
 
       if config.rails_semantic_logger.semantic
         # Active Job
@@ -174,7 +179,8 @@ module RailsSemanticLogger
 
         # Silence asset logging by applying a filter to the Rails logger itself, not any of the appenders.
         if config.rails_semantic_logger.quiet_assets && config.assets.prefix
-          assets_regex                                    = %r(\A/{0,2}#{config.assets.prefix})
+          assets_root                                     = config.relative_url_root.to_s + config.assets.prefix
+          assets_regex                                    = %r(\A/{0,2}#{assets_root})
           RailsSemanticLogger::Rack::Logger.logger.filter = ->(log) { log.payload[:path] !~ assets_regex if log.payload }
         end
 
@@ -211,6 +217,18 @@ module RailsSemanticLogger
 
       # Re-open appenders after Spring has forked a process
       Spring.after_fork { |_job| ::SemanticLogger.reopen } if defined?(Spring.after_fork)
+
+      console do |_app|
+        # Don't use a background thread for logging
+        SemanticLogger.sync!
+        # Add a stderr logger when running inside a Rails console unless one has already been added.
+        if config.rails_semantic_logger.console_logger && !SemanticLogger::Logger.processor.appenders.console_output?
+          SemanticLogger.add_appender(io: STDERR, formatter: :color)
+        end
+
+        # Include method names on log entries in the console
+        SemanticLogger.backtrace_level = SemanticLogger.default_level
+      end
     end
   end
 end

data/lib/rails_semantic_logger/extensions/action_cable/tagged_logger_proxy.rb

@@ -1,4 +1,4 @@
-ActionCable::Connection::TaggedLoggerProxy
+require "action_cable/connection/tagged_logger_proxy"
 
 module ActionCable
   module Connection

data/lib/rails_semantic_logger/extensions/action_controller/live.rb

@@ -1,7 +1,9 @@
 # Log actual exceptions, not a string representation
-ActionController::Live
+require "action_controller"
+
 module ActionController
   module Live
+    undef_method :log_error
     def log_error(exception)
       logger.fatal(exception)
     end

data/lib/rails_semantic_logger/extensions/action_dispatch/debug_exceptions.rb

@@ -1,9 +1,11 @@
 # Log actual exceptions, not a string representation
-ActionDispatch::DebugExceptions
+require "action_dispatch"
+
 module ActionDispatch
   class DebugExceptions
     private
 
+    undef_method :log_error
     def log_error(_request, wrapper)
       ActiveSupport::Deprecation.silence do
         ActionController::Base.logger.fatal(wrapper.exception)

data/lib/rails_semantic_logger/extensions/action_view/streaming_template_renderer.rb

@@ -1,11 +1,12 @@
 # Log actual exceptions, not a string representation
-ActionView::StreamingTemplateRenderer
+require "action_view/renderer/streaming_template_renderer"
 
 module ActionView
   class StreamingTemplateRenderer
     class Body
       private
 
+      undef_method :log_error
       def log_error(exception)
         ActionView::Base.logger.fatal(exception)
       end

data/lib/rails_semantic_logger/extensions/active_job/logging.rb

@@ -7,6 +7,7 @@ module ActiveJob
 
     private
 
+    undef_method :tag_logger
     def tag_logger(*tags, &block)
       logger.tagged(*tags, &block)
     end

data/lib/rails_semantic_logger/extensions/active_support/logger.rb

@@ -0,0 +1,24 @@
+require "active_support/logger"
+
+module ActiveSupport
+  # More hacks to try and stop Rails from being it's own worst enemy.
+  class Logger
+    class << self
+      undef :logger_outputs_to?, :broadcast
+    end
+
+    # Prevent Console from trying to merge loggers
+    def self.logger_outputs_to?(*args)
+      true
+    end
+
+    # Prevent broadcasting since SemanticLogger already supports multiple loggers
+    def self.broadcast(logger)
+      Module.new
+    end
+
+    def self.new(*args, **kwargs)
+      SemanticLogger[self]
+    end
+  end
+end

data/lib/rails_semantic_logger/extensions/active_support/tagged_logging.rb

@@ -0,0 +1,8 @@
+module ActiveSupport
+  module TaggedLogging
+    # Semantic Logger already does tagged logging
+    def self.new(logger)
+      logger
+    end
+  end
+end

data/lib/rails_semantic_logger/extensions/mongoid/config.rb

@@ -0,0 +1,11 @@
+require "mongoid/config"
+
+module Mongoid
+  module Config
+    private
+
+    # Remove log overrides
+    def set_log_levels
+    end
+  end
+end

data/lib/rails_semantic_logger/extensions/rack/server.rb

@@ -0,0 +1,12 @@
+module RailsSemanticLogger
+  module Rack
+    module Server
+      def daemonize_app
+        super
+        SemanticLogger.reopen
+      end
+    end
+  end
+end
+
+Rack::Server.prepend(RailsSemanticLogger::Rack::Server)

data/lib/rails_semantic_logger/extensions/rails/server.rb

@@ -1,10 +1,14 @@
 # Patch the Rails::Server log_to_stdout so that it logs via SemanticLogger
-Rails::Server
+require "rails"
+
 module Rails
   class Server
     private
-
+    
+    undef_method :log_to_stdout
     def log_to_stdout
+      wrapped_app # touch the app so the logger is set up
+
       SemanticLogger.add_appender(io: $stdout, formatter: :color)
     end
   end

data/lib/rails_semantic_logger/options.rb

@@ -48,6 +48,10 @@ module RailsSemanticLogger
   #
   #     config.rails_semantic_logger.quiet_assets = false
   #
+  # * Disable automatic logging to stderr when running a Rails console.
+  #
+  #     config.rails_semantic_logger.console_logger = false
+  #
   # * Override the output format for the primary Rails log file.
   #
   #     Valid options:
@@ -98,7 +102,7 @@ module RailsSemanticLogger
   #   config.rails_semantic_logger.named_tags = nil
   class Options
     attr_accessor :semantic, :started, :processing, :rendered, :ap_options, :add_file_appender,
-                  :quiet_assets, :format, :named_tags, :filter
+                  :quiet_assets, :format, :named_tags, :filter, :console_logger
 
     # Setup default values
     def initialize
@@ -112,6 +116,7 @@ module RailsSemanticLogger
       @format            = :default
       @named_tags        = nil
       @filter            = nil
+      @console_logger    = true
     end
   end
 end

data/lib/rails_semantic_logger/rack/logger.rb

@@ -54,7 +54,7 @@ module RailsSemanticLogger
           payload: {
             method: request.request_method,
             path:   request.filtered_path,
-            ip:     request.ip
+            ip:     request.remote_ip
           }
         }
       end

data/lib/rails_semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module RailsSemanticLogger
-  VERSION = "4.5.0".freeze
+  VERSION = "4.6.2".freeze
 end

data/lib/rails_semantic_logger.rb

@@ -52,3 +52,7 @@ module RailsSemanticLogger
 
   private_class_method :subscriber_patterns, :unattach
 end
+
+require("rails_semantic_logger/extensions/mongoid/config") if defined?(Mongoid)
+require("rails_semantic_logger/extensions/active_support/logger") if defined?(ActiveSupport::Logger)
+require("rails_semantic_logger/extensions/rack/server") if defined?(Rack::Server)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_semantic_logger
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.6.2
 platform: ruby
 authors:
 - Reid Morrison
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-24 00:00:00.000000000 Z
+date: 2021-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -44,17 +44,16 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '4.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '4.8'
 description:
 email:
-- reidmo@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -75,11 +74,15 @@ files:
 - lib/rails_semantic_logger/extensions/action_view/streaming_template_renderer.rb
 - lib/rails_semantic_logger/extensions/active_job/logging.rb
 - lib/rails_semantic_logger/extensions/active_model_serializers/logging.rb
+- lib/rails_semantic_logger/extensions/active_support/logger.rb
+- lib/rails_semantic_logger/extensions/active_support/tagged_logging.rb
+- lib/rails_semantic_logger/extensions/mongoid/config.rb
+- lib/rails_semantic_logger/extensions/rack/server.rb
 - lib/rails_semantic_logger/extensions/rails/server.rb
 - lib/rails_semantic_logger/options.rb
 - lib/rails_semantic_logger/rack/logger.rb
 - lib/rails_semantic_logger/version.rb
-homepage: https://github.com/rocketjob/rails_semantic_logger
+homepage: https://logger.rocketjob.io
 licenses:
 - Apache-2.0
 metadata: {}
@@ -91,14 +94,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Feature rich logging framework that replaces the Rails logger.