rack-ltsv_logger 0.0.1

checksums.yaml

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

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/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+gemfile:
+  - Gemfile

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 DeNA, Co., Ltd
+
+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,139 @@
+# Rack::LtsvLogger
+
+A rack middleware to output access log in ltsv format, like [rack/commonlogger](https://github.com/rack/rack/blob/master/lib/rack/commonlogger.rb) (which output access log in apache common format).
+
+## Why Rack Middleware
+
+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. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-ltsvlogger'
+
+And then execute:
+
+    $ bundle
+
+## How to Use
+
+Insert Rack::LtsvLogger on the head of rack middlewares. 
+
+Rails)
+
+Add following to config/environments/[env].rb
+
+```ruby
+require 'rack/ltsvlogger'
+require 'logger'
+
+config.middleware.insert_after(0, Rack::LtsvLogger, $stdout)
+```
+
+Sinatra)
+
+```ruby
+# config.ru
+require 'rack/ltsvlogger'
+
+use Rack::LtsvLogger, $stdout
+run App
+```
+
+## Format
+
+Sample (line feeded):
+
+```
+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
+
+* time
+
+  * The datetime in ISO-8601 format
+
+* pid
+
+  * Process 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. 
+
+* Others
+
+  * See http://ltsv.org/
+
+### Custom Fields
+
+You may append LTSV fields as:
+
+```ruby
+appends = {
+  vhost: Proc.new {|env| env['HTTP_HOST'] || "-" },
+  ua: Proc.new {|env| env['HTTP_USER_AGENT'] || "-" },
+  referer: Proc.new {|env| env['HTTP_REFERER'] || "-" },
+}
+config.middleware.insert_after(0, Rack::LtsvLogger, $stdout, appends)
+```
+
+## ChangeLog
+
+See [CHANGELOG.md](CHANGELOG.md) for details.
+
+## 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](../../pull/new/master)
+
+## Copyright
+
+See [LICENSE.txt](LICENSE.txt) for details.

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+
+task :test do
+  require 'rspec/core'
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:test) do |spec|
+    spec.pattern = FileList['spec/**/*_spec.rb']
+  end
+end
+task :default => :spec
+
+desc 'Open an irb session preloaded with the gem library'
+task :console do
+    sh 'irb -rubygems -I lib'
+end
+task :c => :console

data/example/sinatra/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem 'sinatra'
+gem 'rack-ltsv_logger', path: '../..'
+gem 'pry'
+gem 'pry-nav'

data/example/sinatra/app.rb

@@ -0,0 +1,7 @@
+require 'sinatra/base'
+
+class App < Sinatra::Base
+  get '/' do
+    logger.info "OK"
+  end
+end

data/example/sinatra/config.ru

@@ -0,0 +1,6 @@
+require 'logger'
+require 'rack/ltsv_logger'
+require_relative 'app'
+
+use Rack::LtsvLogger, STDOUT
+run App

data/lib/rack-ltsv_logger.rb

@@ -0,0 +1 @@
+require 'rack/ltsv_logger'

data/lib/rack/ltsv_logger.rb

@@ -0,0 +1,54 @@
+require 'time'
+
+module Rack
+  class LtsvLogger
+    PID = Process.pid
+
+    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)
+
+      now = Time.now
+      reqtime = now.instance_eval { to_i + (usec/1000000.0) } - began_at
+
+      params = {
+        time: now.iso8601,
+        pid: 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"],
+        protocol: env["HTTP_VERSION"],
+        status: status.to_s[0..3],
+        size: 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 ltsv(hash)
+      hash.map {|k, v| "#{k}:#{v}" }.join("\t") + "\n"
+    end
+
+    def extract_content_length(headers)
+      value = headers['Content-Length'] or return '-'
+      value.to_s == '0' ? '-' : value
+    end
+  end
+end

data/rack-ltsv_logger.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$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.authors       = ["Naotoshi Seo"]
+  spec.email         = ["sonots@gmail.com"]
+  spec.description   = %q{A rack middleware to output access log in ltsv format}
+  spec.summary       = %q{A rack middleware to output access log in ltsv format.}
+  spec.homepage      = "https://github.com/sonots/rack-ltsv_logger"
+  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_dependency "rack"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-nav"
+  spec.add_development_dependency "timecop"
+end

data/spec/ltsv_logger_spec.rb

@@ -0,0 +1,73 @@
+require_relative 'spec_helper'
+require 'timecop'
+
+describe Rack::LtsvLogger do
+  def app
+    lambda { |env|
+      [200, {'Content-Type' => 'text/plain'}, ["Hello, World!"]]
+    }
+  end
+
+  def parse_ltsv(ltsv)
+    Hash[*(ltsv.chomp.split("\t").map {|e| e.split(":", 2) }.flatten)]
+  end
+
+  let(:now)      { Time.now }
+  let(:time)     { now.iso8601 }
+  let(:pid)      { Process.pid }
+  let(:host)     { '127.0.0.1' }
+  let(:forwardedfor) { '127.0.0.2' }
+  let(:user)     { 'user' }
+  let(:protocol) { 'HTTP/1.1' }
+  let(:env) do
+    {
+      'REMOTE_ADDR' => host,
+      'HTTP_X_FORWARDED_FOR' => forwardedfor,
+      'REMOTE_USER' => user,
+      'HTTP_VERSION' => protocol,
+    }
+  end
+
+  before do
+    Timecop.freeze now
+  end
+
+  after do
+    Timecop.return
+  end
+
+  context 'ltsv' do
+    subject do
+      @output = StringIO.new
+      Rack::Lint.new( Rack::LtsvLogger.new(app, @output) )
+    end
+
+    let(:method)   { 'GET' }
+    let(:uri)      { '/get' }
+    let(:query)    { '?foo' }
+
+    it do
+      Rack::MockRequest.new(subject).get("#{uri}#{query}", env)
+      expect(@output.string).to eq \
+        "time:#{time}\tpid:#{pid}\thost:#{host}\tforwardedfor:#{forwardedfor}\tuser:#{user}\t" +
+        "method:#{method}\turi:#{uri}\tquery:#{query}\tprotocol:#{protocol}\tstatus:200\tsize:-\treqtime:0.000000\n"
+    end
+  end
+
+  context 'appends' do
+    let(:appends) do
+      { x_runtime: Proc.new {|env| '1.234' } }
+    end
+
+    subject do
+      @output = StringIO.new
+      Rack::Lint.new( Rack::LtsvLogger.new(app, @output, appends) )
+    end
+
+    it 'GET /get' do
+      Rack::MockRequest.new(subject).get('/get', env)
+      params = parse_ltsv(@output.string)
+      expect(params['x_runtime']).to eq('1.234')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
+
+#require 'simplecov'
+#require 'simplecov-rcov'
+#SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+#SimpleCov.start
+
+$TESTING=true
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib/rack/')
+require 'timecop'
+require 'rack'
+require 'rack-ltsv_logger'

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: rack-ltsv_logger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A rack middleware to output access log in ltsv format
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc/x_runtime.png
+- example/sinatra/Gemfile
+- example/sinatra/app.rb
+- example/sinatra/config.ru
+- lib/rack-ltsv_logger.rb
+- lib/rack/ltsv_logger.rb
+- rack-ltsv_logger.gemspec
+- spec/ltsv_logger_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sonots/rack-ltsv_logger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A rack middleware to output access log in ltsv format.
+test_files:
+- spec/ltsv_logger_spec.rb
+- spec/spec_helper.rb