marcopolo 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 273c7f6bc3a4dc54e700b022bf0d079789f23ee2
-  data.tar.gz: c38e36b80fe9b021019a66e6d47ebdbb80553157
+  metadata.gz: afc67f4a1453ec6bb4f6eee5c4416c72f8b9b9e1
+  data.tar.gz: f1f2349517951a120298d76dcf9e40b0db217161
 SHA512:
-  metadata.gz: bc4bf97a33318d3df0cfcc456048bf8fd262a728a354c53d244febd31b3b87883dc146a92639f1d84b34f4d2736407d20559eddf5aa7510712d985d4efc8228e
-  data.tar.gz: 42199344fafdb02820dc276bf15f1fe1eb44b064819612690798461595a61de86b3e8ae608dc2fb06c25a97056e45b7c0d801fdaff2d58fd3b9370c1e73f26f7
+  metadata.gz: bee378b9d266328c4be7a3a196e0b44b3d3b31c5795caf1674bc1d2862188badfd90267954cf624ee8921a5f04447e71781d5847449c575960edbcfc231eef4c
+  data.tar.gz: 61b0b157dafd8cca699c0f49ded943f9087f464e53a9d1764201c793804ad9442062f3d4dddf3c2465f04758d2db0d3fa37be07d87f1b6663e10d32d0ae4db5f

data/README.md

@@ -21,14 +21,22 @@ Configure the logger settings in a Rails initializer like so:
     Marcopolo.options[:logger] = Logger.new(File.join(Rails.root, 'log', "#{Rails.env}-http-raw.log"))
     Marcopolo.options[:severity] = Logger::Severity::DEBUG
 
-Consider adding logrote rules to your application server to prevent these extremely verbose logs from blowing up your storage.
+Consider adding logrotate rules to your application server to prevent these extremely verbose logs from blowing up your storage.
 
 Also, be mindful of cleaning up these logs appropriately, as sensative information like authorization headers and cookies will not be filtered out automatically (hence "raw").
 
+### Filtering out noise
+
+You may want to filter out noisy requests, such as health checks. Create a proc that takes a [Rack::Request](http://rack.rubyforge.org/doc/classes/Rack/Request.html) object and returns `true` if the request is desirable and `false` if the request should be excluded from the log.
+
+    Marcopolo.options[:filter] = Proc.new do |request|
+      # exclude all options requests
+      request.request_method != 'OPTIONS']
+    end
+
 ## TODO
 
 * Support for Sinatra?
-* Noise filters?
 * Ability to disable for certain endpoints, etc
 * IP-based log segmenting?
 * Tests?

data/lib/marcopolo.rb

@@ -6,7 +6,8 @@ module Marcopolo
   DEFAULT_LOGGER  = Logger.new($stdout)
   DEFAULT_OPTIONS = {
     logger: DEFAULT_LOGGER,
-    severity: Logger::Severity::DEBUG
+    severity: Logger::Severity::DEBUG,
+    filter: Proc.new {|request| true }
   }
 
   class << self
@@ -17,5 +18,9 @@ module Marcopolo
     def log(msg)
       options[:logger].add(options[:severity]) { msg }
     end
+
+    def allow(request)
+      options[:filter].call(request)
+    end
   end
 end

data/lib/marcopolo/middleware.rb

@@ -5,45 +5,59 @@ module Marcopolo
     end
 
     def call(env)
-      req = Rack::Request.new(env)
+      @request = Rack::Request.new(env)
 
+      @status, @headers, @response = @app.call(env)
+
+      if Marcopolo.allow(@request)
+        begin
+          rawlog(env)
+        rescue => e
+          Marcopolo.log "Failed to log request: #{e.message}"
+        end
+      else
+        Marcopolo.log "Filtering request: #{@request.request_method} #{@request.url}"
+      end
+
+      return [@status, @headers, @response]
+    end
+
+    def rawlog(env)
       req_headers = env.select {|k,v| k.start_with? 'HTTP_'}
         .collect {|pair| [pair[0].sub(/^HTTP_/, '').split('_').map(&:titleize).join('-'), pair[1]]}
         .sort
 
       req_hash = {
         "REQUEST" => "",
-        "Remote Address" => req.ip,
-        "Request URL" => req.url,
-        "Request Method" => req.request_method,
+        "Remote Address" => @request.ip,
+        "Request URL" => @request.url,
+        "Request Method" => @request.request_method,
         "REQUEST HEADERS" => ""
       }
 
       req_headers.to_a.each {|i| req_hash["\t" + i.first] = i.last }
 
       req_hash.merge!({
-        "Request Body" => req.body.gets
+        "Request Body" => @request.body.gets
       })
 
       Marcopolo.log req_hash.to_a.map {|o| o.join(': ') }.join("\n") + "\n"
 
-      status, headers, response = @app.call(env)
-
       resp_hash = {
         "RESPONSE" => "",
-        "Response Status" => response.status,
+        "Response Status" => @status,
         "Response Headers" => ""
       }
 
-      response.headers.to_a.each {|i| resp_hash["\t" + i.first] = i.last }
+      @headers.to_a.each {|i| resp_hash["\t" + i.first] = i.last }
+
+      response_body = @response.respond_to?(:body) ? @response.body : @response
 
       resp_hash.merge!({
-        "Response Body" => response.body
+        "Response Body" => response_body
       })
 
       Marcopolo.log resp_hash.to_a.map {|o| o.join(': ') }.join("\n") + "\n"
-
-      return [status, headers, response]
     end
   end
 end

data/lib/marcopolo/version.rb

@@ -1,3 +1,3 @@
 module Marcopolo
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marcopolo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Andrew Hammond
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-05 00:00:00.000000000 Z
+date: 2014-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler