rack-logstasher 0.0.1

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p484

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-logstasher.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alex Tomlins
+
+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,31 @@
+# Rack::Logstasher
+
+Rack middleware to log requests in logstash json event format
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-logstasher'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-logstasher
+
+## Usage
+
+Add this to the middleware stack.  e.g.
+
+    use Rask::Logstasher::Logger, Logger.new("/path/to/logfile.json.log")
+
+## 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

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require "gem_publisher"
+task :publish_gem do |t|
+  gem = GemPublisher.publish_if_updated("rack-logstasher.gemspec", :rubygems)
+  puts "Published #{gem}" if gem
+end

data/jenkins.sh

@@ -0,0 +1,10 @@
+#!/bin/bash -x
+set -e
+
+rm -f Gemfile.lock
+git clean -fdx
+
+bundle install --path "${HOME}/bundles/${JOB_NAME}"
+
+bundle exec rake
+bundle exec rake publish_gem

data/lib/rack/logstasher/logger.rb

@@ -0,0 +1,57 @@
+require 'rack/commonlogger'
+require 'logstash/event'
+
+module Rack
+  module Logstasher
+    class Logger < Rack::CommonLogger
+      def initialize(app, logger, opts = {})
+        super(app, logger)
+        @extra_headers = opts[:extra_headers] || {}
+      end
+
+      private
+
+      def log(env, status, header, began_at)
+        now = Time.now
+
+        data = {
+          :method => env["REQUEST_METHOD"],
+          :path => env["PATH_INFO"],
+          :status => status.to_i,
+          :duration => duration_in_ms(began_at, now).round(2),
+          :remote_addr => env['REMOTE_ADDR'],
+          :parameters => env["QUERY_STRING"],
+          :request => request_line(env),
+          :length => extract_content_length(header)
+        }
+
+        @extra_headers.each do |header, log_key|
+          env_key = "HTTP_#{header.upcase.gsub('-', '_')}"
+          if env[env_key]
+            data[log_key] = env[env_key]
+          end
+        end
+
+        event = LogStash::Event.new('@fields' => data, '@tags' => ['request'])
+        msg = event.to_json + "\n"
+        if @logger.respond_to?(:write)
+          @logger.write(msg)
+        else
+          @logger << msg
+        end
+      end
+
+      def duration_in_ms(began, ended)
+        (ended - began) * 1000
+      end
+
+      def request_line(env)
+        line = "#{env["REQUEST_METHOD"]} #{env["SCRIPT_NAME"]}#{env['PATH_INFO']}"
+        line << "?#{env["QUERY_STRING"]}" if env["QUERY_STRING"] and ! env["QUERY_STRING"].empty?
+        line << " #{env["SERVER_PROTOCOL"]}"
+        line
+      end
+
+    end # Logger
+  end
+end

data/lib/rack/logstasher/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  module Logstasher
+    VERSION = "0.0.1"
+  end
+end

data/lib/rack/logstasher.rb

@@ -0,0 +1,7 @@
+require "rack/logstasher/version"
+require "rack/logstasher/logger"
+
+module Rack
+  module Logstasher
+  end
+end

data/rack-logstasher.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rack/logstasher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rack-logstasher"
+  spec.version       = Rack::Logstasher::VERSION
+  spec.authors       = ["Alex Tomlins"]
+  spec.email         = ["alex.tomlins@digital.cabinet-office.gov.uk"]
+  spec.description   = %q{Rack middleware to log requests in logstash json event format.  Like the logstasher gem, but for rack apps.}
+  spec.summary       = %q{Rack middleware to log requests in logstash json event format}
+  spec.homepage      = "https://github.com/alphagov/rack-logstasher"
+  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_dependency "logstash-event"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test", "0.6.2"
+  spec.add_development_dependency "rspec", "2.14.1"
+  spec.add_development_dependency "gem_publisher", "1.2.0"
+end

