log_sanity 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cd638933608ceaeffa6e4ac4f9dff3650128a21e7afee0d31f003b6f381c6ff
-  data.tar.gz: c0753610f32d3828d8d667c06fd6c023c7ad08aed3b167d6851f99c579c446d6
+  metadata.gz: 4b955406c6e0a56ba3242cef72764433a08abc54fa8e0b0241eb85ed3038f5b2
+  data.tar.gz: d663a844b8eb827ff0f7693386b7c48e13ab609c1b229978d5626d41b4c4c6f7
 SHA512:
-  metadata.gz: efbdfe624f62f7e5883cb4e7a10e0f32ad41dea981f8cad792c1b27c18cdd3452dbf8e2345601df786458a428f91fe2e5751979ffb2d318a0558f9352a98ddea
-  data.tar.gz: 74bf53856c0eabfd35f3d0b90893bba70b7a671579253f2b2dc4440ae4a7017de97cd8410b01a869d7091f975641464b52ab0d7021952eaf09a4b84d05836b2b
+  metadata.gz: ebf2265262ef180c669376798887e66e92176e07fcc725f8ccfc6bdf0e642c450363d0214f0aed8519c9e1ac7369ac117e6f8ceb2f2d88cdf3da9d12bc17616b
+  data.tar.gz: d1eaf205cd088590de19326404fc59eb076a8cd6d9d8c3dc777a1fa681d017d213cc5796c43f88efba8a8ebc52e875bf39fd5e63da3d72ffdb82111d9c23c2a2

data/Gemfile.lock

@@ -1,138 +1,136 @@
 PATH
   remote: .
   specs:
-    log_sanity (1.0.0)
-      rails (>= 5.2, < 6.2)
+    log_sanity (1.2.0)
+      rails (>= 5.2, < 7.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.1.0)
-      actionpack (= 6.1.0)
-      activesupport (= 6.1.0)
+    actioncable (6.1.4.6)
+      actionpack (= 6.1.4.6)
+      activesupport (= 6.1.4.6)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.1.0)
-      actionpack (= 6.1.0)
-      activejob (= 6.1.0)
-      activerecord (= 6.1.0)
-      activestorage (= 6.1.0)
-      activesupport (= 6.1.0)
+    actionmailbox (6.1.4.6)
+      actionpack (= 6.1.4.6)
+      activejob (= 6.1.4.6)
+      activerecord (= 6.1.4.6)
+      activestorage (= 6.1.4.6)
+      activesupport (= 6.1.4.6)
       mail (>= 2.7.1)
-    actionmailer (6.1.0)
-      actionpack (= 6.1.0)
-      actionview (= 6.1.0)
-      activejob (= 6.1.0)
-      activesupport (= 6.1.0)
+    actionmailer (6.1.4.6)
+      actionpack (= 6.1.4.6)
+      actionview (= 6.1.4.6)
+      activejob (= 6.1.4.6)
+      activesupport (= 6.1.4.6)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.1.0)
-      actionview (= 6.1.0)
-      activesupport (= 6.1.0)
+    actionpack (6.1.4.6)
+      actionview (= 6.1.4.6)
+      activesupport (= 6.1.4.6)
       rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.1.0)
-      actionpack (= 6.1.0)
-      activerecord (= 6.1.0)
-      activestorage (= 6.1.0)
-      activesupport (= 6.1.0)
+    actiontext (6.1.4.6)
+      actionpack (= 6.1.4.6)
+      activerecord (= 6.1.4.6)
+      activestorage (= 6.1.4.6)
+      activesupport (= 6.1.4.6)
       nokogiri (>= 1.8.5)
-    actionview (6.1.0)
-      activesupport (= 6.1.0)
+    actionview (6.1.4.6)
+      activesupport (= 6.1.4.6)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.1.0)
-      activesupport (= 6.1.0)
+    activejob (6.1.4.6)
+      activesupport (= 6.1.4.6)
       globalid (>= 0.3.6)
