formatted_rails_logger 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in formatted_rails_logger.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,58 @@
+# FormattedRailsLogger
+
+Monkey-patches Rails BufferedLogger (the standard Rails logger) to accept a formatter just like ruby Logger does. Provides a formatter that includes timestamp and severity in logs, while taking account of Rails habit of making space in the logfile by adding newlines to the beginning of log message. 
+
+It's only 80 lines of verbose code.  I'd think a bazillion people would have done this before, but I didn't see any other gems to do it simply and flexibly, sorry for any duplication. 
+
+## How to use
+
+Should work for both Rails2 and Rails3. 
+
+Include the formatted_rails_logger gem in your project as appropriate for your Rails version. 
+
+I don't like magic, so it doesn't actually do anything just to include the gem. Instead create an initializer, say config/initializers/logging.rb:
+
+    require 'formatted_rails_logger'
+    
+    #monkey-patch BufferedLogger
+    FormattedRailsLogger.patch_rails
+    
+    #Use the supplied formatter that includes timestamp and severity
+    Rails.logger.formatter = FormattedRailsLogger::Formatter.new
+    
+You can of course also write your own formatter, which is just any
+object that responds to #call(severity, datetime, progname, msg) . A proc or lambda with those arguments works. See ruby [Logger](http://www.ruby-doc.org/stdlib/libdoc/logger/rdoc/classes/Logger.html) ([source](https://github.com/ruby/ruby/blob/trunk/lib/logger.rb)).  
+    
+There may be some fancier way to do things with Rails3 involving config.logger, I don't know, I'm in the middle of several rails 2->3 transitions, and needed something that would work with both, and this method should. 
+
+## What it does
+
+It monkey patches BufferedLogger to accept a #formatter just like standard ruby Logger. Had to copy and paste the whole #add method to monkey patch it, sorry. Hopefully it won't change much in the foreseeable future. 
+
+Then it provides a Logger-style formatter object that formats the way I'd like. It's got a timestamp, I decided that miliseconds were probably useful but Logger's default of including microseconds was a ridiculous waste of screen columns. I decided [Logger](https://github.com/ruby/ruby/blob/trunk/lib/logger.rb)'s default inclusion of PID and progname weren't worth the columns, and I have no idea why Logger's default formatter includes the severity twice in two different ways, so I didn't do that. 
+
+I did more or less copy the format that my 2.3.x Rails app outputs (from WebBrick?) before Rails hijacks with the buffered logger. But with miliseconds. 
+
+I did use a regexp to look for newlines at the very beginning of a log message, and insert the timestamp/severity _after_ those newlines, so they can still serve the desired spacing function and everything looks how you'd want. 
+
+    [2011-08-04 15:29:21.606]  INFO  Completed in 1811ms (View: 1392, DB: 204) | 200 OK [http://X.X.X.edu/catalog?q=anarchy&search_field=all_fields]
+
+
+    [2011-08-04 15:29:21.834]  INFO  Processing CatalogController#range_limit (for X.X.X.X at 2011-08-04 15:29:21) [GET]
+
+
+## Things I'm Baffled About
+
+* Why has Rails always thought it better to exclude timestamps and severity from logfiles? Me, I need to be able to grep logfiles for "ERROR" or "FATAL" or "WARN" to see how my app's doing, and I need to be able to have timestamps to correlate human observed problems to the logs. Am I really alone here? 
+
+* Why does Rails BufferedLogger not provide the same formatter functionality a usual ruby Logger, either by sub-classing Logger, or duck-typing the formatter functionality too?  
+
+* Why does ruby 1.8.7 Time.strftime not accept an %L formatting string, even though the [documentation](http://www.ruby-doc.org/core/classes/Time.html#M000392) says it should? Did they fix this in 1.9? I don't know. 
+
+## Things I didn't do
+
+* No, there are no unit tests. I just hacked this out cause I was sick of Rails logging. If you wanted to help out and add em, that'd be great.
+
+* I sort of feel like someone should actually propose this as a patch to Rails itself (at least the part where BufferedLogger can take a #formatter), but I lack the psychic energy, and it still wouldn't help me right now on current stable versions of Rails. 
+
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/formatted_rails_logger.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "formatted_rails_logger/version"
+
+Gem::Specification.new do |s|
+  s.name        = "formatted_rails_logger"
+  s.version     = FormattedRailsLogger::VERSION
+  s.authors     = ["Jonathan Rochkind"]
+  s.email       = ["jonathan@dnil.net"]
+  s.homepage    = "https://github.com/jrochkind/formatted_rails_logger"
+  s.summary     = %q{Formatting capabilities for Rails BufferedLogger}  
+
+  s.rubyforge_project = "formatted_rails_logger"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/formatted_rails_logger.rb

@@ -0,0 +1,8 @@
+require "formatted_rails_logger/version"
+require 'formatted_rails_logger/formatter'
+
+module FormattedRailsLogger
+  def self.patch_rails
+    load File.expand_path("../formatted_rails_logger/buffered_logger_inject.rb", __FILE__)
+  end
+end

data/lib/formatted_rails_logger/buffered_logger_inject.rb

@@ -0,0 +1,51 @@
+# intentionally raise if not already defined. For some reason I feel like
+# doing this rather than declaring Rails a dependency. 
+ActiveSupport::BufferedLogger.class 
+
+class ActiveSupport::BufferedLogger
+  attr_accessor :formatter
+  # use pure ruby class method, Rails provides ones with
+  # better semantics for inheritance, but they keep changing
+  # version to version, so nope. 
+  class << self ; attr_accessor :default_formatter ; end
+        
+
+    
+  
+  # Have to over-ride/replace BufferedLogger's usual #add
+  # to use formatter
+  def add(severity, message = nil, progname = nil, &block)
+    return if @level > severity
+    message = (message || (block && block.call) || progname).to_s
+    
+    # our custom formatting
+    message = format_message(format_severity(severity), Time.now, progname, message)
+    
+    # If a newline is necessary then create a new message ending with a newline.
+    # Ensures that the original message is not mutated.
+    message = "#{message}\n" unless message[-1] == ?\n
+    buffer << message
+    auto_flush
+    message
+  end
+    
+  protected
+  
+  # why does BufferedLogger not give us a way to translate from integer
+  # constant to actual severity lable? argh. copied from Logger
+  # Severity label for logging. (max 5 char)
+  SEV_LABEL = %w(DEBUG INFO WARN ERROR FATAL UNKNOWN)
+  def format_severity(severity)
+    SEV_LABEL[severity] || 'UNKNOWN'
+  end
+  
+  def format_message(severity, datetime, progname, msg)
+    if formatter = (@formatter || self.class.default_formatter)
+      formatter.call(severity, datetime, progname, msg)
+    else
+      msg
+    end
+  end
+  
+end
+

data/lib/formatted_rails_logger/formatter.rb

@@ -0,0 +1,29 @@
+#
+# A Logger::Formatter that includes timestamp and severity, and works
+# well with Rails, taking account of preceding newlines in msg for spacing.
+class FormattedRailsLogger::Formatter
+  # Unlike Logger, not seeing a need to include the PID, the progname, 
+  # or the Severity twice. 
+  @@format_str = "[%s] %5s  %s"
+  @@datetime_format = nil 
+  
+  def call(severity, time, progname, msg)        
+    # see no need for micro-seconds like in Logger, milis suffices. 
+    # No idea why documented %L and other such useful things
+    # do not work in strftime. 
+    formatted_time = if @@datetime_format
+      time.strftime(@@datetime_format)
+    else
+      time.strftime("%Y-%m-%d %H:%M:%S.") << time.usec.to_s[0..2].rjust(3)
+    end
+        
+    # Rails likes to log with some preceding newlines for spacing in the
+    # logfile. We want to preserve those when present, 
+    # but prefix actual content with our prefix.
+    msg = "" if msg.nil? # regexp won't like nil, but will be okay with ""
+    matchData = ( /^(\n*)/.match(msg)  )    
+    matchData[0] + (@@format_str % [formatted_time, severity, matchData.post_match])
+  end    
+  
+end
+

data/lib/formatted_rails_logger/version.rb

@@ -0,0 +1,3 @@
+module FormattedRailsLogger
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: formatted_rails_logger
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jonathan Rochkind
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-04 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: 
+- jonathan@dnil.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- formatted_rails_logger.gemspec
+- lib/formatted_rails_logger.rb
+- lib/formatted_rails_logger/buffered_logger_inject.rb
+- lib/formatted_rails_logger/formatter.rb
+- lib/formatted_rails_logger/version.rb
+has_rdoc: true
+homepage: https://github.com/jrochkind/formatted_rails_logger
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: formatted_rails_logger
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Formatting capabilities for Rails BufferedLogger
+test_files: []
+