data/spec/logger_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+require 'rack/test'
+require 'logger'
+
+require 'rack/logstasher'
+
+describe "Logger" do
+  include Rack::Test::Methods
+
+  describe "adding request details to the logfile" do
+    def app
+      Rack::Logstasher::Logger.new(
+        proc {|env|
+          sleep @sleep_time if @sleep_time
+          [200, {}, ["Inner app response"]]
+        },
+        Logger.new(tmp_logfile_path)
+      )
+    end
+
+    it "should add request details to the logfile" do
+      get "/foo?bar=baz"
+
+      log_details = JSON.parse(last_log_line)
+      fields = log_details['@fields']
+
+      expect(fields['method']).to eq('GET')
+      expect(fields['path']).to eq('/foo')
+      expect(fields['parameters']).to eq('bar=baz')
+      expect(fields['request']).to eq('GET /foo?bar=baz ') # env['SERVER_PROTOCOL'] is not set under rack-test
+    end
+
+    it "should add request duration" do
+      @sleep_time = 0.1
+      get "/foo"
+
+      log_details = JSON.parse(last_log_line)
+      fields = log_details['@fields']
+
+      expect(fields['duration']).to be_within(5).of(100)
+    end
+
+    it "should add a tag of 'request'" do
+      get "/foo?bar=baz"
+
+      log_details = JSON.parse(last_log_line)
+      expect(log_details['@tags']).to eq(['request'])
+    end
+
+    describe "adding extra headers to the log" do
+      before :each do
+        @extra_headers = {}
+      end
+      def app
+        Rack::Logstasher::Logger.new(
+          proc {|env|
+            sleep @sleep_time if @sleep_time
+            [200, {}, ["Inner app response"]]
+          },
+          Logger.new(tmp_logfile_path),
+          :extra_headers => @extra_headers
+        )
+      end
+
+      it "should add specified extra headers to the log under the given key" do
+        @extra_headers["foo"] = "header_foo"
+        get "/something", {}, {"HTTP_FOO" => "bar"}
+
+        log_details = JSON.parse(last_log_line)
+        fields = log_details['@fields']
+
+        expect(fields['header_foo']).to eq('bar')
+      end
+
+      it "should not add the key if the header is missing" do
+        @extra_headers["foo"] = "header_foo"
+        get "/something"
+
+        log_details = JSON.parse(last_log_line)
+        fields = log_details['@fields']
+
+        expect(fields).not_to have_key('header_foo')
+      end
+
+      it "should handle dashes in header name" do
+        @extra_headers["Varnish-Id"] = "varnish_id"
+        get "/something", {}, {"HTTP_VARNISH_ID" => "1234"}
+
+        log_details = JSON.parse(last_log_line)
+        fields = log_details['@fields']
+
+        expect(fields['varnish_id']).to eq('1234')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.expand_path("../support/**/*.rb", __FILE__)].each { |f| require f }
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/logfile_helper.rb

@@ -0,0 +1,23 @@
+require 'tempfile'
+
+module LogfileHelper
+  TMP_LOGFILE = Tempfile.new('rack-logstasher-tmp-log')
+
+  def reset_tmp_log
+    TMP_LOGFILE.rewind
+    TMP_LOGFILE.truncate(0)
+  end
+
+  def tmp_logfile_path
+    TMP_LOGFILE.path
+  end
+
+  def last_log_line
+    TMP_LOGFILE.readlines.last
+  end
+end
+
+RSpec.configuration.include(LogfileHelper)
+RSpec.configuration.before :each do
+  reset_tmp_log
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification
+name: rack-logstasher
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alex Tomlins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logstash-event
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: gem_publisher
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: Rack middleware to log requests in logstash json event format.  Like
+  the logstasher gem, but for rack apps.
+email:
+- alex.tomlins@digital.cabinet-office.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jenkins.sh
+- lib/rack/logstasher.rb
+- lib/rack/logstasher/logger.rb
+- lib/rack/logstasher/version.rb
+- rack-logstasher.gemspec
+- spec/logger_spec.rb
+- spec/spec_helper.rb
+- spec/support/logfile_helper.rb
+homepage: https://github.com/alphagov/rack-logstasher
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1307778500513444384
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1307778500513444384
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Rack middleware to log requests in logstash json event format
+test_files:
+- spec/logger_spec.rb
+- spec/spec_helper.rb
+- spec/support/logfile_helper.rb