-    activemodel (6.1.0)
-      activesupport (= 6.1.0)
-    activerecord (6.1.0)
-      activemodel (= 6.1.0)
-      activesupport (= 6.1.0)
-    activestorage (6.1.0)
-      actionpack (= 6.1.0)
-      activejob (= 6.1.0)
-      activerecord (= 6.1.0)
-      activesupport (= 6.1.0)
-      marcel (~> 0.3.1)
-      mimemagic (~> 0.3.2)
-    activesupport (6.1.0)
+    activemodel (6.1.4.6)
+      activesupport (= 6.1.4.6)
+    activerecord (6.1.4.6)
+      activemodel (= 6.1.4.6)
+      activesupport (= 6.1.4.6)
+    activestorage (6.1.4.6)
+      actionpack (= 6.1.4.6)
+      activejob (= 6.1.4.6)
+      activerecord (= 6.1.4.6)
+      activesupport (= 6.1.4.6)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
     builder (3.2.4)
-    concurrent-ruby (1.1.7)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
     erubi (1.10.0)
-    globalid (0.4.2)
-      activesupport (>= 4.2.0)
-    i18n (1.8.5)
+    globalid (1.0.0)
+      activesupport (>= 5.0)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    loofah (2.8.0)
+    loofah (2.14.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    marcel (0.3.3)
-      mimemagic (~> 0.3.2)
+    marcel (1.0.2)
     method_source (1.0.0)
-    mimemagic (0.3.5)
-    mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.2)
-    nio4r (2.5.4)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
+    mini_mime (1.1.2)
+    minitest (5.15.0)
+    nio4r (2.5.8)
+    nokogiri (1.13.3-x86_64-darwin)
+      racc (~> 1.4)
+    racc (1.6.0)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.1.0)
-      actioncable (= 6.1.0)
-      actionmailbox (= 6.1.0)
-      actionmailer (= 6.1.0)
-      actionpack (= 6.1.0)
-      actiontext (= 6.1.0)
-      actionview (= 6.1.0)
-      activejob (= 6.1.0)
-      activemodel (= 6.1.0)
-      activerecord (= 6.1.0)
-      activestorage (= 6.1.0)
-      activesupport (= 6.1.0)
+    rails (6.1.4.6)
+      actioncable (= 6.1.4.6)
+      actionmailbox (= 6.1.4.6)
+      actionmailer (= 6.1.4.6)
+      actionpack (= 6.1.4.6)
+      actiontext (= 6.1.4.6)
+      actionview (= 6.1.4.6)
+      activejob (= 6.1.4.6)
+      activemodel (= 6.1.4.6)
+      activerecord (= 6.1.4.6)
+      activestorage (= 6.1.4.6)
+      activesupport (= 6.1.4.6)
       bundler (>= 1.15.0)
-      railties (= 6.1.0)
+      railties (= 6.1.4.6)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.3.0)
+    rails-html-sanitizer (1.4.2)
       loofah (~> 2.3)
-    railties (6.1.0)
-      actionpack (= 6.1.0)
-      activesupport (= 6.1.0)
+    railties (6.1.4.6)
+      actionpack (= 6.1.4.6)
+      activesupport (= 6.1.4.6)
       method_source
-      rake (>= 0.8.7)
+      rake (>= 0.13)
       thor (~> 1.0)
-    rake (13.0.3)
+    rake (13.0.6)
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.2.2)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
       sprockets (>= 3.0.0)
-    thor (1.0.1)
+    thor (1.2.1)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    websocket-driver (0.7.3)
+    websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   ruby
@@ -141,4 +139,4 @@ DEPENDENCIES
   log_sanity!
 
 BUNDLED WITH
