rack-ltsv_logger 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 987267c5e1469fd1a9ad94c468c9755a4ecb9999
-  data.tar.gz: d244d4b74d07fc31c073583f84c3b41fbf85c102
+  metadata.gz: abb79ce504f7948a99b0358ecc7d7a4ea464abc5
+  data.tar.gz: bf72dd81bfc4395262ad82f6b4ff4b3f48d20a4c
 SHA512:
-  metadata.gz: cb48db461edf5cc8dfbb59d6f05ebca624b6a0de09158a7dfde52b35e2a1d7a3204f3a1a3551e9eb8cd1e86f689513e4e79fc8f99eefcd5c0843d828ffd1fa1e
-  data.tar.gz: 8786999d9dd5e5cb77506cacb21d8126e1983e78f3251882954c8266317e3db6a800f67c9ae115855d3deccf755d3e24793b678767a5d7ca951cc93edfbcc99f
+  metadata.gz: 0be7eaad187f30bac8aa20aed3f5a8365ec4e392c682358636c6a70d33cf8e13a921fd443127ae369f7ed2fa29261e3965f2ada514627d23b92ec26bb6b283b6
+  data.tar.gz: 75760dc1f2cf6ae4f35c7251492ced1891f5dc14ca06bba9aee4f73f30397dad5591229600406f80385f2be94411d1d6bd6c325584fc07b51f0e12550565c818

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.1.0  (2017/11/26)
+
+Enhancements:
+
+* Add params\_proc keyword arguments to support more flexible ways to customize fields.
+
+Changes:
+
+* `appends` argument is deprecated.
+
 ## 0.0.3  (2016/04/03)
 
 Fixes:

data/README.md

@@ -73,61 +73,97 @@ reqtime:0.000000
 
 ### Default Fields
 
-* time
+| key          | value                                                                          |
+|--------------|--------------------------------------------------------------------------------|
+| time         | The datetime in ISO-8601 format                                                |
+| pid          | Procedd ID                                                                     |
+| host         | ENV['REMOTE_ADDR']                                                             |
+| forwardedfor | ENV['X_FORWARDED_FOR']                                                         |
+| user         | ENV['REMOTE_USER']                                                             |
+| method       | ENV['REQUEST_METHOD']                                                          |
+| uri          | ENV['PATH_INFO']                                                               |
+| query        | ENV['QUERY_STRING']                                                            |
+| protocol     | ENV['HTTP_VERSION']                                                            |
+| status       | Response Status Code                                                           |
+| size         | Response Content-Length                                                        |
+| reqtime      | The request time in secods. milli seconds are written after the decimal point. |
 
-  * The datetime in ISO-8601 format
 
-* pid
+## Arguments
 
-  * Process ID
+Arguments:
 
