log_weasel 0.0.5 → 0.0.6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    log_weasel (0.0.5)
+    log_weasel (0.0.6)
       activesupport (~> 3.0)
 
 GEM
@@ -45,7 +45,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (~> 3.0)
   hoptoad_notifier
   log_weasel!
   mocha

data/README.md

@@ -1,7 +1,8 @@
 # Log Weasel
 
-Instrument Rails and Resque with shared transaction IDs so that you trace execution of a unit of work across
+Instrument Rails and Resque with shared transaction IDs to trace execution of a unit of work across
 applications and application instances.
+
 This particularly handy if you're using a system like <a href="http://www.splunk.com">Splunk</a> to manage your log
 files across many applications and application instances.
 
@@ -19,16 +20,31 @@ Use bundler to install it:
 bundle install
 </pre>
 
+## Configure
+
+In your application initialization (e.g. config/initializers/log_weasel.rb) load and configure Log Weasel with:
+
+<pre>
+LogWeasel.configure do |config|
+  config.key = "YOUR_APP"
+end
+<pre>
+
+<code>key</code> is a string that will be included in your transaction IDs and is particularly
+useful in an environment where a unit of work may span multiple applications.
+
 ## Rack
 
-Log Weasel provides Rack middleware to create and destroy a transaction for every HTTP request. You can use it
-in a any web framework that supports Rack (Rails, Sinatra,...)
+Log Weasel provides Rack middleware to create and destroy a transaction ID for every HTTP request. You can use it
+in a any web framework that supports Rack (Rails, Sinatra,...) by using <code>LogWeasel::Middleware</code> in your middleware
+stack.
 
 ### Rails 3
 
-To see Log Weasel transaction IDs in your Rails logs, you need to add the Rack middleware and
-either use the BufferedLogger provided or customize the formatting of your logger to include
-<code>LogWeasel::Transaction.id</code>.
+For Rails 3, we provide a Railtie that automatically registers the Rack middleware.
+
+All you need to see Log Weasel transaction IDs in your Rails logs is to either use the BufferedLogger provided or
+customize the formatting of your logger to include <code>LogWeasel::Transaction.id</code>.
 
 <pre>
 YourApp::Application.configure do
@@ -36,22 +52,12 @@ YourApp::Application.configure do
   config.logger                   = logger
   config.action_controller.logger = logger
   config.active_record.logger     = logger
-
-  config.middleware.insert_before Rails::Rack::Logger,
-                                  LogWeasel::Middleware, :key => 'YOUR_APP'
 end
 </pre>
 
-<code>:key</code> is an optional parameter that is useful in an environment where a unit of work may span multiple applications.
-
 ## Resque
 
-To see Log Weasel transaction IDs in your Resque logs, you need to need to initialize Log Weasel
-when you configure Resque, for example in a Rails initializer.
-
-<pre>
-LogWeasel::Resque.initialize! :key => 'YOUR_APP'
-</pre>
+When you configure Log Weasel as described above, it modifies Resque to include transaction IDs in all worker logs.
 
 Start your Resque worker with <code>VERBOSE=1</code> and you'll see transaction IDs in your Resque logs.
 
@@ -121,6 +127,18 @@ and our development log shows:
 [2011-02-14 14:37:10] YOUR_APP-RESQUE-a8e54bfb76718d09f8ed 48453 INFO EchoJob.perform: "hi from Rails console"
 </pre>
 
+and our resque log shows:
+
+<pre>
+***  got: (Job{default_queue} | EchoJob | ["hello from HelloController"] | {"log_weasel_id"=>"SAMPLE_APP-WEB-a65e45476ff2f5720e23"})
+***  Running after_fork hook with [(Job{default_queue} | EchoJob | ["hello from HelloController"] | {"log_weasel_id"=>"SAMPLE_APP-WEB-a65e45476ff2f5720e23"})]
+*** SAMPLE_APP-WEB-a65e45476ff2f5720e23 done: (Job{default_queue} | EchoJob | ["hello from HelloController"] | {"log_weasel_id"=>"SAMPLE_APP-WEB-a65e45476ff2f5720e23"})
+
+***  got: (Job{default_queue} | EchoJob | ["hi from Rails console"] | {"log_weasel_id"=>"SAMPLE_APP-RESQUE-00919a012476121cf89c"})
+***  Running after_fork hook with [(Job{default_queue} | EchoJob | ["hi from Rails console"] | {"log_weasel_id"=>"SAMPLE_APP-RESQUE-00919a012476121cf89c"})]
+*** SAMPLE_APP-RESQUE-00919a012476121cf89c done: (Job{default_queue} | EchoJob | ["hi from Rails console"] | {"log_weasel_id"=>"SAMPLE_APP-RESQUE-00919a012476121cf89c"})
+</pre>
+
 Units of work initiated from Resque, for example if using a scheduler like
 <a href="https://github.com/bvandenbos/resque-scheduler">resque-scheduler</a>,
 will include 'RESQUE' in the transaction ID to indicate that the work started in Resque.
@@ -131,6 +149,9 @@ If you would like to contribute a fix or integrate Log Weasel transaction tracki
 please fork the code, add the fix or feature in your local project and then send a pull request on github.
 Please ensure that you include a test which verifies your changes.
 
+## Authors
+
+<a href="http://github.com/asalant">Alon Salant</a> and <a href="http://github.com/brettfishman">Brett Fishman</a>.
 
 ## LICENSE
 

data/lib/log_weasel/middleware.rb

@@ -1,7 +1,7 @@
 class LogWeasel::Middleware
   def initialize(app, options = {})
     @app = app
