central_logger 0.3.0 → 0.3.1

data/Gemfile

@@ -1,7 +1,7 @@
 source "http://rubygems.org"
 
 gem "rake"
-gem "bundler", "~> 1.0.0"
+gem "bundler"
 gem "mongo"
 gem "bson_ext"
 

data/Gemfile.lock

@@ -1,23 +1,22 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.0.3)
+    activesupport (3.0.5)
     archive-tar-minitar (0.5.2)
-    bson (1.1.4)
-    bson_ext (1.1.4)
+    bson (1.2.4)
+    bson_ext (1.2.4)
     columnize (0.3.2)
     git (1.2.5)
     i18n (0.5.0)
-    jeweler (1.5.1)
+    jeweler (1.5.2)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
     linecache19 (0.5.11)
       ruby_core_source (>= 0.1.4)
-    mocha (0.9.10)
-      rake
-    mongo (1.1.4)
-      bson (>= 1.1.1)
+    mocha (0.9.12)
+    mongo (1.2.4)
+      bson (>= 1.2.4)
     rake (0.8.7)
     ruby-debug-base19 (0.11.24)
       columnize (>= 0.3.1)
@@ -37,7 +36,7 @@ PLATFORMS
 DEPENDENCIES
   activesupport
   bson_ext
-  bundler (~> 1.0.0)
+  bundler
   i18n
   jeweler (~> 1.5.0.pre5)
   mocha

data/README.md

@@ -36,7 +36,9 @@ Log to a central MongoDB from Rails apps.
             capsize: <%= 10.megabytes %>   # default: 250MB for production; 100MB otherwise
             host: localhost                # default: localhost
             port: 27017                    # default: 27017
-            replica_set: true              # default: false - Adds safe inserts and retries for ConnectionFailure during voting
+            replica_set: true              # default: false - Adds retries for ConnectionFailure during voting for replica set master
+            safe_insert: true              # default: false - Enable/Disable safe inserts (wait for insert to propagate to all nodes)
+            application_name: my_app       # default: Rails.application - Only really needed for non-capistrano Rails 2 deployments. Otherwise should set automatically.
 
     central_logger.yml:
 
@@ -80,7 +82,12 @@ Log to a central MongoDB from Rails apps.
           Rails.logger.add_metadata(:user_guid => @user_guid)
         end
 
