log_sanity 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b955406c6e0a56ba3242cef72764433a08abc54fa8e0b0241eb85ed3038f5b2
-  data.tar.gz: d663a844b8eb827ff0f7693386b7c48e13ab609c1b229978d5626d41b4c4c6f7
+  metadata.gz: bddde1806a3f446baf620b17fa996ba29cbe75488577e72a1a3fc865332cf931
+  data.tar.gz: af41ffa35843b478b464007c08e53531ac24259ac4fb4519d75f783e33abc6c4
 SHA512:
-  metadata.gz: ebf2265262ef180c669376798887e66e92176e07fcc725f8ccfc6bdf0e642c450363d0214f0aed8519c9e1ac7369ac117e6f8ceb2f2d88cdf3da9d12bc17616b
-  data.tar.gz: d1eaf205cd088590de19326404fc59eb076a8cd6d9d8c3dc777a1fa681d017d213cc5796c43f88efba8a8ebc52e875bf39fd5e63da3d72ffdb82111d9c23c2a2
+  metadata.gz: 5ef34565a72c61fd99c4d23bc7033fb9c06cd90cbf6d98a7d81ad792c06f54d191e50dd26edd78e2fc9864d125da0cabfc296b1ef821bd5fddba313ee120819d
+  data.tar.gz: 65088f0e38663f5f813ed0c05e21330fc519cbc5181ef003292613418bdd219c9f1c5f6fd519c50a5ea6733e08f69f182e1440ca194148c0506b1c180693d2fe

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+#### 1.3.1
+
+- Handle updated show_exceptions values in Rails 7.1
+
+#### 1.3.0
+
+- Fix timing of gem initialization
+- Support Rails 7.1
+- Ensure ActionCable's logger level isn't made more permissive
+
+#### 1.2.0
+
+- Add support for ActionCable logs
+- Fix :at on Rails 7
+
+#### 1.1.1
+
+- Support Rails 7.0
+
+#### 1.1.0
+
+- Include tags when rendering formatted strings
+- Preserve string_formatter as disabled
+- Place :at at the front of messages
+
+#### 1.0.0 and prior
+
+(see git history)

data/Gemfile.lock

@@ -1,142 +1,159 @@
 PATH
   remote: .
   specs:
-    log_sanity (1.2.0)
-      rails (>= 5.2, < 7.1)
+    log_sanity (1.3.1)
+      rails (>= 5.2, < 7.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.1.4.6)
-      actionpack (= 6.1.4.6)
-      activesupport (= 6.1.4.6)
+    actioncable (7.0.5)
+      actionpack (= 7.0.5)
+      activesupport (= 7.0.5)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    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)
+    actionmailbox (7.0.5)
+      actionpack (= 7.0.5)
+      activejob (= 7.0.5)
+      activerecord (= 7.0.5)
+      activestorage (= 7.0.5)
+      activesupport (= 7.0.5)
       mail (>= 2.7.1)
-    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)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.5)
+      actionpack (= 7.0.5)
+      actionview (= 7.0.5)
+      activejob (= 7.0.5)
+      activesupport (= 7.0.5)
       mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (6.1.4.6)
-      actionview (= 6.1.4.6)
-      activesupport (= 6.1.4.6)
-      rack (~> 2.0, >= 2.0.9)
+    actionpack (7.0.5)
+      actionview (= 7.0.5)
+      activesupport (= 7.0.5)
+      rack (~> 2.0, >= 2.2.4)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.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)
+    actiontext (7.0.5)
+      actionpack (= 7.0.5)
+      activerecord (= 7.0.5)
+      activestorage (= 7.0.5)
+      activesupport (= 7.0.5)
+      globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (6.1.4.6)
-      activesupport (= 6.1.4.6)
+    actionview (7.0.5)
+      activesupport (= 7.0.5)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.1.4.6)
-      activesupport (= 6.1.4.6)
+    activejob (7.0.5)
+      activesupport (= 7.0.5)
       globalid (>= 0.3.6)
-    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)
+    activemodel (7.0.5)
+      activesupport (= 7.0.5)
+    activerecord (7.0.5)
+      activemodel (= 7.0.5)
+      activesupport (= 7.0.5)
+    activestorage (7.0.5)
+      actionpack (= 7.0.5)
+      activejob (= 7.0.5)
+      activerecord (= 7.0.5)
+      activesupport (= 7.0.5)
+      marcel (~> 1.0)
       mini_mime (>= 1.1.0)
