rack-ltsv_logger 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b877c1c1d148d33b66c580fb4112e6ce9dad1e5
-  data.tar.gz: 2bff1571091b41b391d4be16fc5d99f94fd9a06c
+  metadata.gz: a1e425b4056ae88b13545afbafc09630770bb961
+  data.tar.gz: d1bbfafa0e9ed39093083857ef3eeed2f8e70769
 SHA512:
-  metadata.gz: d35ba9ab66040d12fed2f30130644787f03ef29cf926ffc3408269e898c4364cb88d5ae9371617a9b10ca76e8877ffde1650721a0aaf76591d3469cb1e52bd1c
-  data.tar.gz: cd511826a96aa9bc77249fed37ed939aa134b7db18762b4a94362e5cf12a24af73cfef56858cfc9ba333054b9f7ec7010df6637bc7c2d33b06877b07948cc680
+  metadata.gz: 0a872d0e0b701ef967bfcc71bc970b9cfc6f552c78ead1e5059da4fe4fe2f98f8606ac103e420f0ed4414148f6dcb30450a9986a6dbe4d5f1bdf5b92107ded24
+  data.tar.gz: 3117c5f5154c37587b7a767628a4c12280d758a5893acfdc3c08b747db2298b7b55b3e8abd682ddf22074c9aac5aba1440c428d935afd29262136489c0511ce9

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 0.0.2  (2016/02/19)
+
+Enhancements:
+
+* Ensure to log even if `@app.call` raises an error (thanks to @sugilog)
+
+## 0.0.1  (2014/07/02)
+
+First release

data/README.md

@@ -8,14 +8,16 @@ cf. https://speakerdeck.com/mirakui/high-performance-rails-long-edition
 
 <img src="doc/x_runtime.png" alt="x_runtime" width="50%" height="50%"/>
 
-The Completed Time does not include routing time, and elapsed time on rack middleware layers, and so on.
-To measure the processing time accurately, it is necessary to insert a rack middleware to measure the time. 
+The Completed Time, which the default logger of rails shows,
+does not include the routing time, and the elapsed time on rack middleware layers.
+To measure the processing time accurately,
+it is necessary to insert a rack middleware at the head of rack middleware stacks.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'rack-ltsvlogger'
+    gem 'rack-ltsv_logger'
 
 And then execute:
 
@@ -25,22 +27,26 @@ And then execute:
 
 Insert Rack::LtsvLogger on the head of rack middlewares. 
 
-Rails)
-
-Add following to config/environments/[env].rb
+### Rails
 
 ```ruby
-require 'rack/ltsvlogger'
-require 'logger'
+# config/application.rb
+class Application < Rails::Application
+  config.middleware.insert_after(0, Rack::LtsvLogger, $stdout)
+end
+```
 
-config.middleware.insert_after(0, Rack::LtsvLogger, $stdout)
+Middleware check.
+
+```
+bundle exec rake middleware
 ```
 
-Sinatra)
+### Sinatra
 
 ```ruby
 # config.ru
-require 'rack/ltsvlogger'
+require 'rack/ltsv_logger'
 
 use Rack::LtsvLogger, $stdout
 run App
@@ -48,11 +54,21 @@ run App
 
 ## Format
 
-Sample (line feeded):
+Sample (line feeded, but actually tab seperated):
 
 ```
-time:2014-07-02T21:52:31+09:00  pid:15189       host:127.0.0.1  forwardedfor:127.0.0.2  user:user
-method:GET      uri:/get        query:?foo      protocol:HTTP/1.1       status:200      size:-  reqtime:0.000000
+time:2014-07-02T21:52:31+09:00
+pid:15189
+host:127.0.0.1
+forwardedfor:127.0.0.2
+user:user
+method:GET
+uri:/get
+query:?foo
+protocol:HTTP/1.1
+status:200
+size:-
+reqtime:0.000000
 ```
 
 ### Default Fields

data/lib/rack/ltsv_logger.rb

@@ -14,7 +14,7 @@ module Rack
       began_at = Time.now.instance_eval { to_i + (usec/1000000.0) }
 
       status, headers, body = @app.call(env)
-
+    ensure
       now = Time.now
       reqtime = now.instance_eval { to_i + (usec/1000000.0) } - began_at
 
@@ -28,7 +28,7 @@ module Rack
         uri: env["PATH_INFO"],
         query: env["QUERY_STRING"].empty? ? "" : "?"+env["QUERY_STRING"],
         protocol: env["HTTP_VERSION"],
-        status: status.to_s[0..3],
+        status: extract_status(status),
         size: extract_content_length(headers),
         reqtime: "%0.6f" % reqtime,
       }
@@ -47,8 +47,12 @@ module Rack
     end
 
     def extract_content_length(headers)
-      value = headers['Content-Length'] or return '-'
+      value = headers && headers['Content-Length'] or return '-'
       value.to_s == '0' ? '-' : value
     end
+
+    def extract_status(status)
+      status.nil? ? "500" : status.to_s[0..3]
+    end
   end
 end

data/rack-ltsv_logger.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "rack-ltsv_logger"
-  spec.version       = "0.0.1"
+  spec.version       = "0.0.2"
   spec.authors       = ["Naotoshi Seo"]
   spec.email         = ["sonots@gmail.com"]
   spec.description   = %q{A rack middleware to output access log in ltsv format}

data/spec/ltsv_logger_spec.rb

@@ -8,6 +8,12 @@ describe Rack::LtsvLogger do
     }
   end
 
+  def error_app
+    lambda { |env|
+      raise ArgumentError, "error test"
+    }
+  end
+
   def parse_ltsv(ltsv)
     Hash[*(ltsv.chomp.split("\t").map {|e| e.split(":", 2) }.flatten)]
   end
@@ -70,4 +76,26 @@ describe Rack::LtsvLogger do
       expect(params['x_runtime']).to eq('1.234')
     end
   end
+
+  context 'when app error occured' do
+    let(:appends) do
+      { x_runtime: Proc.new {|env| '1.234' } }
+    end
+
+    subject do
+      @output = StringIO.new
+      Rack::Lint.new( Rack::LtsvLogger.new(error_app, @output, appends) )
+    end
+
+    it 'GET /get' do
+      expect {
+        Rack::MockRequest.new(subject).get('/get', env)
+      }.to raise_error ArgumentError
+
+      params = parse_ltsv(@output.string)
+      expect(params).not_to be_empty
+      expect(params['x_runtime']).to eq('1.234')
+      expect(params['status']).to eq('500')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-ltsv_logger
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-02 00:00:00.000000000 Z
+date: 2016-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -117,6 +117,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -150,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A rack middleware to output access log in ltsv format.