-## Examples
+## Central Log Viewer
+
+  Please see the [central\_log\_viewer](https://github.com/customink/central_log_viewer):
+  a companion web application for querying and viewing your centralized logs.
+
+## Querying via the Rails console
 
 And now, for a couple quick examples on getting ahold of this log data...
 First, here's how to get a handle on the MongoDB from within a Rails console:
@@ -115,4 +122,4 @@ Find all requests with a request_date greater than '11/18/2010 22:59:52 GMT'
 
     >> collection.find({:request_time => {'$gt' => Time.utc(2010, 11, 18, 22, 59, 52)}})
 
-Copyright (c) 2009 Phil Burrows, released under the MIT license
+Copyright (c) 2009-2011 Phil Burrows and CustomInk, released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/central_logger.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{central_logger}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Phil Burrows", "Alex Stupka"]
-  s.date = %q{2010-12-08}
+  s.date = %q{2011-03-08}
   s.description = %q{Centralized logging for rails apps using MongoDB. The idea and the core code is from http://github.com/peburrows/central_logger}
   s.email = %q{astupka@customink.com}
   s.extra_rdoc_files = [
@@ -63,7 +63,7 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rake>, [">= 0"])
-      s.add_runtime_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_runtime_dependency(%q<bundler>, [">= 0"])
       s.add_runtime_dependency(%q<mongo>, [">= 0"])
       s.add_runtime_dependency(%q<bson_ext>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.0.pre5"])
@@ -74,7 +74,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<ruby-debug19>, [">= 0"])
     else
       s.add_dependency(%q<rake>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<bundler>, [">= 0"])
       s.add_dependency(%q<mongo>, [">= 0"])
       s.add_dependency(%q<bson_ext>, [">= 0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.0.pre5"])
@@ -86,7 +86,7 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<rake>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<bundler>, [">= 0"])
     s.add_dependency(%q<mongo>, [">= 0"])
     s.add_dependency(%q<bson_ext>, [">= 0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.0.pre5"])

data/lib/central_logger/mongo_logger.rb

@@ -12,6 +12,7 @@ module CentralLogger
     DEFAULT_COLLECTION_SIZE = 100.megabytes
     # Looks for configuration files in this order
     CONFIGURATION_FILES = ["central_logger.yml", "mongoid.yml", "database.yml"]
+    LOG_LEVEL_SYM = [:debug, :info, :warn, :error, :fatal, :unknown]
 
     attr_reader :db_configuration, :mongo_connection, :mongo_collection_name, :mongo_collection
 
@@ -36,12 +37,12 @@ module CentralLogger
     end
 
     def add(severity, message = nil, progname = nil, &block)
+      super
       if @level <= severity && message.present? && @mongo_record.present?
         # remove Rails colorization to get the actual message
         message.gsub!(/(\e(\[([\d;]*[mz]?))?)?/, '').strip! if logging_colorized?
-        @mongo_record[:messages][level_to_sym(severity)] << message
+        @mongo_record[:messages][LOG_LEVEL_SYM[severity]] << message
       end
-      super
     end
 
     # Drop the capped_collection and recreate it
@@ -57,7 +58,7 @@ module CentralLogger
         :application_name => @application_name
       })
 
-      runtime = Benchmark.measure{ yield }.real
+      runtime = Benchmark.measure{ yield }.real if block_given?
     rescue Exception => e
       add(3, e.message + "\n" + e.backtrace.join("\n"))
       # Reraise the exception for anyone else who cares
@@ -65,7 +66,13 @@ module CentralLogger
     ensure
       # In case of exception, make sure runtime is set
       @mongo_record[:runtime] = ((runtime ||= 0) * 1000).ceil
-      @insert_block.call
+      begin
+        @insert_block.call
+      rescue
+        # do extra work to inpect (and flatten)
+        force_serialize @mongo_record
+        @insert_block.call rescue nil
+      end
     end
 
     def authenticated?
@@ -82,19 +89,33 @@ module CentralLogger
 
       def configure
         default_capsize = Rails.env.production? ? PRODUCTION_COLLECTION_SIZE : DEFAULT_COLLECTION_SIZE
-        @application_name = Rails.root.basename.to_s
         @mongo_collection_name = "#{Rails.env}_log"
         @authenticated = false
         @db_configuration = {
           'host' => 'localhost',
           'port' => 27017,
           'capsize' => default_capsize}.merge(resolve_config)
+        @application_name = resolve_application_name
+        @safe_insert = @db_configuration['safe_insert'] || false
 
         @insert_block = @db_configuration.has_key?('replica_set') && @db_configuration['replica_set'] ?
-          lambda { rescue_connection_failure{ insert_log_record(true) } } :
+          lambda { rescue_connection_failure{ insert_log_record(@safe_insert) } } :
           lambda { insert_log_record }
       end
 
+      def resolve_application_name
+        if @db_configuration.has_key?('application_name')
+          @db_configuration['application_name']
+        elsif Rails::VERSION::MAJOR >= 3
+          Rails.application.class.to_s.split("::").first
+        else
+          # rails 2 requires detective work if it's been deployed by capistrano
+          # if last entry is a timestamp, go back 2 dirs (ex. /app_name/releases/20110304132847)
+          path = Rails.root.to_s.split('/')
+          path.length >= 4 && path.last =~ /^\d/ ? path.last(3)[0] : path.last
+        end
+      end
+
       def resolve_config
         config = {}
         CONFIGURATION_FILES.each do |filename|
