logstasher 0.1.1 → 0.2.0

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+.idea

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
+  - 2.0
   - 1.9.3
   - 1.9.2
 script: bundle exec rspec

data/Gemfile

@@ -1,9 +1,14 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in logstasher.gemspec
 gemspec
 
 group :test do
-  gem 'actionpack'
-  gem 'logstash-event'
+  gem 'rb-fsevent', '~> 0.9'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'growl'
+  gem 'simplecov', :platforms => :mri_19, :require => false
+  gem 'rcov', :platforms => :mri_18
+  gem 'rails', '~> 3.2.0'
 end

data/Guardfile

@@ -1,5 +1,6 @@
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
+interactor :simple
 
 guard 'rspec', :version => 2 do
   watch(%r{^spec/.+_spec\.rb$})

data/README.md

@@ -1,3 +1,49 @@
-Logstasher - Awesome rails logs
-=======
+# Logstasher - Awesome Logging for Rails [![Build Status](https://secure.travis-ci.org/shadabahmed/logstasher.png)](https://secure.travis-ci.org/shadabahmed/logstasher)
 
+This gem is heavily inspired from [lograge](https://github.com/roidrage/lograge) but it's focused on one thing and one thing only; making your logs awesome.
+
+How do I do that ?
+
+Using these two awesome tools:
+* [logstash](http://logstash.net) - Store and index your logs
+* [Kibana](http://kibana.org/) - for awesome visualization. This is optional though, and you can use any other visualizer
+
+## Installation
+
+In your Gemfile:
+
+    gem 'logstasher'
+
+### Configure your \<environment\>.rb e.g. development.rb
+
+    config.logstasher.enabled = true
+
+    # This line is optional if you do not want to supress app logs in your <environment>.log
+    config.logstasher.supress_app_log = false
+
+## Adding custom fields to the log
+
+Since some fields are very specific to your application for e.g. *user_name*, it is left upto you to add them. Here's how to add those to the logs:
+
+    # In config/initializers/logstasher.rb
+
+    if LogStasher.enabled
+      LogStasher.add_custom_fields do |fields|
+        fields[:user] = current_user && current_user.mail
+        fields[:site] = request.path =~ /^\/api/ ? 'api' : 'user'
+
+        # If you are using custom instrumentation, just add those to logstasher custom fields
+        LogStasher.custom_fields << :myapi_runtime
+      end
+    end
+
+## Versions
+All versions require Rails 3.0.x and higher and Ruby 1.9.2+
+
+## Development
+ - Run tests - `rake`
+ - Generate test coverage report - `rake coverage`. Coverage report path - coverage/index.html
+
+## Copyright
+
+Copyright (c) 2013 Shadab Ahmed, released under the MIT license

data/Rakefile

@@ -1 +1,42 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+# Add default task. When you type just rake command this would run. Travis CI runs this. Making this run spec
+desc 'Default: run specs.'
+task :default => :spec
+
+# Defining spec task for running spec
+desc "Run specs"
+RSpec::Core::RakeTask.new('spec') do |spec|
+  # Pattern filr for spec files to run. This is default btw.
+  spec.pattern = "./spec/**/*_spec.rb"
+end
+
+# Run the rdoc task to generate rdocs for this gem
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  require "logstasher/version"
+  version = LogStasher::VERSION
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "logstasher #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Code coverage tasks. Different for Ruby 1.8 vs 1.9
+if RUBY_VERSION =~ /^1\.8/
+  # Ruby 1.8 uses rcov for code coverage
+  RSpec::Core::RakeTask.new(:coverage) do |spec|
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.rcov = true
+    spec.rcov_opts = %w{--exclude pkg\/,spec\/,features\/}
+  end
+else
+  # Ruby 1.9+ using simplecov. Note: Simplecov config defined in spec_helper
+  desc "Code coverage detail"
+  task :coverage do
+    ENV['COVERAGE'] = "true"
+    Rake::Task['spec'].execute
+  end
+end

data/lib/logstasher.rb

@@ -4,24 +4,17 @@ require 'active_support/core_ext/module/attribute_accessors'
 require 'active_support/core_ext/string/inflections'
 require 'active_support/ordered_options'
 
-module Logstasher
+module LogStasher
   # Logger for the logstash logs
   mattr_accessor :logger, :enabled
 
-  # Set the options for the adding cutom data to payload
-  mattr_accessor :payload_appender
-
-  def self.append_payload(&block)
-    self.payload_appender = block
-  end
-
   def self.remove_existing_log_subscriptions
     ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
       case subscriber
-      when ActionView::LogSubscriber
-        unsubscribe(:action_view, subscriber)
-      when ActionController::LogSubscriber
-        unsubscribe(:action_controller, subscriber)
+        when ActionView::LogSubscriber
+          unsubscribe(:action_view, subscriber)
+        when ActionController::LogSubscriber
+          unsubscribe(:action_controller, subscriber)
       end
     end
   end
@@ -37,15 +30,62 @@ module Logstasher
     end
   end
 
+  def self.add_default_fields_to_payload(payload, request)
+    payload[:ip] = request.remote_ip
+    payload[:route] = "#{request.params[:controller]}##{request.params[:action]}"
+    payload[:parameters] = payload[:params].except(*ActionController::LogSubscriber::INTERNAL_PARAMS).inject(""){|s,(k,v)|
+      s+="#{k}=#{v}\n"}
+    self.custom_fields += [:ip, :route, :parameters]
+  end
+
+  def self.add_custom_fields(&block)
+    ActionController::Base.send(:define_method, :logtasher_add_custom_fields_to_payload, &block)
+  end
+
   def self.setup(app)
-    Logstasher.enabled = true
     app.config.action_dispatch.rack_cache[:verbose] = false if app.config.action_dispatch.rack_cache
-    require 'logstasher/rails_ext/rack/logger'
+    # Path instrumentation class to insert our hook
     require 'logstasher/rails_ext/action_controller/metal/instrumentation'
     require 'logstash/event'
-    Logstasher.remove_existing_log_subscriptions
-    Logstasher::RequestLogSubscriber.attach_to :action_controller
-    self.logger = app.config.logstasher.logger || Logger.new("#{Rails.root}/log/logstash.log")
+    self.suppress_app_logs(app)
+    LogStasher::RequestLogSubscriber.attach_to :action_controller
+    self.logger = app.config.logstasher.logger || Logger.new("#{Rails.root}/log/logstash_#{Rails.env}.log")
+    self.logger.level = app.config.logstasher.log_level || Logger::WARN
+    self.enabled = true
+    self.custom_fields = []
+  end
+
+  def self.suppress_app_logs(app)
+    if app.config.logstasher.supress_app_log.nil? || app.config.logstasher.supress_app_log
+      require 'logstasher/rails_ext/rack/logger'
+      LogStasher.remove_existing_log_subscriptions
+    end
+  end
+
+  def self.custom_fields
+    Thread.current[:logstasher_custom_fields]
+  end
+
+  def self.custom_fields=(val)
+    Thread.current[:logstasher_custom_fields] = val
+  end
+
+
+  def self.log(severity, msg)
+    if self.logger && self.logger.send("#{severity}?")
+      event = LogStash::Event.new('@fields' => {:message => msg, :level => severity},'@tags' => ['log'])
+      self.logger.send severity, event.to_json
+    end
+  end
+
+  class << self
+    %w( fatal error warn info debug unknown ).each do |severity|
+      eval <<-EOM, nil, __FILE__, __LINE__ + 1
+        def #{severity}(msg)
+          self.log(:#{severity}, msg)
+        end
+      EOM
+    end
   end
 end
 

data/lib/logstasher/log_subscriber.rb

@@ -1,7 +1,7 @@
 require 'active_support/core_ext/class/attribute'
 require 'active_support/log_subscriber'
 
-module Logstasher
+module LogStasher
   class RequestLogSubscriber < ActiveSupport::LogSubscriber
     def process_action(event)
       payload = event.payload
@@ -11,10 +11,11 @@ module Logstasher
       data.merge! runtimes(event)
       data.merge! location(event)
       data.merge! extract_exception(payload)
-      data.merge! extract_appended_params(payload)
+      data.merge! extract_custom_fields(payload)
 
-      event = LogStash::Event.new("@fields" => data)
-      Logstasher.logger.info event.to_json
+      event = LogStash::Event.new('@fields' => data, '@tags' => ['request'])
+      event.tags << 'exception' if payload[:exception]
+      LogStasher.logger.unknown event.to_json
     end
 
     def redirect_to(event)
@@ -28,8 +29,8 @@ module Logstasher
         :method => payload[:method],
         :path => extract_path(payload),
         :format => extract_format(payload),
-        :controller => payload[:controller],
-        :action => payload[:action]
+        :controller => payload[:params]['controller'],
+        :action => payload[:params]['action']
       }
     end
 
@@ -49,7 +50,7 @@ module Logstasher
       if payload[:status]
         { :status => payload[:status].to_i }
       else
-        {}
+        { :status => 0 }
       end
     end
 
@@ -77,16 +78,17 @@ module Logstasher
     def extract_exception(payload)
       if payload[:exception]
         exception, message = payload[:exception]
-        message = "#{exception} : #{message}\n #{($!.backtrace.join("\n"))}"
+        message = "#{exception}\n#{message}\n#{($!.backtrace.join("\n"))}"
         { :status => 500, :error => message }
       else
         {}
       end
     end
 
-    def extract_appended_params(payload)
-      appended_keys = payload.delete(:log_stasher_appended_param_keys)
-      (appended_keys && payload.extract!(*appended_keys)) || {}
+    def extract_custom_fields(payload)
+      custom_fields = (!LogStasher.custom_fields.empty? && payload.extract!(*LogStasher.custom_fields)) || {}
+      LogStasher.custom_fields.clear
+      custom_fields
     end
   end
 end

data/lib/logstasher/rails_ext/action_controller/metal/instrumentation.rb

@@ -10,13 +10,13 @@ module ActionController
           :path       => (request.fullpath rescue "unknown")
       }
 
-      if Logstasher.payload_appender
+      LogStasher.add_default_fields_to_payload(raw_payload, request)
+      if self.respond_to?(:logtasher_add_custom_fields_to_payload)
         before_keys = raw_payload.keys.clone
-        # Execue the payload appened in current context
-        self.instance_exec raw_payload, &Logstasher.payload_appender
+        logtasher_add_custom_fields_to_payload(raw_payload)
         after_keys = raw_payload.keys
-        # Add to payload all extra keys added to payload hash
-        raw_payload[:log_stasher_appended_param_keys] = after_keys - before_keys
+        # Store all extra keys added to payload hash in payload itself. This is a thread safe way
+        LogStasher.custom_fields += after_keys - before_keys
       end
 
       ActiveSupport::Notifications.instrument("start_processing.action_controller", raw_payload.dup)

data/lib/logstasher/railtie.rb

@@ -2,13 +2,13 @@ require 'rails/railtie'
 require 'action_view/log_subscriber'
 require 'action_controller/log_subscriber'
 
-module Logstasher
+module LogStasher
   class Railtie < Rails::Railtie
     config.logstasher = ActiveSupport::OrderedOptions.new
     config.logstasher.enabled = false
 
     initializer :logstasher do |app|
-      Logstasher.setup(app) if app.config.logstasher.enabled
+      LogStasher.setup(app) if app.config.logstasher.enabled
     end
   end
 end

data/lib/logstasher/version.rb

@@ -1,3 +1,3 @@
-module Logstasher
-  VERSION = "0.1.1"
+module LogStasher
+  VERSION = "0.2.0"
 end

data/logstasher.gemspec

@@ -4,7 +4,7 @@ require "logstasher/version"
 
 Gem::Specification.new do |s|
   s.name        = "logstasher"
-  s.version     = Logstasher::VERSION
+  s.version     = LogStasher::VERSION
   s.authors     = ["Shadab Ahmed"]
   s.email       = ["shadab.ansari@gmail.com"]
   s.homepage    = "https://github.com/shadabahmed/logstasher"
@@ -21,7 +21,6 @@ Gem::Specification.new do |s|
 
   # specify any dependencies here; for example:
   s.add_development_dependency "rspec"
-  s.add_development_dependency "guard-rspec"
-  s.add_runtime_dependency "activesupport"
-  s.add_runtime_dependency "actionpack"
+  s.add_development_dependency("bundler", [">= 1.0.0"])
+  s.add_development_dependency("rails", [">= 3.0"])
 end

data/spec/logstasher_logsubscriber_spec.rb

@@ -1,30 +1,29 @@
 require 'spec_helper'
-require 'logstasher'
-require 'logstasher/log_subscriber'
-require 'active_support/notifications'
-require 'active_support/core_ext/string'
-require 'logger'
 
-describe Logstasher::RequestLogSubscriber do
+describe LogStasher::RequestLogSubscriber do
   let(:log_output) {StringIO.new}
   let(:logger) {
     logger = Logger.new(log_output)
     logger.formatter = ->(_, _, _, msg) {
       msg
     }
+    def log_output.json
+      JSON.parse! self.string
+    end
     logger
   }
   before do
-    Logstasher::RequestLogSubscriber.logger = logger
+    LogStasher.logger = logger
+    LogStasher.custom_fields = []
   end
 
-  let(:subscriber) {Logstasher::RequestLogSubscriber.new}
+  let(:subscriber) {LogStasher::RequestLogSubscriber.new}
   let(:event) {
     ActiveSupport::Notifications::Event.new(
       'process_action.action_controller', Time.now, Time.now, 2, {
         status: 200, format: 'application/json', method: 'GET', path: '/home?foo=bar', params: {
-          'controller' => 'home', 'action' => 'index', 'foo' => 'bar'
-        }, db_runtime: 0.02, view_runtime: 0.01
+          :controller => 'home', :action => 'index', 'foo' => 'bar'
+        }.with_indifferent_access, db_runtime: 0.02, view_runtime: 0.01
       }
     )
   }
@@ -35,220 +34,73 @@ describe Logstasher::RequestLogSubscriber do
     )
   }
 
