central_logger 0.2.0 → 0.3.0

data/Gemfile.lock

@@ -1,22 +1,22 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.0.1)
+    activesupport (3.0.3)
     archive-tar-minitar (0.5.2)
-    bson (1.1.2)
-    bson_ext (1.1.2)
+    bson (1.1.4)
+    bson_ext (1.1.4)
     columnize (0.3.2)
     git (1.2.5)
-    i18n (0.4.2)
-    jeweler (1.5.0.pre5)
+    i18n (0.5.0)
+    jeweler (1.5.1)
       bundler (~> 1.0.0)
       git (>= 1.2.5)
       rake
     linecache19 (0.5.11)
       ruby_core_source (>= 0.1.4)
-    mocha (0.9.9)
+    mocha (0.9.10)
       rake
-    mongo (1.1.2)
+    mongo (1.1.4)
       bson (>= 1.1.1)
     rake (0.8.7)
     ruby-debug-base19 (0.11.24)

data/README.md

@@ -32,10 +32,11 @@ Log to a central MongoDB from Rails apps.
           database: my_app_development
           user: root
           mongo:
-            database: my_app               # required
+            database: my_app               # required (the only required setting)
             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
 
     central_logger.yml:
 
@@ -44,6 +45,7 @@ Log to a central MongoDB from Rails apps.
           capsize: <%= 10.megabytes %>
           host: localhost
           port: 27017
+          replica_set: true
 
   With that in place, a new MongoDB document (record) will be created for each request and,
   by default will record the following information: Runtime, IP Address, Request Time, Controller,
@@ -64,7 +66,7 @@ Log to a central MongoDB from Rails apps.
           'params'           : { },
           'path'             : path,
           'request_time'     : date_of_request,
-          'runtime'          : elapsed_execution_time_in_seconds,
+          'runtime'          : elapsed_execution_time_in_milliseconds,
           'url'              : full_url
         }
 
@@ -75,7 +77,7 @@ Log to a central MongoDB from Rails apps.
 
         # make sure we're using the CentralLogger in this environment
         if Rails.logger.respond_to?(:add_metadata)
-          Rails.logger.add_metadata(:user_guid =&gt; @user_guid)
+          Rails.logger.add_metadata(:user_guid => @user_guid)
         end
 
 ## Examples

data/Rakefile

@@ -54,7 +54,14 @@ namespace :test do
   desc "Run unit tests"
   Rake::TestTask.new(:units) do |test|
     test.libs << 'lib' << 'test'
-    test.pattern = 'test/unit/*_test.rb'
+    test.pattern = 'test/unit/central_logger_test.rb'
+    test.verbose = true
+  end
+
+  desc "Run replica set tests"
+  Rake::TestTask.new(:replica_set) do |test|
+    test.libs << 'lib' << 'test'
+    test.pattern = 'test/unit/central_logger_replica_test.rb'
     test.verbose = true
   end
 end

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/central_logger.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{central_logger}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   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-11-30}
+  s.date = %q{2010-12-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 = [
@@ -30,15 +30,18 @@ Gem::Specification.new do |s|
     "lib/central_logger/initializer_mixin.rb",
     "lib/central_logger/mongo_logger.rb",
     "lib/central_logger/railtie.rb",
+    "lib/central_logger/replica_set_helper.rb",
     "test/active_record.rb",
     "test/config/samples/central_logger.yml",
     "test/config/samples/database.yml",
+    "test/config/samples/database_replica_set.yml",
     "test/config/samples/database_with_auth.yml",
     "test/config/samples/mongoid.yml",
     "test/rails.rb",
     "test/shoulda_macros/log_macros.rb",
     "test/test.sh",
     "test/test_helper.rb",
+    "test/unit/central_logger_replica_test.rb",
     "test/unit/central_logger_test.rb"
   ]
   s.homepage = %q{http://github.com/customink/central_logger}
@@ -50,6 +53,7 @@ Gem::Specification.new do |s|
     "test/rails.rb",
     "test/shoulda_macros/log_macros.rb",
     "test/test_helper.rb",
+    "test/unit/central_logger_replica_test.rb",
     "test/unit/central_logger_test.rb"
   ]
 

data/lib/central_logger/mongo_logger.rb

@@ -2,15 +2,18 @@ require 'erb'
 require 'mongo'
 require 'active_support'
 require 'active_support/core_ext'
+require 'central_logger/replica_set_helper'
 
 module CentralLogger
   class MongoLogger < ActiveSupport::BufferedLogger
+    include ReplicaSetHelper
+
     PRODUCTION_COLLECTION_SIZE = 250.megabytes
     DEFAULT_COLLECTION_SIZE = 100.megabytes
     # Looks for configuration files in this order
     CONFIGURATION_FILES = ["central_logger.yml", "mongoid.yml", "database.yml"]
 
-    attr_reader :db_configuration, :mongo_connection, :mongo_collection_name
+    attr_reader :db_configuration, :mongo_connection, :mongo_collection_name, :mongo_collection
 
     def initialize(options={})
       path = options[:path] || File.join(Rails.root, "log/#{Rails.env}.log")
@@ -43,7 +46,7 @@ module CentralLogger
 
     # Drop the capped_collection and recreate it
     def reset_collection
-      @mongo_connection[@mongo_collection_name].drop
+      @mongo_collection.drop
       create_collection
     end
 
@@ -61,8 +64,8 @@ module CentralLogger
       raise e
     ensure
       # In case of exception, make sure runtime is set
-      runtime ||= 0
-      insert_log_record(runtime)
+      @mongo_record[:runtime] = ((runtime ||= 0) * 1000).ceil
+      @insert_block.call
     end
 
     def authenticated?
@@ -86,6 +89,10 @@ module CentralLogger
           'host' => 'localhost',
           'port' => 27017,
           'capsize' => default_capsize}.merge(resolve_config)