@@ -137,17 +158,6 @@ module CentralLogger
         @mongo_collection.insert(@mongo_record, :safe => safe)
       end
 
-      def level_to_sym(level)
-        case level
-          when 0 then :debug
-          when 1 then :info
-          when 2 then :warn
-          when 3 then :error
-          when 4 then :fatal
-          when 5 then :unknown
-        end
-      end
-
       def logging_colorized?
         # Cache it since these ActiveRecord attributes are assigned after logger initialization occurs in Rails boot
         @colorized ||= Object.const_defined?(:ActiveRecord) &&
@@ -155,5 +165,18 @@ module CentralLogger
           ActiveRecord::LogSubscriber.colorize_logging :
           ActiveRecord::Base.colorize_logging)
       end
+
+      # force the data in the db by inspecting each top level array and hash element
+      # this will flatten other hashes and arrays
+      def force_serialize(rec)
+        if msgs = rec[:messages]
+          LOG_LEVEL_SYM.each do |i|
+            msgs[i].collect! { |j| j.inspect } if msgs[i]
+          end
+        end
+        if pms = rec[:params]
+          pms.each { |i, j| pms[i] = j.inspect }
+        end
+      end
   end # class MongoLogger
 end

data/test/config/samples/database.yml

@@ -4,3 +4,5 @@ test:
   database: database
   mongo:
     database: system_log
+    application_name: central_foo
+    safe_insert: true

data/test/rails.rb

@@ -1,3 +1,8 @@
+module CentralLogger
+  class Application
+  end
+end
+
 class Rails
   module VERSION
     MAJOR = 3
@@ -10,4 +15,8 @@ class Rails
   def self.root
     Pathname.new(File.dirname(__FILE__))
   end
+
+  def self.application
+    CentralLogger::Application.new
+  end
 end

data/test/test_helper.rb

@@ -26,6 +26,10 @@ class Test::Unit::TestCase
     end
   end
 
+  def log_params(msg)
+    @central_logger.mongoize({:params => msg})
+  end
+
   def log_exception(msg)
     @central_logger.mongoize({"id" => 1}) do
       raise msg

data/test/unit/central_logger_test.rb

@@ -1,5 +1,6 @@
 require 'test_helper'
 require 'central_logger/mongo_logger'
+require 'tempfile'
 
 # test the basic stuff
 class CentralLogger::MongoLoggerTest < Test::Unit::TestCase
@@ -76,6 +77,14 @@ class CentralLogger::MongoLoggerTest < Test::Unit::TestCase
           assert_equal "#{Rails.env}_log", @central_logger.mongo_collection_name
         end
 
+        should "set the application name when specified in the config file" do
+          assert_equal "central_foo", @central_logger.instance_variable_get(:@application_name)
+        end
+
+        should "set safe insert when specified in the config file" do
+          assert @central_logger.instance_variable_get(:@safe_insert)
+        end
+
         should "use the database name in the config file" do
           assert_equal "system_log", @central_logger.db_configuration['database']
         end
@@ -150,6 +159,16 @@ class CentralLogger::MongoLoggerTest < Test::Unit::TestCase
         assert_equal 1, @collection.find({"application" => self.class.name}).count
       end
 
+      should "not raise an exception when bson-unserializable data is logged in the :messages key" do
+        log(Tempfile.new("foo"))
+        assert_equal 1, @collection.count
+      end
+
+      should "not raise an exception when bson-unserializable data is logged in the :params key" do
+        log_params({:foo => Tempfile.new("bar")})
+        assert_equal 1, @collection.count
+      end
+
       context "when an exception is raised" do
         should "log the exception" do
           assert_raise(RuntimeError, EXCEPTION_MSG) {log_exception(EXCEPTION_MSG)}

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Phil Burrows
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-08 00:00:00 -05:00
+date: 2011-03-08 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -37,13 +37,11 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
-        - 0
         - 0
-        version: 1.0.0
+        version: "0"
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency