semantic_logger 0.4.2 → 0.5.0

data/README.md

@@ -437,7 +437,7 @@ Reid Morrison :: reidmo@gmail.com :: @reidmorrison
 License
 -------
 
-Copyright 2011 Clarity Services, Inc.
+Copyright 2012 Clarity Services, Inc.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/lib/semantic_logger/appender/file.rb

@@ -0,0 +1,83 @@
+# File appender
+#
+#   Writes log messages to a file or open iostream
+#
+module SemanticLogger
+  module Appender
+    class File
+      attr_accessor :formatter
+
+      # Create a File Logger appender instance
+      #
+      # Example
+      #    require 'semantic_logger'
+      #
+      #    # Log to screen
+      #    SemanticLogger::Logger.appenders << SemanticLogger::Appender::File.new(STDOUT)
+      #
+      #    # And log to a file at the same time
+      #    SemanticLogger::Logger.appenders << SemanticLogger::Appender::File.new('application.log')
+      #
+      #    logger =  SemanticLogger::Logger.new('test')
+      #    logger.info 'Hello World'
+      #
+      def initialize(filename, &block)
+        raise "logger cannot be null when initializing the SemanticLogging::Appender::Logger" unless filename
+        @filename = filename
+        @log = if filename.respond_to?(:write) and filename.respond_to?(:close)
+          filename
+        else
+          @log = open(filename, (::File::WRONLY | ::File::APPEND | ::File::CREAT))
+          # Force all log entries to write immediately without buffering
+          @log.sync = true
+          @log.set_encoding(Encoding::BINARY) if @log.respond_to?(:set_encoding)
+          @log
+        end
+
+        # Set the formatter to the supplied block
+        @formatter = block || self.default_formatter
+      end
+
+      # Default log formatter
+      #  Replace this formatter by supplying a Block to the initializer
+      #  Generates logs of the form:
+      #    2011-07-19 14:36:15.660 D [1149:ScriptThreadProcess] Rails -- Hello World\n
+      def default_formatter
+        Proc.new do |log|
+          message = log.message.to_s
+          tags = log.tags.collect { |tag| "[#{tag}]" }.join(" ") + " " if log.tags && (log.tags.size > 0)
+
+          if log.payload
+            if log.payload.is_a?(Exception)
+              exception = log.payload
+              message << " -- " << "#{exception.class}: #{exception.message}\n#{(exception.backtrace || []).join("\n")}"
+            else
+              message << " -- " << log.payload.inspect
+            end
+          end
+
+          str = "#{log.time.strftime("%Y-%m-%d %H:%M:%S")}.#{"%03d" % (log.time.usec/1000)} #{log.level.to_s[0..0].upcase} [#{$$}:#{log.thread_name}] #{tags}#{log.name} -- #{message}"
+          str << " (#{'%.1f' % log.duration}ms)" if log.duration
+          str << "\n"
+          str
+        end
+      end
+
+      # Pass log calls to the underlying Rails, log4j or Ruby logger
+      #  trace entries are mapped to debug since :trace is not supported by the
+      #  Ruby or Rails Loggers
+      def log(log)
+        # Since only one appender thread will be writing to the file at a time
+        # it is not necessary to protect access to the file with a semaphore
+        @log.write(@formatter.call(log))
+      end
+
+      # Flush all pending logs to disk.
+      #  Waits for all sent documents to be writted to disk
+      def flush
+        @log.flush if @log.respond_to?(:flush)
+      end
+
+    end
+  end
+end

data/lib/semantic_logger/logger.rb

@@ -29,6 +29,7 @@
 #   # This will be logged to both the Ruby Logger and MongoDB
 #   logger.debug("Login time", :user => 'Mary', :duration => 230, :ip_address=>'192.168.0.1')
 #
+require 'logger'
 module SemanticLogger
   class Logger
     include SyncAttr
@@ -47,18 +48,21 @@ module SemanticLogger
       []
     end
 
-    # Allow for setting the default log level
-    def self.default_level=(default_level)
-      @@default_level = default_level
+    # Allow for setting the global default log level
+    # This change only applies to _new_ loggers, existing logger levels
+    # will not be changed in any way
+    def self.level=(level)
+      @@level = level
     end
 
-    def self.default_level
-      @@default_level
+    # Returns the global default log level for new Logger instances
+    def self.level
+      @@level
     end
 
     attr_reader :name, :level
 
-    @@default_level = :info
+    @@level = :info
 
     # Returns a Logger instance
     #
@@ -74,7 +78,7 @@ module SemanticLogger
     #    :level   The initial log level to start with for this logger instance
     def initialize(klass, options={})
       @name = klass.is_a?(String) ? klass : klass.name
-      set_level(options[:level] || self.class.default_level)
+      set_level(options[:level] || self.class.level)
     end
 
     # Set the logging level
@@ -239,8 +243,7 @@ module SemanticLogger
     # Warning: Do not use this logger directly it is intended for internal logging
     #          within Semantic Logger itself
     sync_cattr_accessor :logger do
-      require 'logger'
-      l = ::Logger.new(STDOUT)
+      l = ::Logger.new(STDERR)
       l.level = ::Logger::INFO
       l
     end

