rack-slow-log 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjVlNGFmNjg4MjVkYWE5NGM0ODg3MmU2MDI4MmM4NTg2OGM2ZTRkMQ==
+  data.tar.gz: !binary |-
+    OGU4MmMzMmIwYzJjM2VlYjUzYmI3YzhiMTUzZTIyZDg5NTg0YWY3NA==
+SHA512:
+  metadata.gz: !binary |-
+    OTJjMDZjNTM4Yzk4NDNkOWMzMzE4MWU1N2U0MDJlYzQwYjdlNmY0OWFkYWZm
+    YzUyMDI4ZDUzOWFjMjU0NjBkZDY2NWVhNTYxMWZhMzQyZWIzYWQ4NzgyNGM2
+    ODJhMzZhZGJkNTJmNDA4ZGE4ODg3NGZiZDJiMjE4MjM0ZTBhMzA=
+  data.tar.gz: !binary |-
+    ZGRlYjZhY2M1MTk0ODZlMDBjNTYyMzEyZmZmZmM2ZTdjODc0MTI5MzJlYTRj
+    MDVkN2ZjMTYxMmQwYzY1NWQ3NTM2NmZjMjhlNTc1ZGRmNTVkZjFhNzQ3Nzg2
+    NjkwNmI0NWQwZDNjNWFkOTBkZjU1MTNlMjA5ZjlhZTllYTRlYmI=

data/lib/rack-slow-log.rb

@@ -0,0 +1,2 @@
+require_relative 'rack/slow_log/version'
+require_relative 'rack/slow_log'

data/lib/rack/slow_log.rb

@@ -0,0 +1,31 @@
+require_relative 'slow_log/logger'
+
+module Rack
+  class SlowLog
+
+    def initialize(app, options = {})
+      @app = app
+      @long_request_time = options.fetch(:long_request_time, 5)
+      @slow_log = options.fetch(:slow_log, 'log/slow.log')
+      @one_log_per_request = options.fetch(:one_log_per_request, false)
+    end
+
+    def call(env)
+      dup._call(env)
+    end
+
+    def _call(env)
+      logger = Logger.new(@long_request_time, @slow_log, @one_log_per_request)
+
+      logger.request_start!
+      env['rack.slow_log'] = logger
+      app_response = @app.call(env)
+      logger.request_end!
+
+      logger.save
+
+      app_response
+    end
+
+  end
+end

data/lib/rack/slow_log/logger.rb

@@ -0,0 +1,59 @@
+module Rack
+  class SlowLog
+    class Logger
+
+      def initialize(long_request_time, slow_log, one_log_per_request)
+        @long_request_time = long_request_time
+        @slow_log = slow_log
+        @one_log_per_request = one_log_per_request
+
+        @lines = []
+      end
+
+      def log(line)
+        @lines << [Time.now, line]
+      end
+      alias_method :<<, :log
+
+      def save
+        if long_request?
+          write_log
+        end
+      end
+
+      def request_start!
+        @start_time = Time.now
+      end
+
+      def request_end!
+        @end_time = Time.now
+      end
+
+      private
+
+      def long_request?
+        (@end_time - @start_time) > @long_request_time
+      end
+
+      def write_log
+        log_file = ::File.open(log_file_name, 'a')
+
+        log_file.write("[#{@start_time}] >>>>>>>>>> START <<<<<<<<<<\n")
+        @lines.each { |timestamp, line| log_file.write("[#{timestamp}] #{line}\n") }
+        log_file.write("[#{@end_time}] >>>>>>>>>> END <<<<<<<<<<\n")
+
+        log_file.close
+      end
+
+      def log_file_name
+        if @one_log_per_request
+          time_stamp = @start_time.strftime('%Y-%m-%d-%H_%M_%S.%3N')
+          "#{@slow_log}_#{time_stamp}"
+        else
+          @slow_log
+        end
+      end
+
+    end
+  end
+end

data/lib/rack/slow_log/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class SlowLog
+    VERSION = '0.0.1'
+  end
+end

data/spec/lib/rack/slow_log_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+require 'rack/test'
+
+require 'rack-slow-log'
+
+describe Rack::SlowLog do
+  include Rack::Test::Methods
+
+  let(:application_class) {
+    Class.new do
+      def initialize(sleep_time)
+        @sleep_time = sleep_time
+      end
+
+      def call(env)
+        sleep(@sleep_time)
+
+        env['rack.slow_log'].log('First log line.')
+        env['rack.slow_log'] << ('Second log line.')
+
+        [200, {}, 'success']
+      end
+    end
+  }
+
+  let(:long_request_time) { 0.5 }
+  let(:log_path) { '/tmp/log' }
+
+  let(:options) { { :long_request_time => long_request_time, :slow_log => "#{log_path}/slow.log" } }
+
+  def app
+    Rack::SlowLog.new(application_class.new(sleep_time), options)
+  end
+
+  before do
+    FileUtils.mkdir_p(log_path)
+    FileUtils.rm_rf(Dir.glob("#{log_path}/*"))
+  end
+
+  describe '#call' do
+
+    context  'when the request takes less than required' do
+      let(:sleep_time) { long_request_time - 0.2 }
+
+      it 'does not generate the slow log' do
+        get '/'
+
+        File.exists?("#{log_path}/slow.log").should be_false
+      end
+    end
+
+    context  'when the request takes more than required' do
+      let(:sleep_time) { long_request_time + 0.2 }
+
+      it 'generates the slow log' do
+        get '/'
+
+        File.exists?("#{log_path}/slow.log").should be_true
+      end
+
+      context 'when one_log_per_request is true' do
+
+        before { options[:one_log_per_request] = true }
+
+        it 'generates one log file per slow request' do
+          get '/'
+          get '/'
+
+          Dir["#{log_path}/*"].should have(2).elements
+        end
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'bundler/setup'
+
+require 'simplecov'
+SimpleCov.start
+
+require 'rspec'
+
+require 'fakefs/safe'
+
+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
+
+  config.order = 'random'
+
+  config.around(:each) do |example|
+    FakeFS.activate!
+    example.run
+    FakeFS.deactivate!
+  end
+
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: rack-slow-log
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adrian Gomez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-07 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: 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: simplecov
+  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: rack-test
+  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: fakefs
+  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: ! "    Allows for setting the maximum request time before it get logged
+  also provides a custom\n    log to data relevant to the slow request and can even
+  provide a different log for each slow\n    request for easy debugging.\n"
+email:
+- adrian.gomez@moove-it.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rack-slow-log.rb
+- lib/rack/slow_log.rb
+- lib/rack/slow_log/logger.rb
+- lib/rack/slow_log/version.rb
+- spec/lib/rack/slow_log_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Moove-it/rack-slow-log
+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.0
+signing_key: 
+specification_version: 4
+summary: Slow request logger for rack applications.
+test_files:
+- spec/lib/rack/slow_log_spec.rb
+- spec/spec_helper.rb