-   1.17.3
+   2.2.22

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2017-2020 thomas morgan
+Copyright 2017-2022 thomas morgan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -143,7 +143,7 @@ LogSanity takes these and adds them to the default request log entry (but _not_
 
 LogSanity is intended for production use at log_level info. At level debug, some logs are simply turned off. Others may continue to output as normal strings (such as ActiveRecord).
 
-There is no need to use ActiveSupport::TaggedLogging with your logger. Just set the logger directly (if not using the default):
+If not using tags, there is no need to use ActiveSupport::TaggedLogging with your logger. Just set the logger directly (if not using the default):
 ```
 config.logger = ActiveSupport::Logger.new(STDOUT)
 ```
@@ -172,7 +172,7 @@ There are still some things that could be handled better (such as multi-line str
 
 Pull requests are welcomed and encouraged. The only goal is to avoid making things unnecessarily complex.
 
-Tested on Rails 5.2 through 6.1 (or later). Anything older is untested. Small patches for older compatibility will be considered.
+Tested on Rails 5.2 through 7.0 (or later). Anything older is untested. Small patches for older compatibility will be considered.
 
 License: MIT
 

data/lib/log_sanity/extensions/action_cable_connection.rb

@@ -0,0 +1,39 @@
+module LogSanity
+  module Extensions
+    module ActionCableConnection
+      extend ActiveSupport::Concern
+
+      def close(reason: nil, **args)
+        @close_reason = reason
+        super
+      end
+
+      def process
+        payload = { request: request }
+        ActiveSupport::Notifications.instrument("process.action_cable", payload) do
+          status, _, _ = response = super
+          payload[:status] = status==-1 ? 101 : status
+          response
+        end
+      end
+
+      def reject_unauthorized_connection
+        logger.instance_variable_get(:@logger).silence(Logger::FATAL) do
+          super
+        end
+      end
+
+      def on_close(reason, code)
+        payload = {
+          connection_sec: Time.now - @started_at,
+          request: request
+        }
+        payload[:reason] = @close_reason if @close_reason
+        ActiveSupport::Notifications.instrument("on_close.action_cable", payload) do
+          super
+        end
+      end
+
+    end
+  end
+end

data/lib/log_sanity/formatter.rb

@@ -9,12 +9,16 @@
 
 module LogSanity
   class Formatter < Logger::Formatter
+    include ActiveSupport::TaggedLogging::Formatter
+      # tags are ignored when rendering as json
+      # however, tags are prepended when rendering with string_formatter
 
     def call(severity, timestamp, progname, msg)
       if msg.is_a? Hash
-        msg['at'] = timestamp unless msg.key?('at')
+        msg.reverse_merge!('at' => timestamp) unless msg.key?('at')
       elsif msg.is_a? String
         if string_formatter
+          msg = "#{tags_text}#{msg}" if current_tags.any?
           return string_formatter.call(severity, timestamp, progname, msg)
         else
           msg = {'at' => timestamp, 'message' => msg}
@@ -22,22 +26,14 @@ module LogSanity
       else
         msg = {'at' => timestamp, 'object' => msg.inspect}
       end
-      if msg['at'].is_a? Float
-        monot = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-        msg['at'] = Time.now - (monot - msg['at'])
-      end
       msg['at'] = msg['at'].utc
       "#{msg.to_json}\n"
     end
 
-    # noop; for TaggedLogging compatibility
-    def clear_tags! ; end
-    def tagged(*_) ; yield self ; end
-    def current_tags ; [] ; end
-
     attr_writer :string_formatter
 
     def string_formatter
+      return @string_formatter if defined?(@string_formatter)
       @string_formatter ||= ActiveSupport::Logger::SimpleFormatter.new
     end
 

data/lib/log_sanity/log_subscribers/action_cable.rb

@@ -0,0 +1,30 @@
+module LogSanity
+  module LogSubscriber
+    class ActionCable < Base
+
+      def process(event)
+        payload = event.payload
+        log 'event', 'ws_connect'
+        log 'status', payload[:status]
+        # logged by the actiondispatch subscriber
+      end
+
+      def on_close(event)
+        payload = event.payload
+        request = payload[:request]
+        info do
+          e = {
+            'at' => Time.now,
+            'event' => 'ws_disconnect',
+            'ip' => request.remote_ip,
+            'rq' => request.uuid,
+            'duration' => {'socket' => "#{payload[:connection_sec].round}s"}
+          }
+          e['reason'] = payload[:reason] if payload[:reason]
+          e
+        end
+      end
+
+    end
+  end
+end

data/lib/log_sanity/log_subscribers/action_dispatch.rb

@@ -11,7 +11,7 @@ module LogSanity
           response = payload[:response]
           method = payload[:method] || (request.request_method rescue nil) || 'UNKNOWN'
           f2 = {
-            'at' => event.time,
+            'at' => event_start(event),
             'event' => "#{request.scheme}_#{method.downcase}",
             'ip' => request.remote_ip,
             'rq' => request.uuid,

data/lib/log_sanity/log_subscribers/base.rb

@@ -5,6 +5,15 @@ module LogSanity
       private
       delegate :fields, :log, to: LogSanity
 
+      def event_start(event)
+        if event.time.is_a? Float
+          # convert event's monotonic start .time to a Time
+          Time.current - event.duration/1000.0
+        else
+          event.time
+        end
+      end
+
     end
   end
 end

data/lib/log_sanity/railtie.rb

@@ -10,7 +10,11 @@ module LogSanity
       if app.config.logsanity.enabled
         orig_formatter = Rails.logger.formatter
         Rails.logger.formatter = LogSanity::Formatter.new
-        Rails.logger.formatter.string_formatter = orig_formatter unless app.config.logsanity.json_strings
+        if app.config.logsanity.json_strings
+          Rails.logger.formatter.string_formatter = false
+        else
+          Rails.logger.formatter.string_formatter = orig_formatter if orig_formatter
+        end
 
         if defined?(ActionController)
           require 'action_controller/log_subscriber'
@@ -37,11 +41,25 @@ module LogSanity
           end
         end
         if defined?(ActiveRecord)
+          # require 'active_record/log_subscriber'
+          # ActiveRecord::LogSubscriber.detach_from :active_record
+            # this turns off measurements too
           if ActiveRecord::Base.logger.debug?
             Rails.logger.info '[LogSanity] ActiveRecord::Base.logger in debug mode and will still log queries'
           end
         end
 
+        ActiveSupport.on_load(:action_cable) do
+          orig_logger = logger || Rails.logger
+          self.logger = orig_logger.clone.tap do |l|
+            l.level = Logger::WARN
+          end
+        end
+        ActiveSupport.on_load(:action_cable_connection) do
+          prepend LogSanity::Extensions::ActionCableConnection
+        end
+
+        LogSanity::LogSubscriber::ActionCable.attach_to :action_cable
         LogSanity::LogSubscriber::ActionController.attach_to :action_controller
         LogSanity::LogSubscriber::ActionDispatch.attach_to :action_dispatch
         LogSanity::LogSubscriber::ActionMailer.attach_to :action_mailer

data/lib/log_sanity/version.rb

@@ -1,3 +1,3 @@
 module LogSanity
-  VERSION = '1.0.0'
+  VERSION = '1.2.0'
 end

data/lib/log_sanity.rb

@@ -1,12 +1,14 @@
 %w( formatter
     railtie
     log_subscribers/base
+    log_subscribers/action_cable
     log_subscribers/action_controller
     log_subscribers/action_dispatch
     log_subscribers/action_mailer
     log_subscribers/active_job
     middleware/request_logger
     middleware/routing_error_catcher
+    extensions/action_cable_connection
     extensions/action_controller_helper 
     extensions/active_support_subscriber
   ).each do |fn|

data/log_sanity.gemspec

@@ -17,5 +17,5 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ["lib"]
 
-  s.add_dependency 'rails', '>= 5.2', '< 6.2'
+  s.add_dependency 'rails', '>= 5.2', '< 7.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: log_sanity
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - thomas morgan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-29 00:00:00.000000000 Z
+date: 2022-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,7 +19,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.2'
+        version: '7.1'
 description: LogSanity - Bring sanity to Rails logs by reducing verbosity, using json
   output, and more.
 email:
@@ -45,9 +45,11 @@ files:
 - README.md
 - Rakefile
 - lib/log_sanity.rb
+- lib/log_sanity/extensions/action_cable_connection.rb
 - lib/log_sanity/extensions/action_controller_helper.rb
 - lib/log_sanity/extensions/active_support_subscriber.rb
 - lib/log_sanity/formatter.rb
+- lib/log_sanity/log_subscribers/action_cable.rb
 - lib/log_sanity/log_subscribers/action_controller.rb
 - lib/log_sanity/log_subscribers/action_dispatch.rb
 - lib/log_sanity/log_subscribers/action_mailer.rb
@@ -121,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: LogSanity - Bring sanity to Rails logs