lumber 0.12.3 → 0.13.0

data/CHANGELOG

@@ -1,3 +1,8 @@
+0.13.0 (08/10/2012)
+-------------------
+
+walk heirarchy of loggers/outputters when dynamically setting levels <704b4fa>
+
 0.12.3 (08/09/2012)
 -------------------
 

data/README.md

@@ -11,8 +11,9 @@ To use it in a rails project:
  * add lumber to your Gemfile
  * bundle install
  * run the lumber generator, rails generate lumber, to get a basic config/log4r.yml
- * enable lumber in your config/application.rb:
+ * enable lumber in your rails project
 
+To enable lumber in your rails project, add to your config/application.rb:
 
     # To expose custom variables in log4r.yml
     # config.lumber.some_option = "some_value
@@ -57,7 +58,7 @@ Lumber also comes with a Sinatra UI for dynamically overriding log levels at run
     require 'lumber/server'
     mount Lumber::Server, :at => "/lumber"
 
-This will allow you to temporarily set lower log levels for specific loggers - e.g. if you want a specific model to have DEBUG logging for the next hour.
+This will allow you to temporarily set lower log levels for specific loggers - e.g. if you want a specific model to have DEBUG logging for the next hour. Note that this behavior is enabled by a monitor thread running in your process, so if you want to be able to change the log levels for forked subprocesses (resque, passenger, unicorn, etc), you'll need to restart that thread in an after fork hook by calling Lumber::LevelUtil.start_monitor or use Lumber::LevelUtil.activate_levels for a oneoff activation without the thread.
 
 
 Copyright

data/lib/lumber/level_util.rb

@@ -36,6 +36,7 @@ module Lumber
     # @param [Hash] Logger fullname mapping to level name, e.g. {'rails::models::User' => 'DEBUG'}
     #
     def set_levels(levels)
+      levels = expand_heirarchy(levels)
       @cache_provider.write(LOG_LEVELS_KEY, levels, :expires_in => @ttl)
     end
     
@@ -52,7 +53,10 @@ module Lumber
       if levels.size == 0
         restore_levels
       else
+        
+        levels = expand_heirarchy(levels)
         backup_levels(levels.keys)
+        
         levels.each do |name, level|
           level_val = Log4r::LNAMES.index(level)
           outputter = Log4r::Outputter[name]
@@ -126,6 +130,31 @@ module Lumber
       end
     end
   
+    # walk the logger heirarchy and add all parents and outputters to levels
+    # so that the desired level of the child will take effect.  Doesn't override
+    # any logger/levels that already have a value
+    def expand_heirarchy(levels)
+      result = levels.clone
+      
+      levels.each do |name, level|
+        # only need to expand on loggers since outputter already in list
+        if  Log4r::Outputter[name].nil?
+          logger = Lumber.find_or_create_logger(name)
+          while logger
+            logger_name = logger.fullname
+            break if logger_name.nil?
+            result[logger_name] ||= level
+            logger.outputters.each do |o|
+              result[o.name] ||= level
+            end
+            logger = logger.parent
+          end
+        end
+      end
+      
+      return result
+    end
+        
     extend self
 
   end

data/lib/lumber/server/views/levels.erb

@@ -1,7 +1,7 @@
 
 <h1>Logger Levels</h1>
 <p>
-  The table below shows the log levels currently overriden.  You can add/remove overrides and apply them, and they will remain active for the given ttl.
+  The table below shows the log levels currently overriden.  You can add/remove overrides and apply them, and they will remain active for the given ttl.  Overrides will be applied for all parents of the given logger as well as their outputters.
 </p>
 
 <form action="<%= url(:levels) %>" method="POST">

data/lib/lumber/version.rb

@@ -1,3 +1,3 @@
 module Lumber
-  VERSION = "0.12.3"
+  VERSION = "0.13.0"
 end

data/spec/level_util_spec.rb

@@ -138,4 +138,94 @@ describe Lumber::LevelUtil do
     thread.join
   end
   