-* host
+* io
+  * An IO object, or something which has `#write` method
+* ~~appends (deprecated)~~
+  * ~~A Hash object to append custom fields. See [#custom-fields](#custom-fields)~~
 
-  * ENV['REMOTE_ADDR']
+Keyword Arguments:
 
-* forwardedfor
+* params\_proc
+  * A Proc object to generate fields. See [#custom-fields](#custom-fields)
 
-  * ENV['X_FORWARDED_FOR']
+### Log Rotation
 
-* user
+If you utilize log rotation functionality of Ruby's standard logger, you may write as
 
-  * ENV['REMOTE_USER']
-
-* method
-
-  * ENV['REQUEST_METHOD']
-
-* uri
-
-  * ENV['PATH_INFO']
-
-* query
-
-  * ENV['QUERY_STRING']
-
-* protocol
-
-  * ENV['HTTP_VERSION']
-
-* status
-
-  * Response Status Code
+```ruby
+class MyLogger < ::Logger
+  def write(msg)
+    @logdev.write msg
+  end
+end
 
-* size
+logger = MyLogger.new('/path/to/access.log', 3, 1048576)
+config.middleware.insert_after(0, Rack::LtsvLogger, logger)
+```
 
-  * Response Content-Length
+### Custom Fields
 
-* reqtime
+Pass a proc object to customize fields as:
 
-  * The request time in secods. milli seconds are written after the decimal point. 
+```ruby
+params_proc = Proc.new do |env, status, headers, body, began_at|
+  params = Rack::LtsvLogger::DEFAULT_PARAMS_PROC.call(env, status, headers, body, began_at)
+  params.delete(:protocol)
+  params.merge!(
+    vhost: env['HTTP_HOST'] || "-",
+    ua: env['HTTP_USER_AGENT'] || "-",
+    referer: env['HTTP_REFERER'] || "-",
+  )
+end
+config.middleware.insert_after(0, Rack::LtsvLogger, $stdout, params_proc: params_proc)
+```
 
-* Others
+or
 
-  * See http://ltsv.org/
+```ruby
+params_proc = Proc.new do |env, status, headers, body, began_at|
+  now = Time.now
+  reqtime = now.instance_eval { to_i + (usec/1000000.0) } - began_at
+  {
+    time: now.iso8601,
+    pid: Process.pid,
+    host: env["REMOTE_ADDR"] || "-",
+    forwardedfor: env['HTTP_X_FORWARDED_FOR'] || "-",
+    user: env["REMOTE_USER"] || "-",
+    method: env["REQUEST_METHOD"],
+    uri: env["PATH_INFO"],
+    query: env["QUERY_STRING"].empty? ? "" : "?"+env["QUERY_STRING"],
+    status: ::Rack::LtsvLogger.extract_status(status),
+    size: ::Rack::LtsvLogger.extract_content_length(headers),
+    reqtime: "%0.6f" % reqtime,
+    vhost: env['HTTP_HOST'] || "-",
+    ua: env['HTTP_USER_AGENT'] || "-",
+    referer: env['HTTP_REFERER'] || "-",
+  }
+end
+config.middleware.insert_after(0, Rack::LtsvLogger, $stdout, params_proc: params_proc)
+```
 
-### Custom Fields
+I recommend to follow http://ltsv.org/ to add new key names.
 
-You may append LTSV fields as:
+**Deprecated**
 
 ```ruby
 appends = {

data/example/sinatra/config.ru

@@ -2,5 +2,14 @@ require 'logger'
 require 'rack/ltsv_logger'
 require_relative 'app'
 
-use Rack::LtsvLogger, STDOUT
+params_proc = Proc.new do |env, status, headers, body, began_at|
+  params = Rack::LtsvLogger::DEFAULT_PARAMS_PROC.call(env, status, headers, body, began_at)
+  params.delete(:protocol)
+  params.merge!({
+    vhost: env['HTTP_HOST'] || "-",
+    ua: env['HTTP_USER_AGENT'] || "-",
+    referer: env['HTTP_REFERER'] || "-",
+  })
+end
+use Rack::LtsvLogger, $stdout, params_proc: params_proc
 run App

data/lib/rack/ltsv_logger.rb

@@ -2,21 +2,10 @@ require 'time'
 
 module Rack
   class LtsvLogger
-    def initialize(app, logger=nil, appends = {})
-      @app = app
-      @logger = logger || $stdout
-      @appends = appends
-    end
-
-    def call(env)
-      began_at = Time.now.instance_eval { to_i + (usec/1000000.0) }
-
-      status, headers, body = @app.call(env)
-    ensure
+    DEFAULT_PARAMS_PROC = Proc.new do |env, status, headers, body, began_at|
       now = Time.now
       reqtime = now.instance_eval { to_i + (usec/1000000.0) } - began_at
-
-      params = {
+      {
         time: now.iso8601,
         pid: Process.pid,
         host: env["REMOTE_ADDR"] || "-",
@@ -26,31 +15,41 @@ module Rack
         uri: env["PATH_INFO"],
         query: env["QUERY_STRING"].empty? ? "" : "?"+env["QUERY_STRING"],
         protocol: env["HTTP_VERSION"],
-        status: extract_status(status),
-        size: extract_content_length(headers),
+        status: ::Rack::LtsvLogger.extract_status(status),
+        size: ::Rack::LtsvLogger.extract_content_length(headers),
         reqtime: "%0.6f" % reqtime,
       }
-      @appends.each do |key, proc|
-        params[key] = proc.call(env)
-      end
-      @logger.write ltsv(params)
-
-      [status, headers, body]
     end
 
-    private
+    def initialize(app, io = nil, **kwargs)
+      @app = app
+      @io = io || $stdout
+      @params_proc = kwargs[:params_proc] || DEFAULT_PARAMS_PROC
+      @appends = kwargs.tap {|h| h.delete(:params_proc) } # old version compatibility
+    end
 
-    def ltsv(hash)
-      hash.map {|k, v| "#{k}:#{v}" }.join("\t") + "\n"
+    def call(env)
+      began_at = Time.now.instance_eval { to_i + (usec/1000000.0) }
+      status, headers, body = @app.call(env)
+    ensure
+      params = @params_proc.call(env, status, headers, body, began_at)
+      @appends.each {|key, proc| params[key] = proc.call(env) } # old version compatibility
+      @io.write ltsv(params)
     end
 
-    def extract_content_length(headers)
+    def self.extract_content_length(headers)
       value = headers && headers['Content-Length'] or return '-'
       value.to_s == '0' ? '-' : value
     end
 
-    def extract_status(status)
+    def self.extract_status(status)
       status.nil? ? "500" : status.to_s[0..3]
     end
+
+    private
+
+    def ltsv(hash)
+      hash.map {|k, v| "#{k}:#{v}" }.join("\t") + "\n"
+    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.3"
+  spec.version       = "0.1.0"
   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

@@ -42,7 +42,7 @@ describe Rack::LtsvLogger do
     Timecop.return
   end
 
-  context 'ltsv' do
+  context 'default ltsv' do
     subject do
       @output = StringIO.new
       Rack::Lint.new( Rack::LtsvLogger.new(app, @output) )
@@ -60,7 +60,31 @@ describe Rack::LtsvLogger do
     end
   end
 
-  context 'appends' do
+  context 'custom fields' do
+    let(:params_proc) do
+      Proc.new do |env, status, headers, body, began_at|
+        params = Rack::LtsvLogger::DEFAULT_PARAMS_PROC.call(env, status, headers, body, began_at)
+        params.delete(:protocol)
+        params.merge!(
+          new_protocol: env['HTTP_VERSION'],
+        )
+      end
+    end
+
+    subject do
+      @output = StringIO.new
+      Rack::Lint.new( Rack::LtsvLogger.new(app, @output, params_proc: params_proc) )
+    end
+
+    it 'GET /get' do
+      Rack::MockRequest.new(subject).get('/get', env)
+      params = parse_ltsv(@output.string)
+      expect(params['protocol']).to be_nil
+      expect(params['new_protocol']).to eq(protocol)
+    end
+  end
+
+  context 'appends (deprecated)' do
     let(:appends) do
       { x_runtime: Proc.new {|env| '1.234' } }
     end
@@ -75,7 +99,7 @@ describe Rack::LtsvLogger do
       params = parse_ltsv(@output.string)
       expect(params['x_runtime']).to eq('1.234')
     end
-  end
+  end 
 
   context 'when app error occured' do
     let(:appends) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-ltsv_logger
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-02 00:00:00.000000000 Z
+date: 2017-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -151,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A rack middleware to output access log in ltsv format.