rails_semantic_logger 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 216cf8051bfdd1959cecd75b027786a93af2c01c
-  data.tar.gz: 51c149aaceab989a1520d6c162d09f3127594d82
+  metadata.gz: 68749e4169b35e0a3200129e876af2421ae58b29
+  data.tar.gz: 72ca518fee4f3aa1fbde17905ca18b14d30f7ff3
 SHA512:
-  metadata.gz: 422d398ffe68bfecf030d99537f50a033c715d5aba1ce981ee7d91821861aa9c981ecccf410e0e0fa98fc6a28e41e856b5ca713b8cbee46c3b9575a0a2ddfa92
-  data.tar.gz: 1e9a705c6b9937f8273735e5d0c16e96362301d8e4204ccc6e35ec9515548e20306f649da6bb5cc5463efabe886bbcd449ff514816c3785e2ee3581aebeb692b
+  metadata.gz: aaad3ae9eadf26eaa45fda6adc2db46558615102a9861f369054738e16f327fa024559dce72e3c6b4667a14fe2a9612b3a016fc23aef2ca5d0bbf7bc4a462fec
+  data.tar.gz: 9d2c103e76dfe98f8604fdc4d641018c83b11dfafea17d0864544308ab250ff0860cff9b4a24811249bc8ced279b27d629490eaf16e5334b9b9b1fb23f98e8c0

data/LICENSE.txt

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2012 Clarity Services, Inc.
+   Copyright 2012, 2013, 2014 Reid Morrison
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

data/README.md

@@ -3,13 +3,13 @@ rails_semantic_logger
 
 Improved logging for Ruby on Rails
 
-* http://github.com/ClarityServices/rails_semantic_logger
+* http://github.com/reidmorrison/rails_semantic_logger
 
-### Overview
+## Overview
 
-Rails Semantic Logger replaces the Rails default logger with [Semantic Logger](http://github.com/ClarityServices/semantic_logger)
+Rails Semantic Logger replaces the Rails default logger with [Semantic Logger](http://github.com/reidmorrison/semantic_logger)
 
-[Semantic Logger](http://github.com/ClarityServices/semantic_logger) takes
+[Semantic Logger](http://github.com/reidmorrison/semantic_logger) takes
 logging in Ruby to a new level by adding several new capabilities to the
 commonly used Logging API:
 
@@ -137,7 +137,7 @@ Thread Safe
 * Tagged logging keeps any tagging data on a per-thread basis to ensure that
   tags from different threads are not inter-mingled
 
-### Introduction
+## Introduction
 
 Just by including the rails_semantic_logger gem, Rails Semantic Logger will
 replace the default Rails logger with Semantic Logger. Without further
@@ -164,9 +164,9 @@ Started GET "/" for 127.0.0.1 at 2012-10-19 12:05:46 +0000
 2012-10-19 12:05:51.113 I [35940:JRubyWorker-10] ActionController -- Completed 200 OK in 3795ms (Views: 1349.0ms | ActiveRecord: 88.0ms | Mongo: 0.0ms)
 ```
 
-### Logging API
+## Logging API
 
-#### Standard Logging methods
+### Standard Logging methods
 
 The Semantic Logger logging API supports the existing logging interface for
 the Rails and Ruby Loggers. For example:
@@ -212,7 +212,7 @@ logger.debug("Calling Supplier", :request => 'update', :user => 'Jack')
 logger.debug { "A total of #{result.inject(0) {|sum, i| i+sum }} were processed" }
 ```
 
-### Exceptions
+## Exceptions
 
 The Semantic Logger adds an optional parameter to the existing log methods so that
 a corresponding Exception can be logged in a standard way
@@ -227,7 +227,7 @@ rescue Exception => exception
 end
 ```
 
-#### Payload
+### Payload
 
 The Semantic Logger adds an extra parameter to the existing log methods so that
 additional payload can be logged, such as a Hash or a Ruby Exception object.
@@ -241,7 +241,7 @@ regular expressions so that a program can analyze log output. With the MongoDB
 appender the payload is written directly to MongoDB as part of the document and
 is therefore fully searchable
 
-#### Benchmarking
+### Benchmarking
 
 Another common logging requirement is to measure the time it takes to execute a block
 of code based on the log level. For example:
@@ -298,7 +298,7 @@ Parameters
     Optional, Ruby Exception object to log along with the duration of the supplied block
 ```
 
-#### Logging levels
+### Logging levels
 
 The following logging levels are available through Semantic Logger
 
@@ -317,7 +317,7 @@ in the development environment for low level trace logging of methods calls etc.
 If only the rails logger is being used, then :trace level calls will be logged
 as debug calls only if the log level is set to trace
 
-#### Changing the Class name for Log Entries
+### Changing the Class name for Log Entries
 
 When Semantic Logger is included in a Rails project it automatically replaces the
 loggers for Rails, ActiveRecord::Base, ActionController::Base, and ActiveResource::Base
@@ -356,7 +356,7 @@ This will result in the log output identifying the log entry as from the Externa
 
     2012-08-30 15:37:29.474 I [48308:ScriptThreadProcess: script/rails] (5.2ms) ExternalSupplier -- Calling external interface
 
-#### Tagged Logging
+### Tagged Logging
 
 Semantic Logger allows any Ruby or Rails program to also include tagged logging.
 
@@ -374,7 +374,7 @@ logger.tagged(tracking_number) do
 end
 ```
 
-#### Beyond Tagged Logging
+### Beyond Tagged Logging
 
 Blocks of code can be tagged with not only values, but can be tagged with
 entire hashes of data. The additional hash of data will be merged into
@@ -390,7 +390,7 @@ logger.with_payload(:user => 'Jack', :zip_code => 12345) do
 end
 ```
 
-#### Installation
+### Installation
 
 Add the following line to Gemfile
 
@@ -405,7 +405,7 @@ Install required gems with bundler
 This will automatically replace the standard Rails logger with Semantic Logger
 which will write all log data to the configured Rails logger.
 
-#### Configuration
+### Configuration
 
 By default Semantic Logger will detect the log level from Rails. To set the
 log level explicitly, add the following line to
@@ -415,6 +415,8 @@ config/environments/production.rb inside the Application.configure block
 config.log_level = :trace
 ```
 
+#### MongoDB logging
+
 To log to both the Rails log file and MongoDB add the following lines to
 config/environments/production.rb inside the Application.configure block
 
@@ -432,6 +434,24 @@ config.after_initialize do
 end
 ```
 
+#### Logging to Syslog
+
+Configuring rails to also log to a local Syslog:
+```ruby
+config.after_initialize do
+  config.semantic_logger.add_appender(SemanticLogger::Appender::Syslog.new)
+end
+```
+
+Configuring rails to also log to a remote Syslog server such as syslog-ng over TCP:
+```ruby
+config.after_initialize do
+  config.semantic_logger.add_appender(SemanticLogger::Appender::Syslog.new(:server => 'tcp://myloghost:514'))
+end
+```
+
+#### Colorized Logging
+
 If the Rails colorized logging is enabled, then the colorized formatter will be used
 by default. To disable colorized logging in both Rails and SemanticLogger:
 
@@ -439,39 +459,97 @@ by default. To disable colorized logging in both Rails and SemanticLogger:
 config.colorize_logging = false
 ```
 
-### Custom Appenders and Formatters
+## Custom Appenders and Formatters
+
+The format of data logged by Semantic Logger is specific to each appender.
+
+To change the text file log format in Rails SemanticLogger, create a rails initializer with the following code and customize as needed.
+For example: 'config/initializers/semantic_logger_formatter.rb'
+
+```ruby
+# Replace the format of the existing log file appender
+SemanticLogger.appenders.first.formatter = Proc.new do |log|
+  tags = log.tags.collect { |tag| "[#{tag}]" }.join(" ") + " " if log.tags && (log.tags.size > 0)
+
+  message = log.message.to_s
+  message << " -- " << log.payload.inspect if log.payload
+  message << " -- " << "#{log.exception.class}: #{log.exception.message}\n#{(log.exception.backtrace || []).join("\n")}" if log.exception
+
+  duration_str = log.duration ? "(#{'%.1f' % log.duration}ms) " : ''
+
+  "#{SemanticLogger::Appender::Base.formatted_time(log.time)} #{log.level.to_s[0..0].upcase} [#{$$}:#{log.thread_name}] #{tags}#{duration_str}#{log.name} : #{message}"
+end
+```
 
-To write your own appenders or formatting, see [SemanticLogger](http://github.com/ClarityServices/semantic_logger)
+To write your own appenders or formatting, see [SemanticLogger](http://github.com/reidmorrison/semantic_logger)
 
-### Log Rotation
+## Log Rotation
 
 Since the log file is not re-opened with every call, when the log file needs
 to be rotated, use a copy-truncate operation rather than deleting the file.
 
-### Dependencies
+## Process Forking
+
+The following frameworks are automatically detected when rails is configured
+so that the necessary callbacks are registered to re-open appenders after a process fork:
+
+- Phusion Passenger
+- Resque
+
+### Unicorn
+
+With Unicorn, add the following code to you Unicorn configuration:
+
+```ruby
+# config/unicorn.conf.rb
+after_fork do |server, worker|
+  # Re-open appenders after forking the process
+  SemanticLogger.reopen
+end
+```
+
+### Puma
+
+If running Puma 2 in Clustered mode and you're preloading your application,
+add the following to your worker boot code:
+
+```ruby
+# config/puma.rb
+on_worker_boot do
+  # Re-open appenders after forking the process
+  SemanticLogger.reopen
+end
+```
+
+## Dependencies
 
-- Ruby MRI 1.8.7, 1.9.3 (or above) Or, JRuby 1.6.3 (or above)
+- Ruby MRI 1.8.7, 1.9.3, 2.0 (or above) Or, JRuby 1.6.3 (or above)
 - Rails 2, 3, 4 or above
 
 Meta
 ----
 
-* Code: `git clone git://github.com/ClarityServices/rails_semantic_logger.git`
-* Home: <https://github.com/ClarityServices/rails_semantic_logger>
-* Bugs: <http://github.com/ClarityServices/rails_semantic_logger/issues>
+* Code: `git clone git://github.com/reidmorrison/rails_semantic_logger.git`
+* Home: <https://github.com/reidmorrison/rails_semantic_logger>
+* Bugs: <http://github.com/reidmorrison/rails_semantic_logger/issues>
 * Gems: <http://rubygems.org/gems/rails_semantic_logger>
 
 This project uses [Semantic Versioning](http://semver.org/).
 
-Authors
--------
+Author
+------
 
 Reid Morrison :: reidmo@gmail.com :: @reidmorrison
 
+Contributors
+------------
+
+Marc Bellingrath :: marrrc.b@gmail.com
+
 License
 -------
 
-Copyright 2012 Clarity Services, Inc.
+Copyright 2012, 2013, 2014 Reid Morrison
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

data/lib/rails_semantic_logger/railtie.rb

@@ -6,7 +6,7 @@ module RailsSemanticLogger #:nodoc:
     # Example: Add the MongoDB logging appender in the Rails environment
     #          initializer in file config/environments/development.rb
     #
-    #   Claritybase::Application.configure do
+    #   Rails::Application.configure do
     #     # Add the MongoDB logger appender only once Rails is initialized
     #     config.after_initialize do
     #       config.semantic_logger.add_appender SemanticLogger::Appender::Mongo.new(
@@ -70,5 +70,28 @@ module RailsSemanticLogger #:nodoc:
       ActiveSupport.on_load(:action_mailer)     { self.logger = SemanticLogger['ActionMailer'] }
     end
 
+    # Support fork frameworks
+    config.after_initialize do
+      # Passenger provides the :starting_worker_process event for executing
+      # code after it has forked, so we use that and reconnect immediately.
+      if defined?(PhusionPassenger)
+        PhusionPassenger.on_event(:starting_worker_process) do |forked|
+          ::SemanticLogger.reopen if forked
+        end
+      end
+
+      # Re-open appenders after Resque has forked a worker
+      if defined?(Resque)
+        Resque.after_fork { |job| ::SemanticLogger.reopen }
+      end
+    end
+
+    # Before any initializers run
+    config.before_initialize do
+      # Replace the Mongoid Loggers after the gems have been loaded
+      Mongoid.logger = SemanticLogger[Mongoid] if defined?(Mongoid)
+      Moped.logger = SemanticLogger[Moped] if defined?(Moped)
+    end
+
   end
 end

data/lib/rails_semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module RailsSemanticLogger #:nodoc
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rails_semantic_logger
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-24 00:00:00.000000000 Z
+date: 2014-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: semantic_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.1
+        version: 2.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.3.1
+        version: 2.5.0
 description: Replaces the default Rails logger with SemanticLogger
 email:
 - reidmo@gmail.com
@@ -31,13 +31,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/rails_semantic_logger/railtie.rb
-- lib/rails_semantic_logger/version.rb
-- lib/rails_semantic_logger.rb
 - LICENSE.txt
-- Rakefile
 - README.md
-homepage: https://github.com/ClarityServices/rails_semantic_logger
+- Rakefile
+- lib/rails_semantic_logger.rb
+- lib/rails_semantic_logger/railtie.rb
+- lib/rails_semantic_logger/version.rb
+homepage: https://github.com/reidmorrison/rails_semantic_logger
 licenses:
 - Apache License V2.0
 metadata: {}
@@ -47,17 +47,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: Improved logging for Ruby on Rails