rails_semantic_logger 3.1.1 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b3c81d831ddf54281df5951cf2e07700172e41a
-  data.tar.gz: f143c81f6bee1502ae6856a6935ade70ce91ebfe
+  metadata.gz: 67bd2b0d0a80d45742fb6572b8b27f52e4dbf526
+  data.tar.gz: f59d1f7880d8505d0bab1cf11be026c2037ed7f4
 SHA512:
-  metadata.gz: 77d7e05e7254739ce759c2dcc08e5c419a84c5c80c9ff7b6f9c467ec733ee605ce450b5788904fe2b4efe8e530fd95ac0d9bd3a71ac09940182f1cf121ff7340
-  data.tar.gz: d5a38591de2cca478df4e2f6f1b1c70bb443bbbc45f750020d562e99589d2e9fdefb610d5559c68c669374623582ef1f4ae1a1d7b874b6597fb1accc942f1213
+  metadata.gz: 0af32c2965f21bcd60e6a7a3cbe5ecd9763c5d9d6a67fb9a390c7c9357b68520de1491f8a3ae9218c5d7a70f772b8b7cc9e499512be613295bc9c82e79f11162
+  data.tar.gz: 04354ac1161c9ca47fad9790f2098e1ecbdb8bfb28cefa69efb8780cb7ee7e9ae010eefdfcf9d4d0279218f0039a20ab389f4f91dc59dd6ee494d140b5cc1cf6

data/Rakefile

@@ -14,3 +14,15 @@ task :publish => :gem do
   system "gem push rails_semantic_logger-#{RailsSemanticLogger::VERSION}.gem"
   system "rm rails_semantic_logger-#{RailsSemanticLogger::VERSION}.gem"
 end
+
+desc 'Run Test Suite'
+task :test do
+  Rake::TestTask.new(:functional) do |t|
+    t.test_files = FileList['test/**/*_test.rb']
+    t.verbose    = true
+  end
+
+  Rake::Task['functional'].invoke
+end
+
+task default: :test

data/lib/rails_semantic_logger/{railtie.rb → engine.rb}

@@ -1,8 +1,5 @@
-require('rails_semantic_logger/extensions/rails/server') if defined?(Rails::Server)
-
-# Replace standard Rails logger
-module RailsSemanticLogger #:nodoc:
-  class Railtie < Rails::Railtie #:nodoc:
+module RailsSemanticLogger
+  class Engine < ::Rails::Engine
     # Make the SemanticLogger config available in the Rails application config
     #
     # Example: Add the MongoDB logging appender in the Rails environment
@@ -19,22 +16,22 @@ module RailsSemanticLogger #:nodoc:
     #   end
     config.semantic_logger = ::SemanticLogger
 
-    config.rails_semantic_logger            = ActiveSupport::OrderedOptions.new
+    config.rails_semantic_logger                   = ActiveSupport::OrderedOptions.new
 
     # Convert Action Controller and Active Record text messages to semantic data
     #   Rails -- Started -- { :ip => "127.0.0.1", :method => "GET", :path => "/dashboards/inquiry_recent_activity" }
     #   UserController -- Completed #index -- { :action => "index", :db_runtime => 54.64, :format => "HTML", :method => "GET", :mongo_runtime => 0.0, :path => "/users", :status => 200, :status_message => "OK", :view_runtime => 709.88 }
-    config.rails_semantic_logger.semantic   = true
+    config.rails_semantic_logger.semantic          = true
 
     # Change Rack started message to debug so that it does not appear in production
-    config.rails_semantic_logger.started    = false
+    config.rails_semantic_logger.started           = false
 
     # Change Processing message to debug so that it does not appear in production
-    config.rails_semantic_logger.processing = false
+    config.rails_semantic_logger.processing        = false
 
     # Change Action View render log messages to debug so that they do not appear in production
     #   ActionView::Base --   Rendered data/search/_user.html.haml (46.7ms)
-    config.rails_semantic_logger.rendered   = false
+    config.rails_semantic_logger.rendered          = false
 
     # Override the Awesome Print options for logging Hash data as text:
     #
@@ -44,7 +41,17 @@ module RailsSemanticLogger #:nodoc:
     #
     #  Note: The option :multiline is set to false if not supplied.
     #  Note: Has no effect if Awesome Print is not installed.