-  describe "when processing an action with logstasher output" do
-    before do
-      Logstasher::log_format = :logstasher
-    end
-
-    it "should include the URL in the log output" do
-      subscriber.process_action(event)
-      log_output.string.should include('/home')
-    end
-
-    it "should not include the query string in the url" do
-      subscriber.process_action(event)
-      log_output.string.should_not include('?foo=bar')
-    end
-
-    it "should start the log line with the HTTP method" do
-      subscriber.process_action(event)
-      log_output.string.starts_with?('method=GET ').should == true
-    end
-
-    it "should include the status code" do
-      subscriber.process_action(event)
-      log_output.string.should include('status=200 ')
-    end
-
-    it "should include the controller and action" do
-      subscriber.process_action(event)
-      log_output.string.should include('controller=home action=index')
-    end
-
-    it "should include the duration" do
-      subscriber.process_action(event)
-      log_output.string.should =~ /duration=[\.0-9]{4,4} /
-    end
+  describe 'logstasher output' do
 
-    it "should include the view rendering time" do
+    it "should contain request tag" do
       subscriber.process_action(event)
-      log_output.string.should =~ /view=0.01 /
+      log_output.json['@tags'].should include 'request'
     end
 
-    it "should include the database rendering time" do
+    it "should contain HTTP method" do
       subscriber.process_action(event)