-    activesupport (6.1.4.6)
+    activesupport (7.0.5)
       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.9)
+    concurrent-ruby (1.2.2)
     crass (1.0.6)
-    erubi (1.10.0)
-    globalid (1.0.0)
+    date (3.3.3)
+    erubi (1.12.0)
+    globalid (1.1.0)
       activesupport (>= 5.0)
-    i18n (1.10.0)
+    i18n (1.13.0)
       concurrent-ruby (~> 1.0)
-    loofah (2.14.0)
+    loofah (2.21.3)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.1)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
       mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
     marcel (1.0.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    minitest (5.15.0)
-    nio4r (2.5.8)
-    nokogiri (1.13.3-x86_64-darwin)
+    minitest (5.18.0)
+    net-imap (0.3.4)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.1)
+      timeout
+    net-smtp (0.3.3)
+      net-protocol
+    nio4r (2.5.9)
+    nokogiri (1.15.2-arm64-darwin)
       racc (~> 1.4)
-    racc (1.6.0)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    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)
+    racc (1.6.2)
+    rack (2.2.7)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (7.0.5)
+      actioncable (= 7.0.5)
+      actionmailbox (= 7.0.5)
+      actionmailer (= 7.0.5)
+      actionpack (= 7.0.5)
+      actiontext (= 7.0.5)
+      actionview (= 7.0.5)
+      activejob (= 7.0.5)
+      activemodel (= 7.0.5)
+      activerecord (= 7.0.5)
+      activestorage (= 7.0.5)
+      activesupport (= 7.0.5)
       bundler (>= 1.15.0)
-      railties (= 6.1.4.6)
-      sprockets-rails (>= 2.0.0)
+      railties (= 7.0.5)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
-      loofah (~> 2.3)
-    railties (6.1.4.6)
-      actionpack (= 6.1.4.6)
-      activesupport (= 6.1.4.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.0.5)
+      actionpack (= 7.0.5)
+      activesupport (= 7.0.5)
       method_source
-      rake (>= 0.13)
+      rake (>= 12.2)
       thor (~> 1.0)
+      zeitwerk (~> 2.5)
     rake (13.0.6)
-    sprockets (4.0.2)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.4.2)
-      actionpack (>= 5.2)
-      activesupport (>= 5.2)
-      sprockets (>= 3.0.0)
-    thor (1.2.1)
-    tzinfo (2.0.4)
+    thor (1.2.2)
+    timeout (0.3.2)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.5.4)
+    zeitwerk (2.6.8)
 
 PLATFORMS
+  arm64-darwin
   ruby
+  x86_64-darwin
+  x86_64-linux
 
 DEPENDENCIES
   log_sanity!
 
 BUNDLED WITH
-   2.2.22
+   2.3.26

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2017-2022 thomas morgan
+Copyright 2017-2023 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

@@ -10,7 +10,7 @@ However, just because the primary output is a single line doesn't make it a one-
 
 Example output: (Multi-line and extra whitespace added for readability; normally all one line.)
 
