semantic_logger 0.2.0 → 0.3.0

data/FUTURE.rb

@@ -1,9 +1,4 @@
 
-# Return the logger for a specific class, supports class specific log levels
-# Clarity::Logger.logger(MyClass)
-# # OR
-# Clarity::Logger.logger('MyClass')
-#
 # # Switch to slf4j as the underlying implementation
 # Clarity::Logger.impl = slf4j
 #
@@ -14,13 +9,6 @@
 #
 #
 #
-# # Thread specific context information to be logged with every log entry
-# #
-# # Add metadata information within a block to all log calls on This Thread
-# logger.with_metadata(:tracking_number=>12345) do
-#   # Any log entries within this block will have this metadata added to it
-#   logger.debug('Hello World', :result => 'blah')
-# end
 #
 # # If a block cannot be used to set the scope of context
 # # Set global metadata for every log entry on this machine

data/lib/semantic_logger/appender/logger.rb

@@ -41,6 +41,8 @@ module SemanticLogger
       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
@@ -50,8 +52,9 @@ module SemanticLogger
             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}] #{log.name} -- #{message}\n"
+          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

data/lib/semantic_logger/appender/mongodb.rb

@@ -12,8 +12,8 @@ module SemanticLogger
     #    level      : 'trace|debug|warn|info|error',
     #    message    : "blah blah",
     #    duration   : ms,  # Set by Logger#benchmark
-    #    tracking_number : "Some tracking id"
-    #    metadata : {
+    #    tags       : "Some tracking id" | ["id1", "id2"]
+    #    payload : {
     #      Optional. Any user supplied data, including any thread specific context variables
     #      values supplied on a per log entry will override any thread context values
     #    }

data/lib/semantic_logger/logger.rb

@@ -53,7 +53,13 @@ module SemanticLogger
 
     @@default_level = :info
 
-    # Create a Logger instance
+    # Returns a Logger instance
+    #
+    # Return the logger for a specific class, supports class specific log levels
+    #   logger = SemanticLogger::Logger.new(self)
+    # OR
+    #   logger = SemanticLogger::Logger.new('MyClass')
+    #
     # Parameters:
     #  application: A class, module or a string with the application/class name
     #               to be used in the logger
@@ -94,10 +100,14 @@ module SemanticLogger
               if result.is_a?(String)
                 message = message.nil? ? result : "\#{message} -- \#{result.to_s}"
               else
-                payload = payload.nil? ? sresult : payload.merge(result)
+                payload = payload.nil? ? result : payload.merge(result)
               end
             end