+  context "heirarchy of loggers" do
+    
+    before(:each) do
+      @parent_name = "parent_#{Time.now.to_f}"
+      @child_name = "#{@parent_name}::child_#{Time.now.to_f}"
+      @other_name = "other_#{Time.now.to_f}"
+    end
+  
+    it "sets levels for logger parents" do
+      Lumber.find_or_create_logger(@parent_name)
+      Lumber.find_or_create_logger(@child_name)
+      Lumber.find_or_create_logger(@other_name)
+      LevelUtil.set_levels({@child_name => "ERROR"})
+      Log4r::Logger[@parent_name].level.should == Log4r::LNAMES.index("DEBUG")
+      Log4r::Logger[@child_name].level.should == Log4r::LNAMES.index("DEBUG")
+      Log4r::Logger[@other_name].level.should == Log4r::LNAMES.index("DEBUG")
+      
+      LevelUtil.activate_levels
+      Log4r::Logger[@parent_name].level.should == Log4r::LNAMES.index("ERROR")
+      Log4r::Logger[@child_name].level.should == Log4r::LNAMES.index("ERROR")
+      Log4r::Logger[@other_name].level.should == Log4r::LNAMES.index("DEBUG")
+    end
+    
+    it "restores levels for logger parents when mapping expires" do
+      Lumber.find_or_create_logger(@parent_name)
+      Lumber.find_or_create_logger(@child_name)
+      Lumber.find_or_create_logger(@other_name)
+      LevelUtil.set_levels({@child_name => "ERROR"})
+      Log4r::Logger[@parent_name].level.should == Log4r::LNAMES.index("DEBUG")
+      Log4r::Logger[@child_name].level.should == Log4r::LNAMES.index("DEBUG")
+      Log4r::Logger[@other_name].level.should == Log4r::LNAMES.index("DEBUG")
+      
+      LevelUtil.activate_levels
+      Log4r::Logger[@parent_name].level.should == Log4r::LNAMES.index("ERROR")
+      Log4r::Logger[@child_name].level.should == Log4r::LNAMES.index("ERROR")
+      Log4r::Logger[@other_name].level.should == Log4r::LNAMES.index("DEBUG")
+      
+      LevelUtil.set_levels({})
+      LevelUtil.activate_levels
+      Log4r::Logger[@parent_name].level.should == Log4r::LNAMES.index("DEBUG")
+      Log4r::Logger[@child_name].level.should == Log4r::LNAMES.index("DEBUG")
+      Log4r::Logger[@other_name].level.should == Log4r::LNAMES.index("DEBUG")
+    end
+    
+    it "sets levels for logger and parent's outputters" do
+      parent_outputter = Log4r::IOOutputter.new("#{@parent_name}_sbout", StringIO.new)
+      child_outputter = Log4r::IOOutputter.new("#{@child_name}_sbout", StringIO.new)
+      other_outputter = Log4r::IOOutputter.new("#{@other_name}_sbout", StringIO.new)
+      
+      Lumber.find_or_create_logger(@parent_name).outputters = [parent_outputter]
+      Lumber.find_or_create_logger(@child_name).outputters = [child_outputter]
+      Lumber.find_or_create_logger(@other_name).outputters = [other_outputter]
+      LevelUtil.set_levels({@child_name => "ERROR"})
+      Log4r::Outputter["#{@parent_name}_sbout"].level.should == Log4r::LNAMES.index("DEBUG")
+      Log4r::Outputter["#{@child_name}_sbout"].level.should == Log4r::LNAMES.index("DEBUG")
+      Log4r::Outputter["#{@other_name}_sbout"].level.should == Log4r::LNAMES.index("DEBUG")
+      
+      LevelUtil.activate_levels
+      Log4r::Outputter["#{@parent_name}_sbout"].level.should == Log4r::LNAMES.index("ERROR")
+      Log4r::Outputter["#{@child_name}_sbout"].level.should == Log4r::LNAMES.index("ERROR")
+      Log4r::Outputter["#{@other_name}_sbout"].level.should == Log4r::LNAMES.index("DEBUG")
+    end
+    
+    it "restores levels for logger and parent's outputters when mapping expires" do
+      parent_outputter = Log4r::IOOutputter.new("#{@parent_name}_sbout", StringIO.new)
+      child_outputter = Log4r::IOOutputter.new("#{@child_name}_sbout", StringIO.new)
+      other_outputter = Log4r::IOOutputter.new("#{@other_name}_sbout", StringIO.new)
+      
+      Lumber.find_or_create_logger(@parent_name).outputters = [parent_outputter]
+      Lumber.find_or_create_logger(@child_name).outputters = [child_outputter]
+      Lumber.find_or_create_logger(@other_name).outputters = [other_outputter]
+      LevelUtil.set_levels({@child_name => "ERROR"})
+      Log4r::Outputter["#{@parent_name}_sbout"].level.should == Log4r::LNAMES.index("DEBUG")
+      Log4r::Outputter["#{@child_name}_sbout"].level.should == Log4r::LNAMES.index("DEBUG")
+      Log4r::Outputter["#{@other_name}_sbout"].level.should == Log4r::LNAMES.index("DEBUG")
+      
+      LevelUtil.activate_levels
+      Log4r::Outputter["#{@parent_name}_sbout"].level.should == Log4r::LNAMES.index("ERROR")
+      Log4r::Outputter["#{@child_name}_sbout"].level.should == Log4r::LNAMES.index("ERROR")
+      Log4r::Outputter["#{@other_name}_sbout"].level.should == Log4r::LNAMES.index("DEBUG")
+
+      LevelUtil.set_levels({})
+      LevelUtil.activate_levels
+      Log4r::Outputter["#{@parent_name}_sbout"].level.should == Log4r::LNAMES.index("DEBUG")
+      Log4r::Outputter["#{@child_name}_sbout"].level.should == Log4r::LNAMES.index("DEBUG")
+      Log4r::Outputter["#{@other_name}_sbout"].level.should == Log4r::LNAMES.index("DEBUG")
+    end
+    
+  end
+  
 end

data/spec/server_spec.rb

@@ -77,6 +77,30 @@ describe Lumber::Server, :type => :request do
     LevelUtil.get_levels.should == {"foo" => "DEBUG"}
   end
   
+  it "shows heirarchy overrides after assigning", :js => true do
+    @parent_name = "parent_#{Time.now.to_f}"
+    @child_name = "#{@parent_name}::child_#{Time.now.to_f}"
+    @other_name = "other_#{Time.now.to_f}"
+    Lumber.find_or_create_logger(@parent_name)
+    Lumber.find_or_create_logger(@child_name)
+    Lumber.find_or_create_logger(@other_name)
+    
+    LevelUtil.set_levels({})
+    
+    visit "/levels"
+    click_link('Add')
+    fill_in 'levels[][name]', :with => @child_name
+    fill_in 'levels[][level]', :with => "DEBUG"
+    click_button 'Apply'
+
+    page.should_not have_selector("div.alert-error")
+    
+    find(:xpath, "//input[@value='#{@child_name}']/ancestor::tr//input[@value='DEBUG']").should_not be_nil
+    find(:xpath, "//input[@value='#{@parent_name}']/ancestor::tr//input[@value='DEBUG']").should_not be_nil
+    
+    LevelUtil.get_levels.should == {@child_name => "DEBUG", @parent_name => "DEBUG"}
+  end
+  
   it "modifies level overrides", :js => true do
     LevelUtil.set_levels({"foo" => "INFO"})
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lumber
 version: !ruby/object:Gem::Version
-  version: 0.12.3
+  version: 0.13.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-09 00:00:00.000000000 Z
+date: 2012-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: log4r
@@ -235,7 +235,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2358509895133458004
+      hash: 2273159776171190626
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -244,7 +244,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2358509895133458004
+      hash: 2273159776171190626
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24