+
+        @insert_block = @db_configuration.has_key?('replica_set') && @db_configuration['replica_set'] ?
+          lambda { rescue_connection_failure{ insert_log_record(true) } } :
+          lambda { insert_log_record }
       end
 
       def resolve_config
@@ -123,11 +130,11 @@ module CentralLogger
         unless @mongo_connection.collection_names.include?(@mongo_collection_name)
           create_collection
         end
+        @mongo_collection = @mongo_connection[@mongo_collection_name]
       end
 
-      def insert_log_record(runtime)
-        @mongo_record[:runtime] = (runtime * 1000).ceil
-        @mongo_connection[@mongo_collection_name].insert(@mongo_record) rescue nil
+      def insert_log_record(safe=false)
+        @mongo_collection.insert(@mongo_record, :safe => safe)
       end
 
       def level_to_sym(level)

data/lib/central_logger/replica_set_helper.rb

@@ -0,0 +1,19 @@
+module CentralLogger
+  module ReplicaSetHelper
+    # Use retry alg from mongodb to gobble up connection failures during replica set master vote
+    # Defaults to a 10 second wait
+    def rescue_connection_failure(max_retries=40)
+      success = false
+      retries = 0
+      while !success
+        begin
+          yield
+          success = true
+        rescue Mongo::ConnectionFailure => e
+          raise e if (retries += 1) >= max_retries
+          sleep 0.25
+        end
+      end
+    end
+  end
+end

data/test/config/samples/database_replica_set.yml

@@ -0,0 +1,7 @@
+test:
+  adapter: mysql
+  username: user
+  database: database
+  mongo:
+    database: system_log
+    replica_set: true

data/test/test_helper.rb

@@ -17,6 +17,7 @@ class Test::Unit::TestCase
   DEFAULT_CONFIG = "database.yml"
   DEFAULT_CONFIG_WITH_AUTH = "database_with_auth.yml"
   MONGOID_CONFIG = "mongoid.yml"
+  REPLICA_SET_CONFIG = "database_replica_set.yml"
   LOGGER_CONFIG = "central_logger.yml"
 
   def log(msg)
@@ -33,10 +34,14 @@ class Test::Unit::TestCase
 
   def setup_for_config(source, dest=source)
     File.delete(File.join(CONFIG_DIR, DEFAULT_CONFIG))
-    FileUtils.cp(File.join(SAMPLE_CONFIG_DIR, source),  File.join(CONFIG_DIR, dest))
+    cp_config(source, dest)
     @central_logger.send(:configure)
   end
 
+  def cp_config(source, dest=source)
+    FileUtils.cp(File.join(SAMPLE_CONFIG_DIR, source),  File.join(CONFIG_DIR, dest))
+  end
+
   def teardown_for_config(file)
     File.delete(File.join(CONFIG_DIR, file))
   end

data/test/unit/central_logger_replica_test.rb

@@ -0,0 +1,45 @@
+require 'test_helper'
+require 'central_logger/mongo_logger'
+
+# test the basic stuff
+class CentralLogger::MongoLoggerReplicaTest < Test::Unit::TestCase
+  extend LogMacros
+
+  context "A CentralLogger::MongoLogger" do
+    setup do
+      # Can use different configs, but most tests use database.yml
+      cp_config(REPLICA_SET_CONFIG, DEFAULT_CONFIG)
+      @central_logger = CentralLogger::MongoLogger.new
+      @central_logger.reset_collection
+    end
+
+    context "upon trying to insert into a replica set voting on a new master" do
+      setup do
+        puts "Please disconnect the current master and hit ENTER"
+        STDIN.gets
+      end
+
+      should "insert a record successfully" do
+        assert_nothing_raised{ log("Test") }
+        @central_logger.rescue_connection_failure do
+          assert_equal 1, @central_logger.mongo_collection.count
+        end
+      end
+
+      teardown do
+        puts "Please reconnect the current master, wait for the vote to complete, then hit ENTER"
+        STDIN.gets
+      end
+    end
+
+    should "insert a record successfully" do
+      assert_nothing_raised{ log("Test") }
+      assert_equal 1, @central_logger.mongo_collection.count
+    end
+
+    teardown do
+      file = File.join(CONFIG_DIR, DEFAULT_CONFIG)
+      File.delete(file) if File.exist?(file)
+    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: 
 - Phil Burrows
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-30 00:00:00 -05:00
+date: 2010-12-08 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -176,15 +176,18 @@ files:
 - lib/central_logger/initializer_mixin.rb
 - lib/central_logger/mongo_logger.rb
 - lib/central_logger/railtie.rb
+- lib/central_logger/replica_set_helper.rb
 - test/active_record.rb
 - test/config/samples/central_logger.yml
 - test/config/samples/database.yml
+- test/config/samples/database_replica_set.yml
 - test/config/samples/database_with_auth.yml
 - test/config/samples/mongoid.yml
 - test/rails.rb
 - test/shoulda_macros/log_macros.rb
 - test/test.sh
 - test/test_helper.rb
+- test/unit/central_logger_replica_test.rb
 - test/unit/central_logger_test.rb
 has_rdoc: true
 homepage: http://github.com/customink/central_logger
@@ -223,4 +226,5 @@ test_files:
 - test/rails.rb
 - test/shoulda_macros/log_macros.rb
 - test/test_helper.rb
+- test/unit/central_logger_replica_test.rb
 - test/unit/central_logger_test.rb