-            self.class.queue << Log.new(:#{level}, self.class.thread_name, name, message, payload, Time.now)
+            # Add scoped payload
+            if self.payload
+              payload = payload.nil? ? self.payload : self.payload.merge(payload)
+            end
+            self.class.queue << Log.new(:#{level}, self.class.thread_name, name, message, payload, Time.now, nil, tags)
             true
           else
             false
@@ -117,10 +127,15 @@ module SemanticLogger
             start = Time.now
             begin
               result = yield
-              self.class.queue << Log.new(:#{level}, self.class.thread_name, name, message, payload, start, Time.now - start)
+              # Add scoped payload
+              if self.payload
+                payload = payload.nil? ? self.payload : self.payload.merge(payload)
+              end
+              self.class.queue << Log.new(:#{level}, self.class.thread_name, name, message, payload, start, Time.now - start, tags)
               result
             rescue Exception => exc
-              self.class.queue << Log.new(:#{level}, self.class.thread_name, name, message, exc, start, Time.now - start)
+              # TODO Need to be able to have both an exception and a Payload
+              self.class.queue << Log.new(:#{level}, self.class.thread_name, name, message, exc, start, Time.now - start, tags)
               raise exc
             end
           else
@@ -130,6 +145,55 @@ module SemanticLogger
       EOT
     end
 
+    # Add the supplied tags to the list of tags to log for this thread whilst
+    # the supplied block is active
+    # Returns nil if no tags are currently set
+    def with_tags(*tags)
+      current_tags = self.tags
+      # Check for nil tags
+      if tags
+        Thread.current[:semantic_logger_tags] = current_tags ? current_tags + tags : tags
+      end
+      yield
+    ensure
+      Thread.current[:semantic_logger_tags] = current_tags
+    end
+
+    # Returns [Array] of [String] tags currently active for this thread
+    # Returns nil if no tags are set
+    def tags
+      Thread.current[:semantic_logger_tags]
+    end
+
+    # Thread specific context information to be logged with every log entry
+    #
+    # Add a payload to all log calls on This Thread within the supplied block
+    #
+    #   logger.with_payload(:tracking_number=>12345) do
+    #     logger.debug('Hello World')
+    #   end
+    #
+    # If a log call already includes a pyload, this payload will be merged with
+    # the supplied payload, with the supplied payload taking precedence
+    #
+    #   logger.with_payload(:tracking_number=>12345) do
+    #     logger.debug('Hello World', :result => 'blah')
+    #   end
+    def with_payload(payload)
+      current_payload = self.payload
+      Thread.current[:semantic_logger_payload] = current_payload ? current_payload.merge(payload) : payload
+      yield
+    ensure
+      Thread.current[:semantic_logger_payload] = current_payload
+    end
+
+    # Returns [Hash] payload to be added to every log entry in the current scope
+    # on this thread.
+    # Returns nil if no payload is currently set
+    def payload
+      Thread.current[:semantic_logger_payload]
+    end
+
     # Semantic Logging does not support :unknown level since these
     # are not understood by the majority of the logging providers
     # Map it to :error
@@ -187,7 +251,7 @@ module SemanticLogger
       Queue.new
     end
 
-    Log = Struct.new(:level, :thread_name, :name, :message, :payload, :time, :duration)
+    Log = Struct.new(:level, :thread_name, :name, :message, :payload, :time, :duration, :tags)
 
     # For JRuby include the Thread name rather than its id
     if defined? Java

data/lib/semantic_logger/railtie.rb

@@ -23,15 +23,31 @@ module SemanticLogger #:nodoc:
     #
     # Loaded after Rails logging is initialized since SemanticLogger will continue
     # to forward logging to the Rails Logger
-    initializer :initialize_semantic_logger, :after => :initialize_logger do
+    initializer :initialize_semantic_logger, :before => :initialize_logger do
       config = Rails.application.config
 
-      # First set the internal logger to the one used by Rails in case something goes wrong
+      logger = Rails.logger || config.logger || begin
+        path = config.paths.log.to_a.first
+        logger = ActiveSupport::BufferedLogger.new(path)
+        logger.level = ActiveSupport::BufferedLogger.const_get(config.log_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
+        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."
+        )
+        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 = Rails.logger
+      SemanticLogger::Logger.logger = logger
 
       # Add the Rails Logger to the list of appenders
-      SemanticLogger::Logger.appenders << SemanticLogger::Appender::Logger.new(Rails.logger)
+      SemanticLogger::Logger.appenders << SemanticLogger::Appender::Logger.new(logger)
 
       # Set the default log level based on the Rails config
       SemanticLogger::Logger.default_level = Rails.configuration.log_level
@@ -41,6 +57,10 @@ module SemanticLogger #:nodoc:
       if defined?(ActiveRecord)
         ActiveRecord::Base.logger = SemanticLogger::Logger.new(ActiveRecord)
       end
+      if defined?(ActionController)
+        ActionController::Base.logger = SemanticLogger::Logger.new(ActionController)
+      end
+      SemanticLogger::Logger.logger.info "SemanticLogger initialized"
     end
 
   end

data/lib/semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module SemanticLogger #:nodoc
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/test/logger_test.rb

@@ -9,7 +9,6 @@ require 'semantic_logger'
 require 'test/mock_logger'
 
 # Unit Test for SemanticLogger::Logger
-#
 class LoggerTest < Test::Unit::TestCase
   context SemanticLogger::Logger do
 
@@ -39,6 +38,36 @@ class LoggerTest < Test::Unit::TestCase
         end
       end
 
+      context "with_tags logging" do
+        should "add tags to log entries" do
+          @logger.with_tags('12345', 'DJHSFK') do
+            @logger.info('Hello world')
+            @logger.flush
+            assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ \w \[\d+:.+\] \[12345\] \[DJHSFK\] LoggerTest -- Hello world\n/, @mock_logger.message
+          end
+        end
+
+        should "add embedded tags to log entries" do
+          @logger.with_tags('First Level', 'tags') do
+            @logger.with_tags('Second Level') do
+              @logger.info('Hello world')
+              @logger.flush
+              assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ \w \[\d+:.+\] \[First Level\] \[tags\] \[Second Level\] LoggerTest -- Hello world\n/, @mock_logger.message
+            end
+          end
+        end
+
+        should "add payload to log entries" do
+          @logger.with_payload(:tracking_number => '123456') do
+            @logger.with_payload(:more => 'data', :even => 2) do
+              @logger.info('Hello world')
+              @logger.flush
+              assert_match /\d+-\d+-\d+ \d+:\d+:\d+.\d+ \w \[\d+:.+\] LoggerTest -- Hello world -- \{:more=>\"data\", :even=>2, :tracking_number=>\"123456\"\}\n/, @mock_logger.message
+            end
+          end
+        end
+
+      end
     end
 
   end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Reid Morrison
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-20 00:00:00 -04:00
+date: 2012-08-21 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency