ezlog 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af49b0170f9c53fe3f0b41ced3fd1afe3a420402bbb64b62318bda81144d8c23
-  data.tar.gz: 6c85e8f81ee2848bba6ad407aafbf0ce8b567523801cf133ac3fa795fbb6b14c
+  metadata.gz: 93492a6b3f140b41d4aad461fcb7bd9017149c3bca1a0d19a9edf5e2ed9fc25d
+  data.tar.gz: bddac2fcd0e1ef426f228e97bb537a34704d102d8f480cee872be74e505aefcc
 SHA512:
-  metadata.gz: a7917365ade7f63164081e865efbcbac0b3f71e26f77abd0a2f32e0c15f2ca4465aabb55db07c64ab20c05ed089525e31319e89ef946e91394a51d73f8dc98da
-  data.tar.gz: 631f9ff0ef37d8fb1250e3713f8322e262d2e5366e1e46fa48da522b296cd3cf8445723fdc42f33ef039ad5ccdc2d32bebfaa1dd53749957b663d7f1206e06fd
+  metadata.gz: 22f5427eaa445d7189140bb98bf1206f2e5b0dd0b1df8d1f1ec12af01a2472dea1006422b69e50d28bf7c87dd9f2002ee29ba7a8dcdbccceea6cb3c65ff60080
+  data.tar.gz: 8c0c3f28b548609c667f7e4b1d610a50a9a44a114b05a66dfaef9901d6f252e564eb6458ae4808c5154c759e685dd44b368b984a076ad1b9b7a53a75a555ae89

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+### 0.3.1 (2019-06-09)
+
+[Full Changelog](https://github.com/emartech/ezlog/compare/v0.2.2...v0.3.1)
+
+* Features & enhancements
+  * Unified access log for Rails
+    * 1 message per request
+    * Includes request ID, parameters, response code
+  * Non-verbose logging of uncaught exceptions in Rails apps
+    * 1 message per error
+    * Use ERROR level instead of FATAL
+  * [Rack::Timeout](https://github.com/heroku/rack-timeout) logging is now completely turned off, because Timeout errors 
+    are handled by the application's error logger and we don't want duplicated log messages 
+
+* Bug fixes
+  * Fix bug where the application log level wasn't set to INFO by default but remained on DEBUG
+
 ### 0.2.2 (2019-05-19)
 
 [Full Changelog](https://github.com/emartech/ezlog/compare/v0.2.1...v0.2.2)

data/README.md

@@ -3,31 +3,41 @@
 [![Gem Version](https://badge.fury.io/rb/ezlog.svg)](https://badge.fury.io/rb/ezlog)
 [![Build Status](https://travis-ci.com/emartech/ezlog.svg?branch=master)](https://travis-ci.com/emartech/ezlog)
 
-Ezlog is intended to be a zero-configuration logging setup for pure Ruby or Rails projects using 
-[Sidekiq](https://github.com/mperham/sidekiq), [Rack::Timeout](https://github.com/heroku/rack-timeout),
-[Sequel](https://sequel.jeremyevans.net/), etc. It uses Tim Pease's wonderful [Logging](https://github.com/TwP/logging)
-gem for an all-purpose logging solution.
+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/)
+* [Sidekiq](https://github.com/mperham/sidekiq)
+* [Sequel](https://sequel.jeremyevans.net/) 
+* [Rack::Timeout](https://github.com/heroku/rack-timeout)
+
+It uses Tim Pease's wonderful [Logging](https://github.com/TwP/logging) gem for an all-purpose structured logging solution.
 
 Ezlog's purpose is threefold:
-1. Make sure that our applications are logging in a sensible manner; emitting no unnecessary "noise" but containing all 
-relevant and necessary information (like timing).
+1. Make sure that our applications are logging in a concise and sensible manner; emitting no unnecessary "noise" but 
+   containing all relevant and necessary information (like timing).
 2. Make sure that all log messages are written to STDOUT in a machine-processable format (JSON) across all of our projects.
-3. Achieving the above goal should require no configuration in the projects where the library is used.
+3. Achieving the above goals should require no configuration in the projects where the library is used.
 
 ## Installation
 
+#### Rails
+
 Add this line to your application's Gemfile:
 
 ```ruby
 gem 'ezlog'
 ```
 
+That's it. Everything else is automatically configured.
+
 ## What it does
 
 * Initializes the [Logging](https://github.com/TwP/logging) library
 * Configures Rails logging
 * Configures Sidekiq logging
 * Configures Rack::Timeout logging
+* Provides testing support for [RSpec](https://rspec.info/)
 
 #### Initializes the Logging library
 
@@ -64,8 +74,39 @@ logger.error ex
 
 Ezlog configures the `Rails.logger` to be an instance of a [Logging](https://github.com/TwP/logging) logger by the name 
 of `Application`, behaving as described above. The logger uses the log level set in `application.rb` (if present) or 
-uses INFO as a default log level. It also adds the environment (`Rails.env`) to the logger's initial context, meaning
-it will automatically be appended to all log messages emitted by the application.
+uses INFO as a default log level.
+
+In addition to this, Ezlog also does the following:
+* It adds the environment (`Rails.env`) to the logger's initial context, so it will automatically be appended to all log messages 
+  emitted by the application.
+* It disables Rails's default (verbose) logging of uncaught errors and injects its own error logger into the application, which
+  * logs 1 line per error, including the error's name and context (stack trace, etc.),
+  * logs every error at ERROR level instead of the default FATAL.
+* It disables Rails's default (verbose) request logging, which logs several lines per event during the processing of an action
+  and replaces the default Rack access log with its own access log middleware. The end result is an access log, which
+  * contains all relevant information (request ID, method, path, params, client IP, duration and response status code), and
+  * has 1 log line per request, logged at the end of the request.
+
+Thanks to Mathias Meyer for writing [Lograge](https://github.com/roidrage/lograge), which inspired the solution. 
+If Ezlog's not your cup of tea but you're looking for a way to tame Rails's logging then be sure to check out
+[Lograge](https://github.com/roidrage/lograge). 
+
+```
+GET /welcome?subsession_id=34ea8596f9764f475f81158667bc2654
+
+With default Rails logging:
+
+Started GET "/welcome?subsession_id=34ea8596f9764f475f81158667bc2654" for 127.0.0.1 at 2019-06-08 08:49:31 +0200
+Processing by PagesController#welcome as HTML
+  Parameters: {"subsession_id"=>"34ea8596f9764f475f81158667bc2654"}
+  Rendering pages/welcome.html.haml within layouts/application
+  Rendered pages/welcome.html.haml within layouts/application (5.5ms)
+Completed 200 OK in 31ms (Views: 27.3ms | ActiveRecord: 0.0ms)
+
+With Ezlog:
+
+{"logger":"AccessLog","timestamp":"2019-06-08T08:49:31+02:00","level":"INFO","hostname":"MacbookPro.local","pid":75463,"environment":"development","request_id":"9a43631b-284c-4677-9d08-9c1cc5c7d3a7","duration_sec":0.031,"message":"GET /welcome?subsession_id=34ea8596f9764f475f81158667bc2654 - 200 (OK)","remote_ip":"127.0.0.1","method":"GET","path":"/welcome?subsession_id=34ea8596f9764f475f81158667bc2654","params":{"subsession_id":"34ea8596f9764f475f81158667bc2654","controller":"pages","action":"welcome"},"response_status_code":200}
+```
 
 #### Configures Sidekiq logging
 
@@ -97,8 +138,38 @@ TestWorker.perform_async 42
 #### Configures Rack::Timeout logging
 
 [Rack::Timeout](https://github.com/heroku/rack-timeout) is a very useful tool for people running services on Heroku
-but it is way too verbose by default. What Ezlog does is simply reconfigure its logging to use Ezlog's logging
-mechanism and to only output messages at or above WARN level. 
+but it is way too verbose by default and all of its important messages (i.e. Timeout errors) are logged by the application
+as well. For this reason, Ezlog turns off [Rack::Timeout](https://github.com/heroku/rack-timeout) logging completely. 
+
+#### Provides testing support for RSpec
+
+Ezlog comes with built-in support for testing your logging activity using [RSpec](https://rspec.info/).
+To enable spec support for Ezlog, put this line in your `spec_helper.rb` or `rails_helper.rb`:
+```ruby
+require "ezlog/rspec"
+```
+
+What you get:
+* Helpers
+  * `log_output` provides access to the complete log output in your specs
+  * `log_output_is_expected` shorthand for writing expectations for the log output
+* Matchers
+  * `include_log_message` matcher for expecting a certain message in the log output
+  * `log` matcher for expecting an operation to log a certain message
+
+```ruby
+# Check that the log contains a certain message
+expect(log_output).to include_log_message message: 'Test message'
+log_output_is_expected.to include_log_message message: 'Test message'
+
+# Check that the message is not present in the logs before the operation but is present after it 
+expect { operation }.to log message: 'Test message', 
+                            user_id: 123456 
+
+# Expect a certain log level
+log_output_is_expected.to include_log_message(message: 'Test message').at_level(:info)
+expect { operation }.to log(message: 'Test message').at_level(:info)
+```
 
 ## Disclaimer
 

data/ezlog.gemspec

@@ -23,10 +23,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "logging", "~> 2.0"
-  spec.add_dependency "multi_json"
 
   spec.add_development_dependency "bundler", "~> 2.0"
   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 "actionpack", "~> 5.0"
 end

data/lib/ezlog.rb

@@ -6,9 +6,10 @@ require 'ezlog/railtie' if defined? Rails
 module Ezlog
   autoload :LogContextHelper, 'ezlog/log_context_helper'
   autoload :LoggingLayout, 'ezlog/logging_layout'
+  autoload :Rails, 'ezlog/rails'
   autoload :Sidekiq, 'ezlog/sidekiq'
 
   def self.logger(name)
-    Logging::Logger[name]
+    ::Logging::Logger[name]
   end
 end

data/lib/ezlog/logging_layout.rb

@@ -1,5 +1,5 @@
 require 'time'
-require 'multi_json'
+require 'json'
 
 module Ezlog
   class LoggingLayout < ::Logging::Layout
@@ -12,7 +12,7 @@ module Ezlog
       add_initial_context_to log_entry
       add_logging_context_to log_entry
       add_event_information_to log_entry, event
-      ::MultiJson.dump(log_entry) + "\n"
+      ::JSON.dump(log_entry) + "\n"
     end
 
     private

data/lib/ezlog/rails.rb

@@ -0,0 +1,12 @@
+require "action_controller"
+require "action_controller/log_subscriber"
+
+module Ezlog
+  module Rails
+    autoload :AccessLog, 'ezlog/rails/access_log'
+    autoload :DebugExceptions, 'ezlog/rails/debug_exceptions'
+    autoload :LogExceptions, 'ezlog/rails/log_exceptions'
+    autoload :RequestLogContext, 'ezlog/rails/request_log_context'
+    autoload :LogSubscriber, 'ezlog/rails/log_subscriber'
+  end
+end

data/lib/ezlog/rails/access_log.rb

@@ -0,0 +1,37 @@
+module Ezlog
+  module Rails
+    class AccessLog
+      include LogContextHelper
+
+      def initialize(app, logger)
+        @app = app
+        @logger = logger
+      end
+
+      def call(env)
+        status, headers, body_lines = benchmark { @app.call(env) }
+        log_request ActionDispatch::Request.new(env), status
+        [status, headers, body_lines]
+      end
+
+      private
+
+      def benchmark
+        start_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+        yield
+      ensure
+        end_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
+        add_to_log_context duration_sec: (end_time - start_time).round(3)
+      end
+
+      def log_request(request, status)
+        @logger.info 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: request.filtered_parameters,
+                     response_status_code: status
+      end
+    end
+  end
+end

data/lib/ezlog/rails/debug_exceptions.rb

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

data/lib/ezlog/rails/log_exceptions.rb

@@ -0,0 +1,17 @@
+module Ezlog
+  module Rails
+    class LogExceptions
+      def initialize(app, logger)
+        @app = app
+        @logger = logger
+      end
+
+      def call(env)
+        @app.call(env)
+      rescue Exception => exception
+        @logger.error exception
+        raise
+      end
+    end
+  end
+end

data/lib/ezlog/rails/log_subscriber.rb

@@ -0,0 +1,16 @@
+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
+
+        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
+    end
+  end
+end

data/lib/ezlog/rails/request_log_context.rb

@@ -0,0 +1,17 @@
+module Ezlog
+  module Rails
+    class RequestLogContext
+      include LogContextHelper
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        within_log_context request_id: env['action_dispatch.request_id'] do
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/ezlog/railtie.rb

@@ -2,8 +2,8 @@ module Ezlog
   class Railtie < Rails::Railtie
     initializer 'ezlog.configure_logging' do |app|
       ::Logging.logger.root.appenders = ::Logging.appenders.stdout 'stdout',
-                                                                   layout: Ezlog::LoggingLayout.new(environment: Rails.env),
-                                                                   level: app.config.log_level || :info
+                                                                   layout: Ezlog::LoggingLayout.new(environment: ::Rails.env),
+                                                                   level: app.config.log_level
     end
 
     initializer 'ezlog.configure_sidekiq_logging' do
@@ -11,11 +11,24 @@ module Ezlog
     end
 
     initializer 'ezlog.configure_rack_timeout_logging' do
-      initialize_rack_timeout_logging if defined? ::Rack::Timeout
+      disable_rack_timeout_logging if defined? ::Rack::Timeout
+    end
+
+    initializer 'ezlog.configure_middlewares' do |app|
+      app.config.middleware.insert_after ::ActionDispatch::RequestId, Ezlog::Rails::RequestLogContext
+      app.config.middleware.swap ::Rails::Rack::Logger, Ezlog::Rails::AccessLog, Ezlog.logger('AccessLog')
+      app.config.middleware.swap ::ActionDispatch::DebugExceptions, Ezlog::Rails::DebugExceptions
+      app.config.middleware.insert_after Ezlog::Rails::DebugExceptions, Ezlog::Rails::LogExceptions, Ezlog.logger('Application')
+    end
+
+    config.after_initialize do
+      Ezlog::Rails::LogSubscriber.detach ::ActionController::LogSubscriber
+      Ezlog::Rails::LogSubscriber.detach ::ActionView::LogSubscriber
     end
 
     config.before_configuration do |app|
-      app.config.logger = ::Logging.logger['Application']
+      app.config.logger = Ezlog.logger('Application')
+      app.config.log_level = :info
     end
 
     private
@@ -30,9 +43,8 @@ module Ezlog
       end
     end
 
-    def initialize_rack_timeout_logging
-      ::Rack::Timeout::Logger.logger = ::Logging.logger['rack-timeout']
-      ::Rack::Timeout::Logger.logger.level = :warn
+    def disable_rack_timeout_logging
+      ::Rack::Timeout::Logger.logger = ::Logger.new(nil)
     end
   end
 end

data/lib/ezlog/sidekiq/job_logger.rb

@@ -5,7 +5,7 @@ module Ezlog
     class JobLogger
       include LogContextHelper
 
-      def call(job_hash, queue)
+      def call(job_hash, _queue)
         within_log_context(JobContext.from_job_hash(job_hash)) do
           logger.info "#{job_hash['class']} started"
           benchmark { yield }

data/lib/ezlog/version.rb

@@ -1,3 +1,3 @@
 module Ezlog
-  VERSION = "0.2.2"
+  VERSION = '0.3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezlog
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Zoltan Ormandi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-19 00:00:00.000000000 Z
+date: 2019-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  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
@@ -115,6 +115,12 @@ files:
 - lib/ezlog.rb
 - lib/ezlog/log_context_helper.rb
 - lib/ezlog/logging_layout.rb
+- lib/ezlog/rails.rb
+- lib/ezlog/rails/access_log.rb
+- lib/ezlog/rails/debug_exceptions.rb
+- lib/ezlog/rails/log_exceptions.rb
+- lib/ezlog/rails/log_subscriber.rb
+- lib/ezlog/rails/request_log_context.rb
 - lib/ezlog/railtie.rb
 - lib/ezlog/rspec.rb
 - lib/ezlog/rspec/helpers.rb