-    config.rails_semantic_logger.ap_options = {multiline: false}
+    config.rails_semantic_logger.ap_options        = {multiline: false}
+
+    # Whether to automatically add an environment specific log file appender.
+    # For Example: 'log/development.log'
+    #
+    # Note:
+    #   When Semantic Logger fails to log to an appender it logs the error to an
+    #   internal logger, which by default writes to STDERR.
+    #   Example, change the default internal logger to log to stdout:
+    #     SemanticLogger::Logger.logger = SemanticLogger::Appender::File.new(STDOUT, :warn)
+    config.rails_semantic_logger.add_file_appender = true
 
     # Initialize SemanticLogger. In a Rails environment it will automatically
     # insert itself above the configured rails logger to add support for its
@@ -62,22 +69,24 @@ module RailsSemanticLogger #:nodoc:
       # Existing loggers are ignored because servers like trinidad supply their
       # own file loggers which would result in duplicate logging to the same log file
       Rails.logger                 = config.logger = begin
-        path = config.paths['log'].first
-        FileUtils.mkdir_p(File.dirname(path)) unless File.exist?(File.dirname(path))
-
-        # Set internal logger to log to file only, in case another appender
-        # experiences errors during writes
-        appender                      = SemanticLogger::Appender::File.new(path, config.log_level)
-        appender.name                 = 'SemanticLogger'
-        SemanticLogger::Logger.logger = appender
-
-        # Add the log file to the list of appenders
-        # Use the colorized formatter if Rails colorized logs are enabled
-        options                       = config.rails_semantic_logger.ap_options
-        formatter                     = config.colorize_logging == false ? SemanticLogger::Formatters::Default.new : SemanticLogger::Formatters::Color.new(options)
-        # Check for previous file or stdout loggers
-        SemanticLogger.appenders.each { |appender| appender.formatter = formatter if appender.is_a?(SemanticLogger::Appender::File) }
-        SemanticLogger.add_appender(file_name: path, formatter: formatter)
+        if config.rails_semantic_logger.add_file_appender
+          path = config.paths['log'].first
+          FileUtils.mkdir_p(File.dirname(path)) unless File.exist?(File.dirname(path))
+
+          # Add the log file to the list of appenders
+          # Use the colorized formatter if Rails colorized logs are enabled
+          ap_options                    = config.rails_semantic_logger.ap_options
+          formatter                     = config.colorize_logging == false ? SemanticLogger::Formatters::Default.new : SemanticLogger::Formatters::Color.new(ap: ap_options)
+
+          # Set internal logger to log to file only, in case another appender experiences errors during writes
+          appender                      = SemanticLogger::Appender::File.new(file_name: path, level: config.log_level, formatter: formatter)
+          appender.name                 = 'SemanticLogger'
+          SemanticLogger::Logger.logger = appender
+
+          # Check for previous file or stdout loggers
+          SemanticLogger.appenders.each { |appender| appender.formatter = formatter if appender.is_a?(SemanticLogger::Appender::File) }
+          SemanticLogger.add_appender(file_name: path, formatter: formatter)
+        end
         SemanticLogger[Rails]
       rescue StandardError => exc
         # If not able to log to file, log to standard error with warning level only
@@ -147,11 +156,11 @@ module RailsSemanticLogger #:nodoc:
       Concurrent.global_logger = SemanticLogger[Concurrent] if defined?(Concurrent)
 
       # Rails Patches
-      require('rails_semantic_logger/extensions/action_cable/tagged_logger_proxy') if defined?(ActionCable::Connection::TaggedLoggerProxy)
+      require('rails_semantic_logger/extensions/action_cable/tagged_logger_proxy') if defined?(ActionCable)
       require('rails_semantic_logger/extensions/action_controller/live') if defined?(ActionController::Live)
       require('rails_semantic_logger/extensions/action_dispatch/debug_exceptions') if defined?(ActionDispatch::DebugExceptions)
       require('rails_semantic_logger/extensions/action_view/streaming_template_renderer') if defined?(ActionView::StreamingTemplateRenderer::Body)
-      require('rails_semantic_logger/extensions/active_job/logging') if defined?(ActiveJob::Logging)
+      require('rails_semantic_logger/extensions/active_job/logging') if defined?(ActiveJob)
 
       if config.rails_semantic_logger.semantic
         require('rails_semantic_logger/extensions/rails/rack/logger') if defined?(Rails::Rack::Logger)
@@ -174,6 +183,6 @@ module RailsSemanticLogger #:nodoc:
       # Replace the Bugsnag logger
       Bugsnag.configure { |config| config.logger = SemanticLogger[Bugsnag] } if defined?(Bugsnag)
     end
