rack-instruments 0.1.10 → 0.2.0

data/lib/rack/instruments.rb

@@ -1,59 +1,64 @@
+require "securerandom"
 require "slides"
 
 module Rack
   class Instruments
-    def initialize(app)
+    UUID_PATTERN =
+      /\A[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}\Z/
+
+    def initialize(app, options={})
       @app = app
+
+      @context              = (options[:context] || {}).
+        map { |k, v| [k, v] }
+      @header_request_ids   = options.fetch(:header_request_ids, true)
+      @ignore_extensions    = options.fetch(:ignore_extensions,
+        %w{css gif ico jpg js jpeg pdf png})
+      @request_id_generator = options.fetch(:request_id_generator,
+        lambda { SecureRandom.uuid })
+      @request_id_pattern   = options.fetch(:request_id_pattern, UUID_PATTERN)
     end
 
     def call(env)
       return @app.call(env) \
-        if self.class.ignore_extensions.any? { |ext|
+        if @ignore_extensions && @ignore_extensions.any? { |ext|
           env["REQUEST_PATH"] =~ /\.#{ext}$/
         }
 
-      request_id = self.class.id_generator.call
+      request_ids = [@request_id_generator.call] + extract_request_ids(env)
       status, headers, response = nil, nil, nil
 
       # make ID of the request accessible to consumers down the stack
-      env["REQUEST_ID"] = request_id
-
-      data = {
-        :method => env["REQUEST_METHOD"],
-        :path   => env["REQUEST_PATH"],
-        :ip     => env["X-FORWARDED-FOR"] || env["HTTP_X_FORWARDED_FOR"] ||
-          env["REMOTE_ADDR"],
-        :id     => request_id,
-        :status => lambda { status }
-      }
-      data.merge!(self.class.context) if self.class.context
-
-      Slides.log(:instrumentation, data) do
+      env["REQUEST_ID"] = request_ids
+
+      data = [
+        [:method, env["REQUEST_METHOD"]],
+        [:path, env["REQUEST_PATH"]],
+        [:ip, env["X-FORWARDED-FOR"] || env["HTTP_X_FORWARDED_FOR"] ||
+          env["REMOTE_ADDR"]],
+        [:status, lambda { status }],
+      ]
+      data += request_ids.map { |id| [:id, id] }
+      data += @context if @context
+
+      Slides.log_array(:instrumentation, data) do
         status, headers, response = @app.call(env)
       end
 
       [status, headers, response]
     end
-  end
-
-  module InstrumentsConfig
-    def self.extended(base)
-      base.context           = nil
-      base.id_generator      = lambda { rand(36**8).to_s(36) }
-      base.ignore_extensions = %w{css gif ico jpg js jpeg pdf png}
-    end
 
-    attr_accessor :context
-    attr_accessor :id_generator
-    attr_accessor :ignore_extensions
+    private
 
-    def configure
-      yield self
-    end
-
-    def ignore_extensions
-      @ignore_extensions || []
+    def extract_request_ids(env)
+      return [] unless @header_request_ids
+      request_ids = []
+      if env["HTTP_REQUEST_ID"]
+        request_ids = env["HTTP_REQUEST_ID"].split(",")
+        request_ids.map! { |id| id.strip }
+        request_ids.select! { |id| id =~ @request_id_pattern }
+      end
+      request_ids
     end
   end
-  Instruments.extend(InstrumentsConfig)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-instruments
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-17 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slides
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.9
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.9
+        version: 0.2.0
 description: 
 email: brandur@mutelight.org
 executables: []
@@ -55,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Rack middleware providing extremely basic instrumentation.