-    @key = options[:key] ? "#{options[:key]}-WEB" : "WEB"
+    @key = LogWeasel.config.key ? "#{LogWeasel.config.key}-WEB" : "WEB"
   end
 
   def call(env)

data/lib/log_weasel/railtie.rb

@@ -0,0 +1,5 @@
+require 'rails'
+
+class LogWeasel::Railtie < Rails::Railtie
+  config.app_middleware.insert_before "::Rails::Rack::Logger", "LogWeasel::Middleware"
+end

data/lib/log_weasel/resque.rb

@@ -5,7 +5,7 @@ module LogWeasel::Resque
     ::Resque::Job.send(:include, LogWeasel::Resque::Job)
     ::Resque.extend(LogWeasel::Resque::ClassMethods)
 
-    key = options[:key] ? "#{options[:key]}-RESQUE" : "RESQUE"
+    key = LogWeasel.config.key ? "#{LogWeasel.config.key}-RESQUE" : "RESQUE"
 
     ::Resque.after_fork do |job|
       LogWeasel::Resque::Callbacks.after_fork job, key

data/lib/log_weasel/version.rb

@@ -1,5 +1,5 @@
 module Log
   module Weasel
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/lib/log_weasel.rb

@@ -3,8 +3,32 @@ require 'log_weasel/buffered_logger'
 require 'log_weasel/hoptoad_notifier'
 require 'log_weasel/middleware'
 require 'log_weasel/resque'
+require 'log_weasel/railtie' if defined? ::Rails::Railtie
 
-class << ::HoptoadNotifier
-  include LogWeasel::HoptoadNotifier;
-end if defined? ::HoptoadNotifier
 
+module LogWeasel
+  class Config
+    attr_accessor :key
+  end
+
+  def self.config
+    @@config ||= Config.new
+  end
+
+  def self.configure
+    yield self.config
+
+    if defined? ::HoptoadNotifier
+      class << ::HoptoadNotifier
+        include LogWeasel::HoptoadNotifier;
+      end
+    end
+
+    if defined? Resque
+      LogWeasel::Resque.initialize!
+    end
+
+  end
+end
+
+#Rails.application.class.to_s.split("::").first

data/spec/log_weasel/buffered_logger_spec.rb

@@ -1,5 +1,4 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-require 'log_weasel/buffered_logger'
 
 describe LogWeasel::BufferedLogger do
   before do

data/spec/log_weasel/hoptoad_notifier_spec.rb

@@ -1,13 +1,9 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 require 'hoptoad_notifier'
-require 'log_weasel/hoptoad_notifier'
 
 describe LogWeasel::HoptoadNotifier do
   before do
-    class << ::HoptoadNotifier
-      include LogWeasel::HoptoadNotifier;
-    end if defined? ::HoptoadNotifier
-
+    LogWeasel.configure {}
     HoptoadNotifier.configure {}
     LogWeasel::Transaction.stubs(:id).returns('123')
   end

data/spec/log_weasel/log_weasel_spec.rb

@@ -0,0 +1,16 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'resque'
+require 'log_weasel'
+
+describe LogWeasel do
+
+  describe ".configure" do
+    it "stores key" do
+      LogWeasel.configure do |config|
+        config.key = "KEY"
+      end
+      LogWeasel.config.key.should == "KEY"
+    end
+  end
+
+end

data/spec/log_weasel/resque_spec.rb

@@ -1,11 +1,10 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 require 'resque'
-require 'log_weasel/resque'
 
 describe LogWeasel::Resque do
 
   before do
-    LogWeasel::Resque.initialize! :key => 'FOO'
+    LogWeasel.configure { |config| config.key = "FOO" }
   end
   
   after do

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
-require 'log_weasel/transaction'
+require 'log_weasel'
 require 'rspec'
 
 require 'active_support/secure_random'

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: log_weasel
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 5
-  version: 0.0.5
+  prerelease: 
+  version: 0.0.6
 platform: ruby
 authors: 
 - Alon Salant
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-15 00:00:00 -08:00
+date: 2011-02-22 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,8 +20,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   prerelease: false
@@ -37,8 +31,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   prerelease: false
@@ -50,9 +42,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
         version: "1.0"
   type: :development
   prerelease: false
@@ -64,8 +53,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   prerelease: false
@@ -77,9 +64,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 0
         version: "3.0"
   type: :runtime
   prerelease: false
@@ -105,12 +89,14 @@ files:
 - lib/log_weasel/buffered_logger.rb
 - lib/log_weasel/hoptoad_notifier.rb
 - lib/log_weasel/middleware.rb
+- lib/log_weasel/railtie.rb
 - lib/log_weasel/resque.rb
 - lib/log_weasel/transaction.rb
 - lib/log_weasel/version.rb
 - log_weasel.gemspec
 - spec/log_weasel/buffered_logger_spec.rb
 - spec/log_weasel/hoptoad_notifier_spec.rb
+- spec/log_weasel/log_weasel_spec.rb
 - spec/log_weasel/resque_spec.rb
 - spec/log_weasel/transaction_spec.rb
 - spec/spec_helper.rb
@@ -128,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -994140046389382350
+      hash: 2735436436315165741
       segments: 
       - 0
       version: "0"
@@ -137,20 +123,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -994140046389382350
+      hash: 2735436436315165741
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: log_weasel
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
-summary: log_weasel-0.0.5
+summary: log_weasel-0.0.6
 test_files: 
 - spec/log_weasel/buffered_logger_spec.rb
 - spec/log_weasel/hoptoad_notifier_spec.rb
+- spec/log_weasel/log_weasel_spec.rb
 - spec/log_weasel/resque_spec.rb
 - spec/log_weasel/transaction_spec.rb
 - spec/spec_helper.rb