+
   end
 end
-

data/lib/rails_semantic_logger/extensions/action_controller/log_subscriber.rb

@@ -9,30 +9,28 @@ module ActionController
 
     def process_action(event)
       controller_logger(event).info do
-        payload = event.payload
-        params  = payload[:params].except(*INTERNAL_PARAMS)
-        format  = payload[:format]
-        format  = format.to_s.upcase if format.is_a?(Symbol)
-        status  = payload[:status]
+        payload = event.payload.dup
+        payload[:params].except!(*INTERNAL_PARAMS)
+        payload.delete(:params) if payload[:params].empty?
 
-        if status.nil? && payload[:exception].present?
-          exception_class_name = payload[:exception].first
-          status               = ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_class_name)
+        format           = payload[:format]
+        payload[:format] = format.to_s.upcase if format.is_a?(Symbol)
+
+        exception = payload.delete(:exception)
+        if payload[:status].nil? && exception.present?
+          exception_class_name = exception.first
+          payload[:status]     = ActionDispatch::ExceptionWrapper.status_code_for_exception(exception_class_name)
+        end
+
+        # Rounds off the runtimes. For example, :view_runtime, :mongo_runtime, etc.
+        payload.keys.each do |key|
+          payload[key] = payload[key].to_f.round(2) if key.to_s.match(/(.*)_runtime/)
         end
 
-        log = {
-          message:        "Completed ##{payload[:action]}",
-          status:         status,
-          status_message: Rack::Utils::HTTP_STATUS_CODES[status],
-          format:         format,
-          path:           payload[:path],
-          action:         payload[:action],
-          method:         payload[:method],
-          duration:       event.duration
-        }
-        collect_runtimes(payload, log)
-        log[:params] = params unless params.empty?
-        log
+        payload[:message]        = "Completed ##{payload[:action]}"
+        payload[:status_message] = Rack::Utils::HTTP_STATUS_CODES[payload[:status]] if payload[:status].present?
+        payload[:duration]       = event.duration
+        payload
       end
     end
 
@@ -87,15 +85,5 @@ module ActionController
       end
     end
 
-    # Returns [Hash] runtimes for all registered runtime collection subscribers
-    # For example, :view_runtime, :mongo_runtime, etc.
-    def collect_runtimes(payload, log)
-      payload.each_pair do |key, value|
-        if match = key.to_s.match(/(.*)_runtime/)
-          log[key] = value.to_f.round(2)
-        end
-      end
-    end
-
   end
 end

data/lib/rails_semantic_logger/extensions/active_job/logging.rb

@@ -1,5 +1,5 @@
 # Patch ActiveJob logger
-ActiveJob::Logging
+require 'active_job/logging'
 
 module ActiveJob::Logging
   private

data/lib/rails_semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module RailsSemanticLogger #:nodoc
-  VERSION = '3.1.1'
+  VERSION = '3.3.0'
 end

data/lib/rails_semantic_logger.rb

@@ -1,2 +1,6 @@
 require 'semantic_logger'
-require 'rails_semantic_logger/railtie'
+require 'rails_semantic_logger/extensions/rails/server' if defined?(Rails::Server)
+require 'rails_semantic_logger/engine'
+
+module RailsSemanticLogger
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_semantic_logger
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.3.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-02 00:00:00.000000000 Z
+date: 2016-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.3'
 description: Replaces the default Rails logger with SemanticLogger
 email:
 - reidmo@gmail.com
@@ -49,6 +49,7 @@ files:
 - README.md
 - Rakefile
 - lib/rails_semantic_logger.rb
+- lib/rails_semantic_logger/engine.rb
 - lib/rails_semantic_logger/extensions/action_cable/tagged_logger_proxy.rb
 - lib/rails_semantic_logger/extensions/action_controller/live.rb
 - lib/rails_semantic_logger/extensions/action_controller/log_subscriber.rb
@@ -61,7 +62,6 @@ files:
 - lib/rails_semantic_logger/extensions/rails/rack/logger.rb
 - lib/rails_semantic_logger/extensions/rails/rack/logger_info_as_debug.rb
 - lib/rails_semantic_logger/extensions/rails/server.rb
-- lib/rails_semantic_logger/railtie.rb
 - lib/rails_semantic_logger/version.rb
 homepage: https://github.com/rocketjob/rails_semantic_logger
 licenses: