ezlog 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a2b7013c5c263e56e4531fc3e1fd0d70d5e9ec4f807babd2a95d3c68a66d365
-  data.tar.gz: 3684e63ae988f43c40291383e5c62b36e7907d0c3a377022616c70fe08a8550f
+  metadata.gz: 1060267c8ecacef2fc5c231f9287f09b4b36e9ad7fc536199e2458eb5f56d275
+  data.tar.gz: 4d176d6aeb4192fe42240a2a23e0ac0c1c2f4c15487ac8371a22d8907ea123e6
 SHA512:
-  metadata.gz: 9279792e2f20e69fc8594d7034557ba742e708a3140f78ea8439f2c78bf4bd4e303d36215edfd30fc4ca1d9d868f1e61aac1f3fe805145d17e59f6df39d9d913
-  data.tar.gz: a6400bdc976110d23a3aba7df254314950c326846805601778c192d7a5ceaa37c94a12d414e38654f6627954f92dab51e9017ce864c70dbc064b1d4b491540e1
+  metadata.gz: dd779463c0f5a50955f01c7eaf6cf7c90d0668e9c4d9cc49c4b676cff5508f10cfb2e6ed3b28f922f67bd1eab38fc393052ce72ef57a7b69d3daaeb2b62cadac
+  data.tar.gz: 29acb94a878f3aaa7f96c1b806aede63473d5b5a288eece64b7b2d7082ef1d56aacfc31c10a70399152d4a4afef1338799a9a24caa5d4b82078fe65726a9548a

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 0.9.0 (2020-05-10)
+
+[Full Changelog](https://github.com/emartech/ezlog/compare/v0.8.0...v0.9.0)
+
+* Features & enhancements
+  * Ezlog now supports [Rails](https://rubyonrails.org/) 6.
+  * Added the ability to exclude certain paths from access logging. Use the `exclude_paths` configuration option to
+    add paths (strings or regexps) to exclude from your access logs.
+
 ### 0.8.0 (2020-04-07)
 
 [Full Changelog](https://github.com/emartech/ezlog/compare/v0.7.1...v0.8.0)

data/README.md

@@ -6,7 +6,7 @@
 Ezlog is intended to be a zero-configuration structured logging setup for pure Ruby or [Ruby on Rails](https://rubyonrails.org/) 
 projects using any (or all) of the following libraries or frameworks:
 
-* [Ruby on Rails](https://rubyonrails.org/)
+* [Ruby on Rails](https://rubyonrails.org/) (5.x and 6.x supported)
 * [Sidekiq](https://github.com/mperham/sidekiq)
 * [Sequel](https://sequel.jeremyevans.net/) 
 * [Rack::Timeout](https://github.com/heroku/rack-timeout)
@@ -134,6 +134,12 @@ Using this configuration, Ezlog will only log the `action` parameter under the `
 all parameters serialized into a single string under the key `params_serialized`. You won't lose any information,
 but you can make sure that only the relevant parameters of your requests are searchable (and thus protect your logs).
 
+Should you want to exclude certain paths (e.g. a healthcheck URL) from your access logs, you can use the following option:
+
+```ruby
+config.ezlog.exclude_paths = ['/healthcheck', %r(/monitoring/.*)]  # default is empty so everything gets logged
+```
+
 #### The log level
 
 The logger's log level is determined as follows (in order of precedence):

data/ezlog.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "logging", "~> 2.0"
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "sidekiq", ">= 5.0"
   spec.add_development_dependency "sequel", "~> 5.0"

data/lib/ezlog/rails/access_log.rb

@@ -3,10 +3,10 @@ module Ezlog
     class AccessLog
       include LogContextHelper
 
-      def initialize(app, logger, whitelisted_params)
+      def initialize(app, logger, config)
         @app = app
         @logger = logger
-        @whitelisted_params = whitelisted_params&.map &:to_s
+        @config = config
       end
 
       def call(env)
@@ -29,23 +29,29 @@ module Ezlog
       end
 
       def log_request(request, status)
+        return if path_ignored?(request)
+
         message = {
           message: '%s %s - %i (%s)' % [request.method, request.filtered_path, status, Rack::Utils::HTTP_STATUS_CODES[status]],
           remote_ip: request.remote_ip,
           method: request.method,
           path: request.filtered_path,
-          params: params_to_log_in(request),
+          params: params_to_log(request),
           response_status_code: status
         }
-        message.merge! params_serialized: request.filtered_parameters.inspect if @whitelisted_params
+        message.merge! params_serialized: request.filtered_parameters.inspect if @config.log_only_whitelisted_params
         @logger.info message
       end
 
-      def params_to_log_in(request)
-        if @whitelisted_params.nil?
-          request.filtered_parameters
+      def path_ignored?(request)
+        @config.exclude_paths.any? { |pattern| pattern.match? request.path }
+      end
+
+      def params_to_log(request)
+        if @config.log_only_whitelisted_params
+          request.filtered_parameters.slice *@config.whitelisted_params&.map(&:to_s)
         else
-          request.filtered_parameters.slice *@whitelisted_params
+          request.filtered_parameters
         end
       end
     end

data/lib/ezlog/railtie.rb

@@ -4,6 +4,7 @@ module Ezlog
     config.ezlog.enable_sequel_logging = false
     config.ezlog.log_only_whitelisted_params = false
     config.ezlog.whitelisted_params = [:controller, :action]
+    config.ezlog.exclude_paths = []
 
     initializer "ezlog.initialize" do
       require "ezlog/rails/extensions"
@@ -29,16 +30,26 @@ module Ezlog
     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.insert_before ::ActionDispatch::DebugExceptions, Ezlog::Rails::AccessLog, Ezlog.logger('AccessLog'), whitelisted_params(app)
+      app.config.middleware.insert_before ::ActionDispatch::DebugExceptions, Ezlog::Rails::AccessLog, Ezlog.logger('AccessLog'), config.ezlog
       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
-      if defined? ::ActiveRecord
-        Ezlog::Rails::LogSubscriber.detach ::ActiveRecord::LogSubscriber
-        Ezlog::Rails::LogSubscriber.attach Ezlog::Rails::ActiveRecord::LogSubscriber, :active_record
+      case ::Rails::VERSION::MAJOR
+      when 6
+        ::ActionController::LogSubscriber.detach_from :action_controller
+        ::ActionView::LogSubscriber.detach_from :action_view
+        if defined? ::ActiveRecord
+          ::ActiveRecord::LogSubscriber.detach_from :active_record
+          Ezlog::Rails::LogSubscriber.attach Ezlog::Rails::ActiveRecord::LogSubscriber, :active_record
+        end
+      else
+        Ezlog::Rails::LogSubscriber.detach ::ActionController::LogSubscriber
+        Ezlog::Rails::LogSubscriber.detach ::ActionView::LogSubscriber
+        if defined? ::ActiveRecord
+          Ezlog::Rails::LogSubscriber.detach ::ActiveRecord::LogSubscriber
+          Ezlog::Rails::LogSubscriber.attach Ezlog::Rails::ActiveRecord::LogSubscriber, :active_record
+        end
       end
     end
 
@@ -62,9 +73,5 @@ module Ezlog
     def disable_rack_timeout_logging
       ::Rack::Timeout::Logger.logger = ::Logger.new(nil)
     end
-
-    def whitelisted_params(app)
-      app.config.ezlog.log_only_whitelisted_params ? app.config.ezlog.whitelisted_params : nil
-    end
   end
 end

data/lib/ezlog/version.rb

@@ -1,3 +1,3 @@
 module Ezlog
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezlog
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Zoltan Ormandi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-07 00:00:00.000000000 Z
+date: 2020-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -42,16 +42,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement