ezlog 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e73705d16d2f3167345f05a0850bcd9b249609d38717d132bad505c52ffa029f
-  data.tar.gz: 565ad4f1d10bfd60cfec96c06f86ee8295974d19fcd4493fba12bdb4a94098d1
+  metadata.gz: a13352755faf442588dbe56813e8cc770f94c088455497f98b7d826ced91ff10
+  data.tar.gz: ea44535055ff6b6d33809e826113a4121277dc9c7e74faaf82f7516e40301daa
 SHA512:
-  metadata.gz: fedd5799e21e4f258bd90c20467026369dc96e51aebfb9a62703c82d3f4381680fd22a0546711610de429ddfefe741f07e60960f6c8cd60ce9bd22541faece3c
-  data.tar.gz: 223cc4fb2d1aee674ed7281d369154b857cc4ed5a4ea5a47c64b58ca5f8d7cd1c9194ae8f2fc053cd8f792ef9d295b3dd72996aba97d82d7bcbd45a52136e132
+  metadata.gz: 02e113881e70f1b46123156b2cad9682100a7006b822f5c93a18200be3aba8de8cc852b904591f505236ca1d867f3eb725fd9a310fdef7e395ccf7fe85c8ee2c
+  data.tar.gz: 98ef1ef8fc146fd662354db14ae07febbfde6296b4545bc5aace9776164648052fd497953f68b5e7ddca3e26d99e30466bd4f10a24d0632e26f60cbbb97915ee

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+### 0.4.0 (2019-09-06)
+
+[Full Changelog](https://github.com/emartech/ezlog/compare/v0.3.5...v0.4.0)
+
+* Features & enhancements
+  * Added log context management methods `within_log_context` and `add_to_log_context` to Ezlog module.
+  * Replaced ActiveRecord query logging with a log subscriber that logs queries via Ezlog.
+  * Added automatic query logging (at DEBUG level) to Sequel connections.
+  
+* Bug fixes
+  * ActionDispatch::DebugExceptions is no longer replaced because other gems 
+    (like [web-console](https://github.com/rails/web-console)) are depending on it.
+
 ### 0.3.5 (2019-08-14)
 
 [Full Changelog](https://github.com/emartech/ezlog/compare/v0.3.4...v0.3.5)

data/ezlog.gemspec

@@ -28,5 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "sidekiq", "~> 5.0"
+  spec.add_development_dependency "sequel", "~> 5.0"
   spec.add_development_dependency "actionpack", "~> 5.0"
+  spec.add_development_dependency "activerecord", "~> 5.0"
 end

data/lib/ezlog.rb

@@ -12,4 +12,6 @@ module Ezlog
   def self.logger(name)
     ::Logging::Logger[name]
   end
+
+  extend LogContextHelper
 end

data/lib/ezlog/rails.rb

@@ -4,6 +4,7 @@ require "action_controller/log_subscriber"
 module Ezlog
   module Rails
     autoload :AccessLog, 'ezlog/rails/access_log'
+    autoload :ActiveRecord, 'ezlog/rails/active_record'
     autoload :DebugExceptions, 'ezlog/rails/debug_exceptions'
     autoload :LogExceptions, 'ezlog/rails/log_exceptions'
     autoload :RequestLogContext, 'ezlog/rails/request_log_context'

data/lib/ezlog/rails/active_record.rb

@@ -0,0 +1,7 @@
+module Ezlog
+  module Rails
+    module ActiveRecord
+      autoload :LogSubscriber, 'ezlog/rails/active_record/log_subscriber'
+    end
+  end
+end

data/lib/ezlog/rails/active_record/log_subscriber.rb

@@ -0,0 +1,49 @@
+module Ezlog
+  module Rails
+    module ActiveRecord
+      class LogSubscriber < ::ActiveSupport::LogSubscriber
+        def sql(event)
+          ::ActiveRecord::Base.logger.debug log_message_from(event)
+        end
+
+        private
+
+        def log_message_from(event)
+          basic_message_from(event).tap do |message|
+            params = params_from event
+            message[:params] = params if params.any?
+          end
+        end
+
+        def basic_message_from(event)
+          {
+            message: "SQL - #{event.payload[:name]} (#{event.duration.round(3)}ms)",
+            sql: event.payload[:sql],
+            duration_sec: (event.duration / 1000.0).round(5)
+          }
+        end
+
+        def params_from(event)
+          return {} if event.payload.fetch(:binds, []).empty?
+
+          params = event.payload[:binds]
+          values = type_casted_values_from event
+          param_value_pairs = params.zip(values).map do |param, value|
+            [param.name, value_of(param, value)]
+          end
+
+          Hash[param_value_pairs]
+        end
+
+        def type_casted_values_from(event)
+          binds = event.payload[:type_casted_binds]
+          binds.respond_to?(:call) ? binds.call : binds
+        end
+
+        def value_of(param, value)
+          param.type.binary? ? '-binary data-' : value
+        end
+      end
+    end
+  end
+end

data/lib/ezlog/rails/extensions.rb

@@ -0,0 +1,9 @@
+module ActionDispatch
+  class DebugExceptions
+    def skip_logging_error(_request, _wrapper)
+    end
+
+    alias_method :original_log_error, :log_error
+    alias_method :log_error, :skip_logging_error
+  end
+end

data/lib/ezlog/rails/log_subscriber.rb

@@ -1,15 +1,21 @@
 module Ezlog
   module Rails
     class LogSubscriber
-      def self.detach(subscriber_class)
-        subscriber = ::ActiveSupport::LogSubscriber.log_subscribers.find { |subscriber| subscriber.is_a? subscriber_class }
-        return unless subscriber
+      class << self
+        def detach(subscriber_class)
+          subscriber = ::ActiveSupport::LogSubscriber.log_subscribers.find { |subscriber| subscriber.is_a? subscriber_class }
+          return unless subscriber
 
-        subscriber.patterns.each do |pattern|
-          ::ActiveSupport::Notifications.notifier.listeners_for(pattern).each do |listener|
-            ::ActiveSupport::Notifications.unsubscribe listener if listener.instance_variable_get('@delegate').is_a? subscriber_class
+          subscriber.patterns.each do |pattern|
+            ::ActiveSupport::Notifications.notifier.listeners_for(pattern).each do |listener|
+              ::ActiveSupport::Notifications.unsubscribe listener if listener.instance_variable_get('@delegate').is_a? subscriber_class
+            end
           end
         end
+
+        def attach(subscriber_class, namespace)
+          subscriber_class.attach_to namespace
+        end
       end
     end
   end

data/lib/ezlog/railtie.rb

@@ -1,29 +1,38 @@
 module Ezlog
   class Railtie < Rails::Railtie
+    initializer "ezlog.initialize" do
+      require "ezlog/rails/extensions"
+    end
+
     initializer 'ezlog.configure_logging' do |app|
       ::Logging.logger.root.appenders = ::Logging.appenders.stdout 'stdout', layout: Ezlog::LoggingLayout.new(environment: ::Rails.env)
       ::Logging.logger.root.level = app.config.log_level
     end
 
-    initializer 'ezlog.configure_sidekiq_logging' do |app|
+    initializer 'ezlog.configure_sidekiq' do |app|
       initialize_sidekiq_logging(app) if defined? ::Sidekiq
     end
 
-    initializer 'ezlog.configure_rack_timeout_logging' do
+    initializer 'ezlog.configure_sequel' do
+      ::Sequel::Database.extension :ezlog_logging if defined? ::Sequel
+    end
+
+    initializer 'ezlog.configure_rack_timeout' do
       disable_rack_timeout_logging if defined? ::Rack::Timeout
     end
 
-    initializer 'ezlog.configure_middlewares' do |app|
+    initializer 'ezlog.configure_rails_middlewares' do |app|
       app.config.middleware.insert_after ::ActionDispatch::RequestId, Ezlog::Rails::RequestLogContext
       app.config.middleware.delete ::Rails::Rack::Logger
-      app.config.middleware.swap ::ActionDispatch::DebugExceptions, Ezlog::Rails::DebugExceptions
-      app.config.middleware.insert_before Ezlog::Rails::DebugExceptions, Ezlog::Rails::AccessLog, Ezlog.logger('AccessLog')
-      app.config.middleware.insert_after Ezlog::Rails::DebugExceptions, Ezlog::Rails::LogExceptions, Ezlog.logger('Application')
+      app.config.middleware.insert_before ::ActionDispatch::DebugExceptions, Ezlog::Rails::AccessLog, Ezlog.logger('AccessLog')
+      app.config.middleware.insert_after ::ActionDispatch::DebugExceptions, Ezlog::Rails::LogExceptions, Ezlog.logger('Application')
     end
 
     config.after_initialize do
       Ezlog::Rails::LogSubscriber.detach ::ActionController::LogSubscriber
       Ezlog::Rails::LogSubscriber.detach ::ActionView::LogSubscriber
+      Ezlog::Rails::LogSubscriber.detach ::ActiveRecord::LogSubscriber
+      Ezlog::Rails::LogSubscriber.attach Ezlog::Rails::ActiveRecord::LogSubscriber, :active_record
     end
 
     config.before_configuration do |app|

data/lib/ezlog/version.rb

@@ -1,3 +1,3 @@
 module Ezlog
-  VERSION = '0.3.5'
+  VERSION = '0.4.0'
 end

data/lib/sequel/extensions/ezlog_logging.rb

@@ -0,0 +1,15 @@
+module Ezlog
+  module Sequel
+    module LoggingExtension
+      def self.extended(db)
+        db.instance_exec do
+          self.sql_log_level = :debug
+          self.log_connection_info = false
+          @loggers << Ezlog.logger('Sequel')
+        end
+      end
+    end
+
+    ::Sequel::Database.register_extension :ezlog_logging, LoggingExtension
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezlog
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Zoltan Ormandi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-14 00:00:00.000000000 Z
+date: 2019-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 description: 
 email:
 - zoltan.ormandi@emarsys.com
@@ -117,7 +145,9 @@ files:
 - lib/ezlog/logging_layout.rb
 - lib/ezlog/rails.rb
 - lib/ezlog/rails/access_log.rb
-- lib/ezlog/rails/debug_exceptions.rb
+- lib/ezlog/rails/active_record.rb
+- lib/ezlog/rails/active_record/log_subscriber.rb
+- lib/ezlog/rails/extensions.rb
 - lib/ezlog/rails/log_exceptions.rb
 - lib/ezlog/rails/log_subscriber.rb
 - lib/ezlog/rails/request_log_context.rb
@@ -130,6 +160,7 @@ files:
 - lib/ezlog/sidekiq/job_context.rb
 - lib/ezlog/sidekiq/job_logger.rb
 - lib/ezlog/version.rb
+- lib/sequel/extensions/ezlog_logging.rb
 homepage: https://github.com/emartech/ezlog
 licenses:
 - MIT
@@ -150,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A zero-configuration logging solution for projects using Sidekiq, Rails,

data/lib/ezlog/rails/debug_exceptions.rb

@@ -1,8 +0,0 @@
-module Ezlog
-  module Rails
-    class DebugExceptions < ::ActionDispatch::DebugExceptions
-      def log_error(_request, _wrapper)
-      end
-    end
-  end
-end