-```
+```json
 { "at" : "2017-01-18T00:27:50.947Z",
   "event" : "https_get",
   "ip" : "127.0.0.1",
@@ -28,12 +28,12 @@ Example output: (Multi-line and extra whitespace added for readability; normally
 ### Installation
 
 Install the usual way:
-```
+```ruby
 gem 'log_sanity'
 ```
 
 By default, LogSanity does not enable itself. To do so, in `config/environments/production.rb` add:
-```
+```ruby
 config.logsanity.enabled = true
 config.log_level = :info
 ```
@@ -41,16 +41,27 @@ config.log_level = :info
 You can go less verbose than `:info` (say, `:warn`), but more verbose (ie: `:debug`) is not recommended.
 
 
+##### A note on initialization order
+
+LogSanity initializes after running `application.rb` and `config/environments/*.rb`, but before `config/initializers/*.rb`. Most `config.logsanity.*` settings must be in one of the former or they will be ignored (`config.logsanity.silence_paths` being an exception).
+
+However, `initializers/*.rb` may be used to reduce the scope of what's logged. For example, to skip logging of ActiveJob requests only:
+```ruby
+# initializers/logsanity.rb
+LogSanity::LogSubscriber::ActiveJob.detach_from :active_job
+```
+
+
 ### Usage
 
-Basic usage may require nothing more than enable LogSanity as outlined above. Some common configuration settings include silencing logging for certain paths (like health checks) or adding information about the currently authenticated user.
+Basic usage may require nothing more than enabling LogSanity as outlined above. Some common configuration settings include silencing logging for certain paths (like health checks) or adding information about the currently authenticated user.
 
 ##### Adding attributes
 
 The most common way to add attributes is via controllers. Helper methods are provided for this. For example, to log the current user's ID, you might add the following to `application_controller.rb`:
 
-```
-after_filter do
+```ruby
+after_action do
   if current_user
     log_field 'user', current_user.id
   end
@@ -58,14 +69,14 @@ end
 ```
 
 The syntax is simply `log_field(key, value)`. Since the output is JSON, `value` can even be a hash or array:
-```
+```ruby
 log_field 'user', {id: current_user.id, name: current_user.name}
 ```
 
 You can log multiple fields by calling `log_field` multiple times.
 
 If you must, you can get to the full fields hash:
-```
+```ruby
 LogSanity.fields['user'] ||= {}
 LogSanity.fields['user']['id'] = current_user.id
 ```
@@ -76,7 +87,7 @@ It's also possible to add attributes via Rails' existing `log_tags` facility, wh
 ##### Logging complete entries
 
 To log a complete event (a complete log entry), try something like:
-```
+```ruby
 logger.info 'event'=>'user_signup', 'source'=>'ppc', 'campaign'=>'awesomeness', 'rq'=>request.uuid, 'user'=>current_user.id
 ```
 
@@ -86,13 +97,13 @@ If you pass in a hash to any `logger` method, it automatically becomes JSON outp
 
 ### Configuration options
 
-While the above cover most of it, there are a handful of other potentially useful settings.
+While the above covers most of it, there are a handful of other potentially useful settings.
 
 ##### Silence logging for certain paths
 
-This is particularly useful if you have any kind of health check path, as there's no need to fill up log files with that stuff.
+This is particularly useful if you have any kind of health check path, as there's no need to fill up log files with that stuff. Both exact strings and regexps are supported.
 
-```
+```ruby
 config.logsanity.silence_paths += ["/health", %r{^/healthcheck}]
 ```
 
@@ -103,7 +114,7 @@ Both exact path matches (Strings) and Regex's are supported.
 
 By default, strings are logged as-is and not stuck inside a JSON object. If you prefer the opposite:
 
-```
+```ruby
 config.logsanity.json_strings = true
 ```
 
@@ -112,7 +123,7 @@ With `json_strings` as `false` (default), `logger.info "This is fantastic!"` wou
 This is fantastic!
 ```
 However, if `true`, you'll see:
-```
+```json
 {"at":"2017-01-18T00:27:50.947Z","message":"This is fantastic!"}
 ```
 
@@ -121,7 +132,7 @@ However, if `true`, you'll see:
 
 When LogSanity initializes, it replaces the Rails log formatter with its own, but saves the old one for outputting strings (assuming `json_strings` is `false`). This means you can still configure the formatting of those. For example, to use Logger's default formatting (instead of Rails' default):
 
-```
+```ruby
 config.log_formatter = ::Logger::Formatter.new
 ```
 
@@ -130,7 +141,7 @@ config.log_formatter = ::Logger::Formatter.new
 
 As noted above, you can either add extra attributes directly or via `log_tags`. We discussed direct already. Now let's take a look at tagged logging, which is a bit different in a JSON world.
 
-```
+```ruby
 config.log_tags = [ :subdomain ]
 ```
 
@@ -144,7 +155,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).
 
 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):
