log_weasel 0.0.4 → 0.0.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    log_weasel (0.0.4)
+    log_weasel (0.0.5)
       activesupport (~> 3.0)
 
 GEM

data/README.md

@@ -1,6 +1,9 @@
 # Log Weasel
 
-Instrument Rails and Resque with shared transaction IDs so that you trace execution across 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.
+Instrument Rails and Resque with shared transaction IDs so that you 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.
 
 ## Installation
 
@@ -18,7 +21,8 @@ bundle install
 
 ## Rack
 
-Log Weasel provides Rack middleware to create and destroy a transaction for every HTTP request.
+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,...)
 
 ### Rails 3
 
@@ -38,17 +42,96 @@ YourApp::Application.configure do
 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! 'YOUR_APP'
+LogWeasel::Resque.initialize! :key => 'YOUR_APP'
+</pre>
+
+Start your Resque worker with <code>VERBOSE=1</code> and you'll see transaction IDs in your Resque logs.
+
+## Hoptoad
+
+If you are using <a href="http://hoptoadapp.com">Hoptoad</a>, Log Weasel will add the parameter <code>log_weasel_id</code>
+to Hoptoad errors so that you can track execution through your application stack that resulted in the error. No additional
+configuration required.
+
+## Example
+
+In this example we have a Rails app pushing jobs to Resque and a Resque worker that run with the Rails environment loaded.
+
+### HelloController
+
+<pre>
+class HelloController &lt; ApplicationController
+
+  def index
+    Resque.enqueue EchoJob, 'hello from HelloController'
+    Rails.logger.info("HelloController#index: pushed EchoJob")
+  end
+
+end
+</pre>
+
+### EchoJob
+
+<pre>
+class EchoJob
+  @queue = :default_queue
+
+  def self.perform(args)
+    Rails.logger.info("EchoJob.perform: #{args.inspect}")
+  end
+end
 </pre>
 
+Start Resque with:
+
+<pre>
+QUEUE=default_queue rake resque:work VERBOSE=1
+</pre>
+
+Requesting <code>http://localhost:3030/hello/index</code>, our development log shows:
+
+<pre>
+[2011-02-14 14:37:42] YOUR_APP-WEB-192587b585fa66b19638 48353 INFO
+
+Started GET "/hello/index" for 127.0.0.1 at 2011-02-14 14:37:42 -0800
+[2011-02-14 14:37:42] YOUR_APP-WEB-192587b585fa66b19638 48353 INFO   Processing by HelloController#index as HTML
+[2011-02-14 14:37:42] YOUR_APP-WEB-192587b585fa66b19638 48353 INFO HelloController#index: pushed EchoJob
+[2011-02-14 14:37:42] YOUR_APP-WEB-192587b585fa66b19638 48353 INFO Rendered hello/index.html.erb within layouts/application (1.8ms)
+[2011-02-14 14:37:42] YOUR_APP-WEB-192587b585fa66b19638 48353 INFO Completed 200 OK in 14ms (Views: 6.4ms | ActiveRecord: 0.0ms)
+[2011-02-14 14:37:45] YOUR_APP-WEB-192587b585fa66b19638 48461 INFO EchoJob.perform: "hello from HelloController"
+</pre>
+
+Fire up a Rails console and push a job directly with:
+
+<pre>
+> Resque.enqueue EchoJob, 'hi from Rails console'
+</pre>
+
+and our development log shows:
+
+<pre>
+[2011-02-14 14:37:10] YOUR_APP-RESQUE-a8e54bfb76718d09f8ed 48453 INFO EchoJob.perform: "hi from Rails console"
+</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.
+
+## Contributing
+
+If you would like to contribute a fix or integrate Log Weasel transaction tracking into another frameworks
+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.
 
 
 ## LICENSE
 
-Released under the MIT License. See the LICENSE file for further details.
+Copyright (c) 2011 Carbon Five. See LICENSE for details.

data/lib/log_weasel/middleware.rb

@@ -1,11 +1,11 @@
 class LogWeasel::Middleware
   def initialize(app, options = {})
     @app = app
-    @key = options[:key] || 'RAILS'
+    @key = options[:key] ? "#{options[:key]}-WEB" : "WEB"
   end
 
   def call(env)
-    LogWeasel::Transaction.create "#{@key}-WEB"
+    LogWeasel::Transaction.create @key
     @app.call(env)
   ensure
     LogWeasel::Transaction.destroy

data/lib/log_weasel/resque.rb

@@ -1,10 +1,12 @@
 module LogWeasel::Resque
 
-  def self.initialize!(key)
+  def self.initialize!(options = {})
     ::Resque::Worker.send(:include, LogWeasel::Resque::Worker)
     ::Resque::Job.send(:include, LogWeasel::Resque::Job)
     ::Resque.extend(LogWeasel::Resque::ClassMethods)
 
+    key = options[:key] ? "#{options[:key]}-RESQUE" : "RESQUE"
+
     ::Resque.after_fork do |job|
       LogWeasel::Resque::Callbacks.after_fork job, key
     end
@@ -19,12 +21,12 @@ module LogWeasel::Resque
       if job.context && job.context.has_key?('log_weasel_id')
         LogWeasel::Transaction.id = job.context['log_weasel_id']
       else
-        LogWeasel::Transaction.create "#{key}-RESQUE"
+        LogWeasel::Transaction.create key
       end
     end
 
     def self.before_push(queue, item, key)
-      item['context'] = {'log_weasel_id' => (LogWeasel::Transaction.id || LogWeasel::Transaction.create("#{key}-RESQUE"))}
+      item['context'] = {'log_weasel_id' => (LogWeasel::Transaction.id || LogWeasel::Transaction.create(key))}
     end
   end
 
@@ -56,7 +58,7 @@ module LogWeasel::Resque
 
   module Worker
     def log_with_transaction_id(message)
-      log_without_transaction_id "[#{LogWeasel::Transaction.id}] #{message}"
+      log_without_transaction_id "#{LogWeasel::Transaction.id} #{message}"
     end
 
     def self.included(base)

data/lib/log_weasel/version.rb

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

data/spec/log_weasel/resque_spec.rb

@@ -5,7 +5,7 @@ require 'log_weasel/resque'
 describe LogWeasel::Resque do
 
   before do
-    LogWeasel::Resque.initialize! 'FOO'
+    LogWeasel::Resque.initialize! :key => 'FOO'
   end
   
   after do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Alon Salant
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-14 00:00:00 -08:00
+date: 2011-02-15 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -128,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2275441745027611327
+      hash: -994140046389382350
       segments: 
       - 0
       version: "0"
@@ -137,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2275441745027611327
+      hash: -994140046389382350
       segments: 
       - 0
       version: "0"
@@ -147,7 +147,7 @@ rubyforge_project: log_weasel
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: log_weasel-0.0.4
+summary: log_weasel-0.0.5
 test_files: 
 - spec/log_weasel/buffered_logger_spec.rb
 - spec/log_weasel/hoptoad_notifier_spec.rb