data/lib/semantic_logger/railtie.rb

@@ -26,17 +26,42 @@ module SemanticLogger #:nodoc:
     initializer :initialize_semantic_logger, :before => :initialize_logger do
       config = Rails.application.config
 
-      logger = Rails.logger || config.logger || begin
-        path = config.paths.log.to_a.first
-        logger = ActiveSupport::BufferedLogger.new(path)
-        # Translate trace to debug level for BufferedLogger
-        level = config.log_level == :trace ? :debug : config.log_level
-        logger.level = ActiveSupport::BufferedLogger.const_get(level.to_s.upcase)
-        logger.auto_flushing = false if Rails.env.production?
-        logger
-      rescue StandardError => e
-        logger = ActiveSupport::BufferedLogger.new(STDERR)
-        logger.level = ActiveSupport::BufferedLogger::WARN
+      # Set the default log level based on the Rails config
+      SemanticLogger::Logger.level = config.log_level
+
+      # Also log to any pre-existing loggers with SymanticLogger
+      if existing_logger = (Rails.logger || config.logger)
+        # Add existing Logger to the list of appenders
+        SemanticLogger::Logger.appenders << SemanticLogger::Appender::Logger.new(existing_logger)
+      end
+
+      Rails.logger = config.logger = begin
+        # First check for Rails 3.2 path, then fallback to pre-3.2
+        path = ((config.paths.log.to_a rescue nil) || config.paths['log']).first
+        unless File.exist? File.dirname path
+          FileUtils.mkdir_p File.dirname path
+        end
+
+        # First set the internal logger in case something goes wrong
+        # with an appender
+        SemanticLogger::Logger.logger = begin
+          l = ::Logger.new(path)
+          l.level = ::Logger.const_get(config.log_level.to_s.upcase)
+          l
+        end
+
+        # Add the log file to the list of appenders
+        SemanticLogger::Logger.appenders << SemanticLogger::Appender::File.new(path)
+
+        #logger = ActiveSupport::TaggedLogging.new(logger) if defined?(ActiveSupport::TaggedLogging)
+
+        SemanticLogger::Logger.new(Rails)
+      rescue StandardError
+        SemanticLogger::Logger.appenders << SemanticLogger::Appender::File.new(STDERR)
+
+        logger = SemanticLogger::Logger.new(Rails)
+        logger.level = :warn
+        #logger = ActiveSupport::TaggedLogging.new(logger) if defined?(ActiveSupport::TaggedLogging)
         logger.warn(
           "Rails Error: Unable to access log file. Please ensure that #{path} exists and is chmod 0666. " +
             "The log level has been raised to WARN and the output directed to STDERR until the problem is fixed."
@@ -44,18 +69,8 @@ module SemanticLogger #:nodoc:
         logger
       end
 
-      # First set the internal logger to the default file one used by Rails in case something goes wrong
-      # with an appender
-      SemanticLogger::Logger.logger = logger
-
-      # Add the Rails Logger to the list of appenders
-      SemanticLogger::Logger.appenders << SemanticLogger::Appender::Logger.new(logger)
-
-      # Set the default log level based on the Rails config
-      SemanticLogger::Logger.default_level = config.log_level
-
+      # #TODO Should these be moved?
       # Replace the default Rails loggers
-      Rails.logger = config.logger = SemanticLogger::Logger.new(Rails)
       if defined?(ActiveRecord::Base)
         ActiveRecord::Base.logger = SemanticLogger::Logger.new(ActiveRecord)
       end

data/lib/semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module SemanticLogger #:nodoc
-  VERSION = "0.4.2"
+  VERSION = "0.5.0"
 end

data/lib/semantic_logger.rb

@@ -5,6 +5,7 @@ module SemanticLogger
   autoload :Logger, 'semantic_logger/logger'
 
   module Appender
+    autoload :File, 'semantic_logger/appender/file'
     autoload :Logger, 'semantic_logger/appender/logger'
     # Only load the MongoDB appender if the Mongo Ruby Driver is loaded
     autoload :MongoDB, 'semantic_logger/appender/mongodb'

data/test/logger_test.rb

@@ -59,9 +59,10 @@ class LoggerTest < Test::Unit::TestCase
 
         should "add payload to log entries" do
           @logger.with_payload(:tracking_number => '123456') do
-            @logger.with_payload(:more => 'data', :even => 2) do
+            @logger.with_payload(:even => 2, :more => 'data') do
               @logger.info('Hello world')
               SemanticLogger::Logger.flush
+              # TODO make test ignore order of Hash elements
               assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ \w \[\d+:.+\] LoggerTest -- Hello world -- \{:even=>2, :more=>\"data\", :tracking_number=>\"123456\"\}/, @mock_logger.message
             end
           end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
-  - 2
-  version: 0.4.2
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Reid Morrison
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-09-07 00:00:00 -04:00
+date: 2012-09-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -53,6 +53,7 @@ extra_rdoc_files: []
 files: 
 - FUTURE.rb
 - init.txt
+- lib/semantic_logger/appender/file.rb
 - lib/semantic_logger/appender/logger.rb
 - lib/semantic_logger/appender/mongodb.rb
 - lib/semantic_logger/logger.rb