-```
+```ruby
 config.logger = ActiveSupport::Logger.new(STDOUT)
 ```
 
@@ -172,7 +183,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 7.0 (or later). Anything older is untested. Small patches for older compatibility will be considered.
+Tested on Rails 5.2 through 7.1 (or later). Anything older is untested. Small patches for older compatibility will be considered.
 
 License: MIT
 

data/lib/log_sanity/middleware/routing_error_catcher.rb

@@ -19,10 +19,20 @@ module LogSanity
 
       response
     rescue ActionController::RoutingError => exception
-      if request.show_exceptions?
-        render_exception(request, exception)
+      if Rails.version >= '7.1'
+        backtrace_cleaner = request.get_header('action_dispatch.backtrace_cleaner')
+        wrapper = ActionDispatch::ExceptionWrapper.new(backtrace_cleaner, exception)
+        if wrapper.show?(request)
+          render_exception(request, wrapper)
+        else
+          raise exception
+        end
       else
-        raise exception
+        if request.show_exceptions?
+          render_exception(request, exception)
+        else
+          raise exception
+        end
       end
     end
 

data/lib/log_sanity/railtie.rb

@@ -5,7 +5,14 @@ module LogSanity
     config.logsanity.json_strings  = false
     config.logsanity.silence_paths = []
 
-    initializer "log_sanity.configure" do |app|
+    initializer "log_sanity.extensions" do
+      ActiveSupport.on_load(:action_controller) do
+        # runs for each of AC::Base, AC::API
+        include LogSanity::Extensions::ActionControllerHelper
+      end
+    end
+
+    initializer "log_sanity.configure", before: :load_config_initializers do |app|
       app.config.log_tags ||= []
       if app.config.logsanity.enabled
         orig_formatter = Rails.logger.formatter
@@ -51,8 +58,10 @@ module LogSanity
 
         ActiveSupport.on_load(:action_cable) do
           orig_logger = logger || Rails.logger
-          self.logger = orig_logger.clone.tap do |l|
-            l.level = Logger::WARN
+          if orig_logger.level < Logger::WARN
+            self.logger = orig_logger.clone.tap do |l|
+              l.level = Logger::WARN
+            end
           end
         end
         ActiveSupport.on_load(:action_cable_connection) do

data/lib/log_sanity/version.rb

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

data/lib/log_sanity.rb

@@ -9,14 +9,12 @@
     middleware/request_logger
     middleware/routing_error_catcher
     extensions/action_cable_connection
-    extensions/action_controller_helper 
+    extensions/action_controller_helper
     extensions/active_support_subscriber
   ).each do |fn|
   require_relative "log_sanity/#{fn}"
 end
 
-ActionController::Base.include LogSanity::Extensions::ActionControllerHelper
-ActionController::API.include  LogSanity::Extensions::ActionControllerHelper if defined?(ActionController::API)
 if Rails.version < '6'
   ActiveSupport::Subscriber.include LogSanity::Extensions::ActiveSupportSubscriber
 end

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', '< 7.1'
+  s.add_dependency 'rails', '>= 5.2', '< 7.2'
 end

data/test/dummy/config/application.rb

@@ -5,7 +5,6 @@ require File.expand_path('../boot', __FILE__)
 require "action_controller/railtie"
 require "action_mailer/railtie"
 require "action_view/railtie"
-require "sprockets/railtie"
 require "rails/test_unit/railtie"
 
 Bundler.require(*Rails.groups)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: log_sanity
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - thomas morgan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-13 00:00:00.000000000 Z
+date: 2023-05-27 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: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 description: LogSanity - Bring sanity to Rails logs by reducing verbosity, using json
   output, and more.
 email:
@@ -39,6 +39,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -85,7 +86,6 @@ files:
 - test/dummy/config/environments/development.rb
 - test/dummy/config/environments/production.rb
 - test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/assets.rb
 - test/dummy/config/initializers/backtrace_silencers.rb
 - test/dummy/config/initializers/cookies_serializer.rb
 - test/dummy/config/initializers/filter_parameter_logging.rb
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: LogSanity - Bring sanity to Rails logs
@@ -152,7 +152,6 @@ test_files:
 - test/dummy/config/environments/development.rb
 - test/dummy/config/environments/production.rb
 - test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/assets.rb
 - test/dummy/config/initializers/backtrace_silencers.rb
 - test/dummy/config/initializers/cookies_serializer.rb
 - test/dummy/config/initializers/filter_parameter_logging.rb

data/test/dummy/config/initializers/assets.rb

@@ -1,11 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# Version of your assets, change this if you want to expire all your assets.
-Rails.application.config.assets.version = '1.0'
-
-# Add additional assets to the asset load path
-# Rails.application.config.assets.paths << Emoji.images_path
-
-# Precompile additional assets.
-# application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
-# Rails.application.config.assets.precompile += %w( search.js )