-      log_output.string.should =~ /db=0.02/
+      log_output.json['@fields']['method'].should == 'GET'
     end
 
-    it "should add a 500 status when an exception occurred" do
-      event.payload[:status] = nil
-      event.payload[:exception] = ['AbstractController::ActionNotFound', 'Route not found']
+    it "should include the path in the log output" do
       subscriber.process_action(event)
-      log_output.string.should =~ /status=500 /
-      log_output.string.should =~ /error='AbstractController::ActionNotFound:Route not found' /
+      log_output.json['@fields']['path'].should == '/home'
     end
 
-    it "should return an unknown status when no status or exception is found" do
-      event.payload[:status] = nil
-      event.payload[:exception] = nil
+    it "should include the format in the log output" do
       subscriber.process_action(event)
-      log_output.string.should =~ /status=0 /
-    end
-
-    describe "with a redirect" do
-      before do
-        Thread.current[:logstasher_location] = "http://www.example.com"
-      end
-
-      it "should add the location to the log line" do
-        subscriber.process_action(event)
-        log_output.string.should =~ %r{ location=http://www.example.com}
-      end
-
-      it "should remove the thread local variable" do
-        subscriber.process_action(event)
-        Thread.current[:logstasher_location].should == nil
-      end
-    end
-
-    it "should not include a location by default" do
-      subscriber.process_action(event)
-      log_output.string.should_not =~ /location=/
-    end
-  end
-
-  describe "when processing an action with logstash output" do
-    before do
-      require 'logstash-event'
-      Logstasher::log_format = :logstash
-    end
-
-    it "should include the URL in the log output" do
-      subscriber.process_action(event)
-      log_output.string.should include('/home')
-    end
-
-    it "should start include the HTTP method" do
-      subscriber.process_action(event)
-      log_output.string.should include('"method":"GET"')
+      log_output.json['@fields']['format'].should == 'application/json'
     end
 
     it "should include the status code" do
       subscriber.process_action(event)
-      log_output.string.should include('"status":200')
+      log_output.json['@fields']['status'].should == 200
     end
 
-    it "should include the controller and action" do
+    it "should include the controller" do
       subscriber.process_action(event)
-      log_output.string.should include('"controller":"home"')
-      log_output.string.should include('"action":"index"')
+      log_output.json['@fields']['controller'].should == 'home'
     end
 
-    it "should include the duration" do
+    it "should include the action" do
       subscriber.process_action(event)
-      log_output.string.should =~ /"duration":\d+\.\d{0,2}/
+      log_output.json['@fields']['action'].should == 'index'
     end
 
     it "should include the view rendering time" do
       subscriber.process_action(event)
-      log_output.string.should =~ /"view":0.01/
+      log_output.json['@fields']['view'].should == 0.01
     end
 
     it "should include the database rendering time" do
       subscriber.process_action(event)
-      log_output.string.should =~ /"db":0.02/
+      log_output.json['@fields']['db'].should == 0.02
     end
 
     it "should add a 500 status when an exception occurred" do
-      event.payload[:status] = nil
-      event.payload[:exception] = ['AbstractController::ActionNotFound', 'Route not found']
-      subscriber.process_action(event)
-      log_output.string.should =~ /"status":500/
-      log_output.string.should =~ /"error":"AbstractController::ActionNotFound:Route not found"/
-    end
-
-    it "should return an unknown status when no status or exception is found" do
-      event.payload[:status] = nil
-      event.payload[:exception] = nil
-      subscriber.process_action(event)
-      log_output.string.should =~ /"status":0/
-    end
-
-    describe "with a redirect" do
-      before do
-        Thread.current[:logstasher_location] = "http://www.example.com"
-      end
-
-      it "should add the location to the log line" do
+      begin
+        raise AbstractController::ActionNotFound.new('Could not find an action')
+      # working this in rescue to get access to $! variable
+      rescue
+        event.payload[:status] = nil
+        event.payload[:exception] = ['AbstractController::ActionNotFound', 'Route not found']
         subscriber.process_action(event)
-        log_output.string.should =~ %r{"location":"http://www.example.com"}
+        log_output.json['@fields']['status'].should == 500
+        log_output.json['@fields']['error'].should =~ /AbstractController::ActionNotFound.*Route not found.*logstasher\/spec\/logstasher_logsubscriber_spec\.rb/m
+        log_output.json['@tags'].should include 'request'
+        log_output.json['@tags'].should include 'exception'
       end
-
-      it "should remove the thread local variable" do
-        subscriber.process_action(event)
-        Thread.current[:logstasher_location].should == nil
-      end
-    end
-
-    it "should not include a location by default" do
-      subscriber.process_action(event)
-      log_output.string.should_not =~ /"location":/
-    end
-  end
-
-  describe "when processing an action with graylog2 output" do
-    before do
-      Logstasher::log_format = :graylog2
-    end
-
-    it "should include the URL in the log output" do
-      subscriber.process_action(event)
-      log_output.string.should include(':_path=>"/home"')
-    end
-
-    it "should start include the HTTP method" do
-      subscriber.process_action(event)
-      log_output.string.should include(':_method=>"GET"')
-    end
-
-    it "should include the status code" do
-      subscriber.process_action(event)
-      log_output.string.should include(':_status=>200')    end
-
-    it "should include the controller and action" do
-      subscriber.process_action(event)
-      log_output.string.should include(':_controller=>"home"')
-      log_output.string.should include(':_action=>"index"')
-    end
-
-    it "should include the duration" do
-      subscriber.process_action(event)
-      log_output.string.should =~ /:_duration=>\d+\.\d{0,2}/
-    end
-
-    it "should include the view rendering time" do
-      subscriber.process_action(event)
-      log_output.string.should include(':_view=>0.01')
-    end
-
-    it "should include the database rendering time" do
-      subscriber.process_action(event)
-      log_output.string.should include(':_db=>0.02')
-    end
-
-    it "should add a 500 status when an exception occurred" do
-      event.payload[:status] = nil
-      event.payload[:exception] = ['AbstractController::ActionNotFound', 'Route not found']
-      subscriber.process_action(event)
-      log_output.string.should include(':_status=>500')
-      log_output.string.should include(':_error=>"AbstractController::ActionNotFound:Route not found"')
     end
 
     it "should return an unknown status when no status or exception is found" do
       event.payload[:status] = nil
       event.payload[:exception] = nil
       subscriber.process_action(event)
-      log_output.string.should include(':_status=>0')
+      log_output.json['@fields']['status'].should == 0
     end
 
     describe "with a redirect" do
@@ -258,7 +110,7 @@ describe Logstasher::RequestLogSubscriber do
 
       it "should add the location to the log line" do
         subscriber.process_action(event)
-        log_output.string.should include(':_location=>"http://www.example.com"')
+        log_output.json['@fields']['location'].should == 'http://www.example.com'
       end
 
       it "should remove the thread local variable" do
@@ -269,75 +121,37 @@ describe Logstasher::RequestLogSubscriber do
 
     it "should not include a location by default" do
       subscriber.process_action(event)
-      log_output.string.should_not =~ /"location":/
+      log_output.json['@fields']['location'].should be_nil
     end
   end
 
-  describe "with custom_options configured for graylog2 output" do
-    before do
-      Logstasher::log_format = :graylog2
-    end
-
-    it "should combine the hash properly for the output" do
-      Logstasher.custom_options = {:data => "value"}
-      subscriber.process_action(event)
-      log_output.string.should include(':_data=>"value"')
-    end
-
-    it "should combine the output of a lambda properly" do
-      Logstasher.custom_options = lambda {|event| {:data => "value"}}
-      subscriber.process_action(event)
-      log_output.string.should include(':_data=>"value"')
-    end
-
-    it "should work if the method returns nil" do
-      Logstasher.custom_options = lambda {|event| nil}
+  describe "with append_custom_params block specified" do
+    let(:request) { mock(:remote_ip => '10.0.0.1')}
+    it "should add default custom data to the output" do
+      request.stub(:params => event.payload[:params])
+      LogStasher.add_default_fields_to_payload(event.payload, request)
       subscriber.process_action(event)
-      log_output.string.should be_present
+      log_output.json['@fields']['ip'].should == '10.0.0.1'
+      log_output.json['@fields']['route'].should == 'home#index'
+      log_output.json['@fields']['parameters'].should == "foo=bar\n"
     end
   end
 
-  describe "with custom_options configured for logstasher output" do
+  describe "with append_custom_params block specified" do
     before do
-      Logstasher::log_format = :logstasher
-    end
-
-    it "should combine the hash properly for the output" do
-      Logstasher.custom_options = {:data => "value"}
-      subscriber.process_action(event)
-      log_output.string.should =~ / data=value/
-    end
-    it "should combine the output of a lambda properly" do
-      Logstasher.custom_options = lambda {|event| {:data => "value"}}
-      subscriber.process_action(event)
-      log_output.string.should =~ / data=value/
-    end
-    it "should work if the method returns nil" do
-      Logstasher.custom_options = lambda {|event| nil}
-      subscriber.process_action(event)
-      log_output.string.should be_present
-    end
-  end
-
-  describe "with custom_options configured for logstash output" do
-    before do
-      Logstasher::log_format = :logstash
+      LogStasher.stub(:add_custom_fields) do |&block|
+        @block = block
+      end
+      LogStasher.add_custom_fields do |payload|
+        payload[:user] = 'user'
+      end
+      LogStasher.custom_fields += [:user]
     end
 
-    it "should combine the hash properly for the output" do
-      Logstasher.custom_options = {:data => "value"}
-      subscriber.process_action(event)
-      log_output.string.should =~ /"data":"value"/
-    end
-    it "should combine the output of a lambda properly" do
-      Logstasher.custom_options = lambda {|event| {:data => "value"}}
-      subscriber.process_action(event)
-      log_output.string.should =~ /"data":"value"/
-    end
-    it "should work if the method returns nil" do
-      Logstasher.custom_options = lambda {|event| nil}
+    it "should add the custom data to the output" do
+      @block.call(event.payload)
       subscriber.process_action(event)
-      log_output.string.should be_present
+      log_output.json['@fields']['user'].should == 'user'
     end
   end
 

data/spec/logstasher_spec.rb

@@ -1,12 +1,6 @@
 require 'spec_helper'
-require 'logstasher'
-require 'active_support/notifications'
-require 'active_support/core_ext/string'
-require 'active_support/log_subscriber'
-require 'action_controller/log_subscriber'
-require 'action_view/log_subscriber'
-
-describe Logstasher do
+
+describe LogStasher do
   describe "when removing Rails' log subscribers" do
     after do
       ActionController::LogSubscriber.attach_to :action_controller
@@ -15,7 +9,7 @@ describe Logstasher do
 
     it "should remove subscribers for controller events" do
       expect {
-        Logstasher.remove_existing_log_subscriptions
+        LogStasher.remove_existing_log_subscriptions
       }.to change {
         ActiveSupport::Notifications.notifier.listeners_for('process_action.action_controller')
       }
@@ -23,7 +17,7 @@ describe Logstasher do
 
     it "should remove subscribers for all events" do
       expect {
-        Logstasher.remove_existing_log_subscriptions
+        LogStasher.remove_existing_log_subscriptions
       }.to change {
         ActiveSupport::Notifications.notifier.listeners_for('render_template.action_view')
       }
@@ -32,9 +26,101 @@ describe Logstasher do
     it "shouldn't remove subscribers that aren't from Rails" do
       blk = -> {}
       ActiveSupport::Notifications.subscribe("process_action.action_controller", &blk)
-      Logstasher.remove_existing_log_subscriptions
+      LogStasher.remove_existing_log_subscriptions
       listeners = ActiveSupport::Notifications.notifier.listeners_for('process_action.action_controller')
       listeners.size.should > 0
     end
   end
+
+  describe '.appened_default_info_to_payload' do
+    let(:params)  { {'a' => '1', 'b' => 2, 'action' => 'action', 'controller' => 'test'}.with_indifferent_access }
+    let(:payload) { {:params => params} }
+    let(:request) { mock(:params => params, :remote_ip => '10.0.0.1')}
+    after do
+      LogStasher.custom_fields = []
+    end
+    it 'appends default parameters to payload' do
+      LogStasher.custom_fields = []
+      LogStasher.add_default_fields_to_payload(payload, request)
+      payload[:ip].should == '10.0.0.1'
+      payload[:route].should == 'test#action'
+      payload[:parameters].should == "a=1\nb=2\n"
+      LogStasher.custom_fields.should == [:ip, :route, :parameters]
+    end
+  end
+
+  describe '.append_custom_params' do
+    let(:block) { ->{} }
+    it 'defines a method in ActionController::Base' do
+      ActionController::Base.should_receive(:send).with(:define_method, :logtasher_add_custom_fields_to_payload, &block)
+      LogStasher.add_custom_fields(&block)
+    end
+  end
+
+  describe '.setup' do
+    let(:logger) { mock }
+    let(:logstasher_config) { mock(:logger => logger,:log_level => 'warn') }
+    let(:config) { mock(:logstasher => logstasher_config) }
+    let(:app) { mock(:config => config) }
+    before do
+      config.stub(:action_dispatch => mock(:rack_cache => false))
+    end
+    it 'defines a method in ActionController::Base' do
+      LogStasher.should_receive(:require).with('logstasher/rails_ext/action_controller/metal/instrumentation')
+      LogStasher.should_receive(:require).with('logstash/event')
+      LogStasher.should_receive(:suppress_app_logs).with(app)
+      LogStasher::RequestLogSubscriber.should_receive(:attach_to).with(:action_controller)
+      logger.should_receive(:level=).with('warn')
+      LogStasher.setup(app)
+      LogStasher.enabled.should be_true
+      LogStasher.custom_fields.should == []
+    end
+  end
+
+  describe '.supress_app_logs' do
+    let(:logstasher_config){ mock(:logstasher => mock(:supress_app_log => true))}
+    let(:app){ mock(:config => logstasher_config)}
+    it 'removes existing subscription if enabled' do
+      LogStasher.should_receive(:require).with('logstasher/rails_ext/rack/logger')
+      LogStasher.should_receive(:remove_existing_log_subscriptions)
+      LogStasher.suppress_app_logs(app)
+    end
+  end
+
+  describe '.appended_params' do
+    it 'returns the stored var in current thread' do
+      Thread.current[:logstasher_custom_fields] = :test
+      LogStasher.custom_fields.should == :test
+    end
+  end
+
+  describe '.appended_params=' do
+    it 'returns the stored var in current thread' do
+      LogStasher.custom_fields = :test
+      Thread.current[:logstasher_custom_fields].should == :test
+    end
+  end
+
+  describe '.log' do
+    let(:logger) { mock() }
+    before do
+      LogStasher.logger = logger
+      LogStash::Time.stub(:now => 'timestamp')
+    end
+    it 'adds to log with specified level' do
+      logger.should_receive(:send).with('warn?').and_return(true)
+      logger.should_receive(:send).with('warn',"{\"@source\":\"unknown\",\"@tags\":[\"log\"],\"@fields\":{\"message\":\"WARNING\",\"level\":\"warn\"},\"@timestamp\":\"timestamp\"}")
+      LogStasher.log('warn', 'WARNING')
+    end
+  end
+
+  %w( fatal error warn info debug unknown ).each do |severity|
+    describe ".#{severity}" do
+      let(:message) { "This is a #{severity} message" }
+      it 'should log with specified level' do
+        LogStasher.should_receive(:log).with(severity.to_sym, message)
+        LogStasher.send(severity, message )
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,10 +1,47 @@
-# 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.rb"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+# Notice there is a .rspec file in the root folder. It defines rspec arguments
+
+# Ruby 1.9 uses simplecov. The ENV['COVERAGE'] is set when rake coverage is run in ruby 1.9
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    # Remove the spec folder from coverage. By default all code files are included. For more config options see
+    # https://github.com/colszowka/simplecov
+    add_filter File.expand_path('../../spec', __FILE__)
+  end
+end
+
+# Modify load path so you can require 'multi_config' directly.
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'rubygems'
+# Loads bundler setup tasks. Now if I run spec without installing gems then it would say gem not installed and
+# do bundle install instead of ugly load error on require.
+require 'bundler/setup'
+
+# This will require me all the gems automatically for the groups. If I do only .setup then I will have to require gems
+# manually. Note that you have still have to require some gems if they are part of bigger gem like ActiveRecord which is
+# part of Rails. You can say :require => false in gemfile to always use explicit requiring
+Bundler.require(:default, :test)
+
+# Set Rails environment as test
+ENV['RAILS_ENV'] = 'test'
+
 require 'action_pack'
+require 'action_controller'
+require 'logstasher'
+require 'active_support/notifications'
+require 'active_support/core_ext/string'
+require 'active_support/log_subscriber'
+require 'action_controller/log_subscriber'
+require 'action_view/log_subscriber'
+require 'active_support/core_ext/hash/except'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/hash/slice'
+require 'active_support/core_ext/string'
+require 'active_support/core_ext/time/zones'
+require 'abstract_controller/base'
+require 'logger'
+require 'logstash-event'
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstasher
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-06 00:00:00.000000000 Z
+date: 2013-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event
@@ -44,13 +44,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,39 +58,23 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rails
   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: actionpack
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '3.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 description: Awesome rails logs
 email:
 - shadab.ansari@gmail.com
@@ -127,12 +111,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4048643813953369805
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4048643813953369805
 requirements: []
 rubyforge_project: logstasher
 rubygems_version: 1.8.25