imprint 1.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p484

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+source "http://geminabox.lsqa.net"
+
+# Specify your gem's dependencies in imprint.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Dan Mayer
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+# Imprint
+
+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. 
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'imprint'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install imprint
+
+
+## Usage
+
+After installing the gems and requiring them if needed.
+
+To configure in a Rails 3 or 4 application
+
+edit `config/application.rb` and append the line below
+
+    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
+	```
+	
+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
+
+## Example Queries
+
+These queries should work in Kibana/ElasticSearch, Splunk, or other log solutions. We may need to support different output formatters in the future depending on how various logging systems handle default field extraction.
+
+First query to find a group of requests you are particularly interested in, perhaps all errors on an app:
+
+    source="app_name" error status=500
+
+From the results find a specific request that caused the error and use the trace_id to dig in futher, by crafting a query with the trace_id.
+
+Find all log lines in a particular app related to a single request:
+
+    source="app_name" "trace_id=1396448370_wdeYND"
+
+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.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License 
+
+See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+task :default => :test
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/imprint.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'imprint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "imprint"
+  spec.version       = Imprint::VERSION
+  spec.authors       = ["Dan Mayer"]
+  spec.email         = ["dan.mayer@livingsocial.com"]
+  spec.description   = %q{A gem to help improve logging. Focused on request tracing and cross app tracing.}
+  spec.summary       = %q{A gem to help improve logging. Focused on request tracing and cross app tracing.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "mocha", "~> 0.14.0"
+  spec.add_development_dependency "shoulda"
+  spec.add_development_dependency "rack"
+  spec.add_development_dependency "simplecov"
+end

data/lib/imprint/middleware.rb

@@ -0,0 +1,20 @@
+module Imprint
+  class Middleware
+    
+    def self.set_trace_id(rails_env, rack_env)
+      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, rails_env, rack_env)
+    end
+    
+    def initialize(app, opts = {})
+      @app = app
+    end
+    
+    def call(env)
+      ::Imprint::Middleware.set_trace_id(ENV, env)
+      @app.call(env)
+    end
+
+  end
+end

data/lib/imprint/rails_logger.rb

@@ -0,0 +1,38 @@
+if defined?(ActiveSupport::BufferedLogger)
+  #Rails 3
+  module ActiveSupport
+    class BufferedLogger
+      def add(severity, message = nil, progname = nil, &block)
+        return if @level > severity
+        message = (message || (block && block.call) || progname).to_s
+        # If a newline is necessary then create a new message ending with a newline.
+        # Ensures that the original message is not mutated.
+        message = "#{message}\n" unless message[-1] == "\n"
+        if (defined?(Imprint::Tracer)) && message && message.is_a?(String) && message.length > 1 && Imprint::Tracer.get_trace_id
+          message = message.gsub("\n"," [trace_id=#{Imprint::Tracer.get_trace_id}]\n")
+        end
+        buffer << message
+        auto_flush
+        message
+      end
+    end
+  end
+
+end
+
+if defined?(ActiveSupport::Logger::SimpleFormatter)
+  #Rails 4
+  class ActiveSupport::Logger::SimpleFormatter
+    def call(severity, time, progname, message)
+      message = (message || (block && block.call) || progname).to_s
+      # If a newline is necessary then create a new message ending with a newline.
+      # Ensures that the original message is not mutated.
+      message = "#{message}\n" unless message[-1] == "\n"
+      if (defined?(Imprint::Tracer)) && message && message.is_a?(String) && message.length > 1 && Imprint::Tracer.get_trace_id
+        message = message.gsub("\n"," [trace_id=#{Imprint::Tracer.get_trace_id}]\n")
+      end
+      message
+    end
+  end
+
+end

data/lib/imprint/version.rb

@@ -0,0 +1,3 @@
+module Imprint
+  VERSION = "1.0.1"
+end

data/lib/imprint.rb

@@ -0,0 +1,26 @@
+require 'imprint/version'
+require 'imprint/middleware'
+
+module Imprint
+  class Tracer
+    TRACER_HEADER = 'HTTP_IMPRINTID'
+    TRACER_KEY    = 'IMPRINTID'
+
+    TRACE_CHARS = [('a'..'z'), ('A'..'Z')].map { |i| i.to_a }.flatten
+
+    def self.set_trace_id(id, rails_env, rack_env)
+      rails_env[TRACER_KEY] = id
+      rack_env[TRACER_KEY] = id
+    end
+
+    #this assumes the rails ENV is available at ENV
+    def self.get_trace_id(rails_env = ENV)
+      rails_env[TRACER_KEY]
+    end
+
+    def self.rand_trace_id
+      (0...6).map { TRACE_CHARS[rand(TRACE_CHARS.length)] }.join    
+    end
+    
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'simplecov'
+require 'test/unit'
+require 'shoulda'
+require 'mocha/setup'
+require 'rack'
+
+SimpleCov.start do
+  add_filter 'specs/ruby/1.9.1/gems/'
+  add_filter '/test/'
+  add_filter '/config/'
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+Mocha::Configuration.prevent(:stubbing_non_existent_method)
+
+require 'imprint'

data/test/unit/middleware_test.rb

@@ -0,0 +1,33 @@
+require File.expand_path('../test_helper', File.dirname(__FILE__))
+
+class MiddlewareTest < Test::Unit::TestCase
+
+  should "call app" do
+    request = Rack::MockRequest.env_for("/anything.json")
+    middleware = Imprint::Middleware.new(fake_app)
+    results = middleware.call(request)
+    assert_equal "/anything.json", results.last
+  end
+
+  should 'pass all rack lint checks' do
+    app = Rack::Lint.new(Imprint::Middleware.new(fake_app))
+    env = Rack::MockRequest.env_for('/hello')
+    app.call(env)
+  end
+
+  should "set trace_id before calling app" do
+    request = Rack::MockRequest.env_for("/anything.json")
+    middleware = Imprint::Middleware.new(fake_app)
+    results = middleware.call(request)
+    assert_equal "/anything.json", results.last
+    assert_not_nil ::Imprint::Tracer.get_trace_id(ENV)
+    assert ::Imprint::Tracer.get_trace_id(ENV)!='-1'
+  end
+
+  private
+
+  def fake_app
+    @app ||= lambda { |env| [200, {'Content-Type' => 'text/plain'}, env['PATH_INFO']] }
+  end
+
+end

data/test/unit/tracer_test.rb

@@ -0,0 +1,22 @@
+require File.expand_path('../test_helper', File.dirname(__FILE__))
+
+class TracerTest < Test::Unit::TestCase
+
+  should "set trace id" do
+    fake_trace = "tracer"
+    Imprint::Tracer.set_trace_id(fake_trace, ENV, {})
+    assert_equal fake_trace, Imprint::Tracer.get_trace_id(ENV)
+  end
+
+  should "get trace id defaults" do
+    assert_not_nil Imprint::Tracer.get_trace_id(ENV)
+  end
+
+  should "generate rand trace id" do
+    trace_id = Imprint::Tracer.rand_trace_id
+    assert_not_nil trace_id
+    assert_equal 6, trace_id.length
+    assert trace_id.match(/[A-Za-z]/)
+  end
+
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: imprint
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dan Mayer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem to help improve logging. Focused on request tracing and cross app
+  tracing.
+email:
+- dan.mayer@livingsocial.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- imprint.gemspec
+- lib/imprint.rb
+- lib/imprint/middleware.rb
+- lib/imprint/rails_logger.rb
+- lib/imprint/version.rb
+- test/test_helper.rb
+- test/unit/middleware_test.rb
+- test/unit/tracer_test.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2134087639551202536
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2134087639551202536
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+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/middleware_test.rb
+- test/unit/tracer_test.rb