imprint 1.1.3 → 1.1.4

data/README.md

@@ -6,6 +6,8 @@ It also has a file which can be used to bootstrap default rails logging to embed
 
 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.
 
+If you have seen [ActionDispatch::RequestId](http://api.rubyonrails.org/classes/ActionDispatch/RequestId.html). Imprint is basically a generic Rack version of that idea. It works with Rails 3, Sinatra, and Pure Rack. Beyond that it also provides some helpers and configuration around the trace_id usage.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -145,6 +147,17 @@ def self.http_get(url)
 end
 ```
 
+## Notes / TODO
+
+Looking at ZipKin, it tries to accomplish many of the same goals as Imprint. I think it would make sence to support the same headers and format so they could be compatible. Although the ZipKin service tracing isn't as useful to me as the full detailed splunk / elastic search logs.
+
+* [ZipKin intro / docs](http://twitter.github.io/zipkin/index.html)
+* [Railsconf ZipKin intro: Distributed Request Tracing](http://www.confreaks.com/videos/3326-railsconf-distributed-request-tracing) by [Kenneth Hoxworth (@hoxworth)](https://twitter.com/hoxworth)
+* [ZipKin Header Formats](https://github.com/twitter/finagle/blob/master/finagle-http/src/main/scala/com/twitter/finagle/http/Codec.scala#L216)
+* [Existing Ruby ZipKin Tracer](https://github.com/mszenher/zipkin-tracer)
+* [Twitter Minimal Zipkin Tracer](https://github.com/twitter/zipkin/tree/04a755c29e6b2ff3bd99534bb95d760f112fda08/zipkin-gems/zipkin-tracer)
+* [Docker ZipKin install for testing](https://github.com/itszero/docker-zipkin)
+
 ## Contributing
 
 1. Fork it

data/lib/imprint/log_helpers.rb

@@ -0,0 +1,39 @@
+module Imprint
+  module LogHelpers
+
+    # Not relying on default rails logging, more often using lograge
+    # Still want to log incoming params safely, which lograge doesn't include
+    # this does the same sensative param filtering as rails defaults
+    # it also allows injecting some other variables useful for tracing logs
+    def log_entrypoint
+      raise "you must call Imprint.configuration and configure the gem before using LogHelpers" if Imprint.configuration.nil?
+      log_filter = ActionDispatch::Http::ParameterFilter.new(Imprint.configuration[:log_filters] || Rails.application.config.filter_parameters)
+      header_blacklist = Imprint.configuration[:header_blacklist] || []
+      variables_to_append = Imprint.configuration[:variables_to_append] || []
+      cookies_whitelist = Imprint.configuration[:cookies_whitelist] || []
+
+      http_request_headers = request.headers.select{|header_name, header_value| header_name.match("^HTTP.*") && !header_blacklist.include?(header_name) }
+      data_append = "headers: "
+      http_request_headers.each_pair{|k,v| data_append << " #{k}=\"#{v}\"" }
+
+      data_append << " params: "
+      log_filter.filter(params).each_pair{|k,v| data_append << " #{k}=\"#{v}\"" }
+      
+      variables_to_append.each do |var|
+                           var_val = self.instance_variable_get("@#{var}".to_sym).try(:id)
+                           var_val ||= 'nil'
+                           data_append << " #{var}_id=\"#{var_val}\""
+                         end
+      
+      cookies_whitelist.each do |cookie_key|
+                         cookie_val = cookies[cookie_key] ? cookies[cookie_key] : 'nil'
+                         data_append << " #{cookie_key}=\"#{cookie_val}\""
+                       end
+
+      logger.info "Started request_method=#{request.method.inspect} request_url=\"#{request.url.inspect}\" at request_time=\"#{Time.now.to_default_s}\" request_ip=#{request.remote_ip.inspect} #{data_append}"
+    rescue
+      logger.error "error logging log_entrypoint for request"
+    end
+
+  end
+end

data/lib/imprint/tracer.rb

@@ -0,0 +1,23 @@
+module Imprint
+  class Tracer
+    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
+
+    def self.set_trace_id(id, rack_env = {})
+      Thread.current[TRACER_KEY] = id
+      # setting to the rack_env, gives error tracking support in some systems
+      rack_env[TRACER_KEY] = id
+    end
+
+    def self.get_trace_id
+      Thread.current[TRACER_KEY]
+    end
+
+    def self.rand_trace_id
+      (0...6).map { TRACE_CHARS[rand(TRACE_CHARS.length)] }.join    
+    end
+  end
+end

data/lib/imprint/version.rb

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

data/lib/imprint.rb

@@ -1,27 +1,16 @@
 require 'imprint/version'
 require 'imprint/middleware'
+require 'imprint/tracer'
 
 module Imprint
-  class Tracer
-    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
-
-    def self.set_trace_id(id, rack_env = {})
-      Thread.current[TRACER_KEY] = id
-      # setting to the rack_env, gives error tracking support in some systems
-      rack_env[TRACER_KEY] = id
-    end
-
-    def self.get_trace_id
-      Thread.current[TRACER_KEY]
-    end
+  class << self
+    attr_accessor :configuration
+  end
 
-    def self.rand_trace_id
-      (0...6).map { TRACE_CHARS[rand(TRACE_CHARS.length)] }.join    
-    end
-    
+  def self.configure(configs = {})
+    self.configuration ||= {}
+    self.configuration = configuration.merge(configs)
   end
+
 end

data/test/unit/log_helpers_test.rb

@@ -0,0 +1,92 @@
+require File.expand_path('../test_helper', File.dirname(__FILE__))
+require 'imprint/log_helpers'
+
+####
+# Testing Rails integration without Rails isn't fun
+# The below test double classes let us do that.
+# along with the implemented fakes as protected methods
+####
+module ActionDispatch
+  module Http
+    class ParameterFilter
+      def initialize(opts)
+      end
+
+      def filter(params)
+        params
+      end
+    end
+  end
+end
+
+class Rails
+  def self.application
+  end
+end
+
+class Time
+  def to_default_s
+    self.to_s
+  end
+end
+
+class LogHelpersTest < Test::Unit::TestCase
+  include Imprint::LogHelpers
+  Imprint.configure({})
+
+  should "log entry" do
+    stub_rails
+    logger.expects(:info).with(anything).once
+    log_entrypoint
+  end
+
+  should "log entry catches exceptions and logs them" do
+    logger.expects(:error).with(anything).once
+    log_entrypoint
+  end
+
+  protected
+
+  def request
+    request = Rack::MockRequest.env_for("/anything.json")
+
+    def request.headers
+      {}
+    end
+
+    def request.method
+      {}
+    end
+
+    def request.url
+      ''
+    end
+
+    def request.remote_ip
+      ''
+    end
+
+    request
+  end
+
+  def params
+    {}
+  end
+
+  def stub_rails
+    rails_config ||= mock('config')
+    rails_config.stubs(:filter_parameters).returns([])
+    rails_app ||= mock('application')
+    rails_app.stubs(:config).returns(rails_config)
+    Rails.stubs(:application).returns(rails_app)
+  end
+
+  def logger
+    @fake_log ||= mock('logger')
+  end
+
+  def cookies
+    {}
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: imprint
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-19 00:00:00.000000000 Z
+date: 2014-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -123,10 +123,13 @@ files:
 - Rakefile
 - imprint.gemspec
 - lib/imprint.rb
+- lib/imprint/log_helpers.rb
 - lib/imprint/middleware.rb
 - lib/imprint/rails_logger.rb
+- lib/imprint/tracer.rb
 - lib/imprint/version.rb
 - test/test_helper.rb
+- test/unit/log_helpers_test.rb
 - test/unit/middleware_test.rb
 - test/unit/tracer_test.rb
 homepage: ''
@@ -144,7 +147,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2039852433245629427
+      hash: -3977275337200593217
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -153,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2039852433245629427
+      hash: -3977275337200593217
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -162,5 +165,6 @@ specification_version: 3
 summary: A gem to help improve logging. Focused on request tracing and cross app tracing.
 test_files:
 - test/test_helper.rb
+- test/unit/log_helpers_test.rb
 - test/unit/middleware_test.rb
 - test/unit/tracer_test.rb