imprint 1.1.2 → 1.1.3

data/README.md

@@ -2,7 +2,7 @@
 
 Imprint helps track requests across multiple log lines or applications. It consists of a lightweight class and middleware to help set tracing ids.
 
-It also has a file which can be used to bootstrap default rails logging to embedding the imprint `trace_id` on each line logged. 
+It also has a file which can be used to bootstrap default rails logging to embedding the imprint `trace_id` on each line logged.
 
 Supporting tracing between applications requires updating client calls between applications, at the moment we don't try to monkey patch any of that in and expect responsible clients to add the header manually as described in the Usage section below.
 
@@ -10,55 +10,65 @@ Supporting tracing between applications requires updating client calls between a
 
 Add this line to your application's Gemfile:
 
-    gem 'imprint'
+```ruby
+gem 'imprint'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install imprint
-
+```bash
+$ gem install imprint
+```
 
 ## Usage
 
 After installing the gems and requiring them if needed.
 
-To configure in a Rails 3 or 4 application
+To configure in a Rails 2, 3, or 4 application
 
 edit `config/application.rb` and append the line below
 
-    require 'imprint/rails_logger'
-    
+```ruby
+require 'imprint/rails_logger'
+```
+
 create or update your middleware configuration (for example: `config/initializers/middleware.rb`)
 
-	```ruby
-	require 'imprint'
-    
-    Rails.application.config.middleware.insert_before Rails::Rack::Logger, Imprint::Middleware
-	```
-	
+```ruby
+require 'imprint'
+
+Rails.application.config.middleware.insert_before Rails::Rack::Logger, Imprint::Middleware
+```
+
 If you are using any additional loggers that you wanted tagged that are not part of the normal Rails.logger you should update them as well. For example, we have some scribe logs:
 
-    def log(message = nil, severity = :info)
-      mirror_logger.add(parse_severity(severity), message) if mirror_logger
-      log_raw(message, severity) do
-        message = yield if block_given?
-        # append imprint trace
-        if (defined?(Imprint::Middleware.get_trace_id)) && message && message.is_a?(String) && message.length > 1 && Imprint::Middleware.get_trace_id.get_trace_id.to_s != '-1'
-          message = "#{message}\n" unless message[-1] == "\n"
-          message = message.gsub("\n"," [trace_id=#{Imprint::Middleware.get_trace_id}]\n")
-        end
-        format = []
-        format << Time.now.to_f
-        format << @host
-        format << $$
-        format << format_severity(severity)
-        format << "app_name"
-        format << message
-        format.flatten.join("\t")
-      end
+```ruby
+def log(message = nil, severity = :info)
+  mirror_logger.add(parse_severity(severity), message) if mirror_logger
+  log_raw(message, severity) do
+    message = yield if block_given?
+    # append imprint trace
+    if (defined?(Imprint::Tracer.get_trace_id)) && message && message.is_a?(String) && message.length > 1 && Imprint::Tracer.get_trace_id.get_trace_id
+      message = "#{message}\n" unless message[-1] == "\n"
+      message = message.gsub("\n"," [trace_id=#{Imprint::Middleware.get_trace_id}]\n")
+    end
+    format = []
+    format << Time.now.to_f
+    format << @host
+    format << $$
+    format << format_severity(severity)
+    format << "app_name"
+    format << message
+    format.flatten.join("\t")
+  end
+end
+```
 
 ## Example Queries
 
@@ -77,9 +87,64 @@ Find all log lines in a particular app related to a single request:
 Find all long lines related to a single request across apps:
 
     "trace_id=1396448370_wdeYND"
-    
+
 Since the trace_id is appended to all log lines during the duration of the request, any `logger.info`, `logger.error`, or other log output is easy to track back to the initial request information, params, headers, or other system logged information such as if the request was successfully authorize and by whom.
 
+## Background Job Support
+
+We have a gateway wrapped about our Resque enqueue call. At this point I inject the trace_id. This makes it easy to ensure the job is queue with the params. So all failed jobs will include the trace_id
+
+```ruby
+options[:trace_id] ||= if (defined?(Imprint::Tracer)) && Imprint::Tracer.get_trace_id
+  Imprint::Tracer.get_trace_id
+else
+  nil
+end
+
+Resque.enqueue(klazz, options)
+```
+
+Once it is on the queue, I want to log the ID but remove it from the params as some jobs work direclty with an expected set of params.
+
+```ruby
+def before_perform(*args)
+	pluck_imprint_id
+	#any other before filters
+end
+
+def pluck_imprint_id
+  if defined?(Imprint::Tracer)
+    existing_id = params.delete(:trace_id)
+    Imprint::Tracer.set_trace_id(existing_id, {}) if existing_id
+    true
+  end
+end
+```
+
+The process of adding support to other background processing should be pretty similar.
+
+## Internal API Request Tracing (cross app tracing)
+
+If you want to trace requests that go across multiple applications Imprint can help you out here as well. Basically the middleware only generates a new trace_id if the incoming requests don't have a special Imprint header `HTTP_IMPRINTID`
+
+```ruby
+existing_id = rack_env[Imprint::Tracer::TRACER_HEADER]
+existing_id ||= "#{Time.now.to_i}_#{Imprint::Tracer.rand_trace_id}"
+Imprint::Tracer.set_trace_id(existing_id, rack_env)
+```
+
+To trace any requests made by a external facing app to internal APIs just inject the current `trace_id` into the header of the api request. Here is an example from a client gem. First we isolated all the requests to a single gem request gateway method `http_get`. Then in this example we are using `RestClient` so we just add the header to the outgoing request.
+
+```ruby
+def self.http_get(url)
+  if defined?(Imprint::Tracer) && Imprint::Tracer.get_trace_id
+    RestClient.get(url, { Imprint::Tracer::TRACER_KEY => Imprint::Tracer.get_trace_id})
+  else
+    RestClient.get(url)
+  end
+end
+```
+
 ## Contributing
 
 1. Fork it
@@ -88,6 +153,6 @@ Since the trace_id is appended to all log lines during the duration of the reque
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-## License 
+## License
 
-See LICENSE.txt for details.
+See LICENSE.txt for details.

data/lib/imprint.rb

@@ -3,8 +3,9 @@ require 'imprint/middleware'
 
 module Imprint
   class Tracer
-    TRACER_HEADER = 'HTTP_IMPRINTID'
-    TRACER_KEY    = 'IMPRINTID'
+    TRACER_HEADER    = 'HTTP_IMPRINTID'
+    TRACER_KEY       = 'IMPRINTID'
+    RAILS_REQUEST_ID = "action_dispatch.request_id"
 
     TRACE_CHARS = [('a'..'z'), ('A'..'Z')].map { |i| i.to_a }.flatten
 

data/lib/imprint/middleware.rb

@@ -2,7 +2,7 @@ module Imprint
   class Middleware
     
     def self.set_request_trace_id(rack_env)
-      existing_id = rack_env[Imprint::Tracer::TRACER_HEADER]
+      existing_id = rack_env[Imprint::Tracer::TRACER_HEADER] || rack_env[Imprint::Tracer::RAILS_REQUEST_ID]
       existing_id ||= "#{Time.now.to_i}_#{Imprint::Tracer.rand_trace_id}"
       Imprint::Tracer.set_trace_id(existing_id, rack_env)
     end

data/lib/imprint/version.rb

@@ -1,3 +1,3 @@
 module Imprint
-  VERSION = "1.1.2"
+  VERSION = "1.1.3"
 end

data/test/unit/middleware_test.rb

@@ -24,6 +24,24 @@ class MiddlewareTest < Test::Unit::TestCase
     assert ::Imprint::Tracer.get_trace_id!='-1'
   end
 
+  should "set trace_id from rails request_id" do
+    request = Rack::MockRequest.env_for("/anything.json", {"action_dispatch.request_id" => 'existing_id' })
+    middleware = Imprint::Middleware.new(fake_app)
+    results = middleware.call(request)
+    assert_equal "/anything.json", results.last
+    assert_not_nil ::Imprint::Tracer.get_trace_id
+    assert ::Imprint::Tracer.get_trace_id=='existing_id'
+  end
+
+  should "set trace_id from passed in imprint header" do
+    request = Rack::MockRequest.env_for("/anything.json", {"HTTP_IMPRINTID" => 'existing_trace_id' })
+    middleware = Imprint::Middleware.new(fake_app)
+    results = middleware.call(request)
+    assert_equal "/anything.json", results.last
+    assert_not_nil ::Imprint::Tracer.get_trace_id
+    assert ::Imprint::Tracer.get_trace_id=='existing_trace_id'
+  end
+
   private
 
   def fake_app

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imprint
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-07 00:00:00.000000000 Z
+date: 2014-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -144,7 +144,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3877856315896039498
+      hash: -2039852433245629427
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3877856315896039498
+      hash: -2039852433245629427
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23