stasher 0.1.0

data/spec/lib/stasher_spec.rb

@@ -0,0 +1,246 @@
+require 'spec_helper'
+
+describe Stasher do
+  describe "when removing Rails' log subscribers" do
+    after do
+      ActionController::LogSubscriber.attach_to :action_controller
+      ActionView::LogSubscriber.attach_to :action_view
+    end
+
+    it "should remove subscribers for controller events" do
+      expect {
+        Stasher.remove_existing_log_subscriptions
+      }.to change {
+        ActiveSupport::Notifications.notifier.listeners_for('process_action.action_controller')
+      }
+    end
+
+    it "should remove subscribers for all events" do
+      expect {
+        Stasher.remove_existing_log_subscriptions
+      }.to change {
+        ActiveSupport::Notifications.notifier.listeners_for('render_template.action_view')
+      }
+    end
+
+    it "shouldn't remove subscribers that aren't from Rails" do
+      blk = -> {}
+      ActiveSupport::Notifications.subscribe("process_action.action_controller", &blk)
+      Stasher.remove_existing_log_subscriptions
+      listeners = ActiveSupport::Notifications.notifier.listeners_for('process_action.action_controller')
+      listeners.size.should > 0
+    end
+  end
+
+  describe '.add_default_fields_to_scope' do
+    let(:scope) { {} }
+    let(:request) { double(:params => {}, :remote_ip => '10.0.0.1', :uuid => "uuid" )}
+    
+    it 'appends default parameters to payload' do
+      Stasher.add_default_fields_to_scope(scope, request)
+      
+      scope.should == { :uuid => "uuid" }
+    end
+  end
+
+  describe '.add_custom_fields' do
+    let(:block) { ->{} }
+
+    it 'defines a method in ActionController::Metal' do
+      ActionController::Metal.should_receive(:send).with(:define_method, :stasher_add_custom_fields_to_scope, &block)
+      Stasher.add_custom_fields(&block)
+    end
+  end
+
+  describe '.setup' do
+    let(:logger) { double }
+    let(:stasher_config) { double(:logger => logger, :redirect_logger => true, :attach_to => [:active_record], :log_level => nil, :suppress_app_log => nil ) }
+    let(:config) { double(:stasher => stasher_config) }
+    let(:app) { double(:config => config) }
+    
+    before :each do
+      logger.stub(:level=)
+      config.stub(:action_dispatch => double(:rack_cache => false))
+    end
+
+    context "when suppress_app_log is true" do
+      before :each do
+        stasher_config.stub(:suppress_app_log).and_return(true)
+      end
+
+      it 'suppresses the default logger' do
+        Stasher.should_receive(:suppress_app_logs).with(app)
+        Stasher.setup(app)
+      end
+    end
+
+    context "when suppress_app_log is false" do
+      before :each do
+        stasher_config.stub(:suppress_app_log).and_return(false)
+      end
+
+      it 'does not suppress the default logger' do
+        Stasher.should_not_receive(:suppress_app_logs).with(app)
+
+        Stasher.setup(app)
+      end
+    end
+
+    it "attaches to the requested notifiers" do
+      Stasher::LogSubscriber.should_receive(:attach_to).with(:active_record)
+  
+      Stasher.setup(app)
+    end
+
+    context "when a log level is configured" do
+      before :each do
+        stasher_config.stub(:log_level).and_return(:debug)
+      end
+
+      it "sets the configured log level" do
+        logger.should_receive(:level=).with(::Logger::DEBUG)
+
+        Stasher.setup(app)
+      end
+    end
+
+    context "when a log level is not configured" do
+      it "defaults to WARN" do
+        logger.should_receive(:level=).with(::Logger::WARN)
+
+        Stasher.setup(app)
+      end
+    end
+
+    it "sets itself as enabled" do
+      Stasher.setup(app)
+      Stasher.enabled.should be_true
+    end
+
+    it "sets its source" do
+      Stasher.stub(:hostname).and_return('hostname')
+
+      Stasher.setup(app)
+      Stasher.source.should == "rails://hostname/r_spec/mocks"
+    end    
+  end
+
+  describe '.suppress_app_logs' do
+    let(:stasher_config){ double(:stasher => double.as_null_object).as_null_object }
+    let(:app){ double(:config => stasher_config)}
+
+    it 'removes existing subscriptions' do
+      Stasher.should_receive(:require).with('stasher/rails_ext/rack/logger')
+      Stasher.should_receive(:remove_existing_log_subscriptions)
+      Stasher.suppress_app_logs(app)
+    end
+  end
+
+  describe '.format_exception' do
+    let(:type_name) { 'type' }
+    let(:message) { 'message' }
+    let(:backtrace) { 'backtrace' }
+
+    it "returns a hash of exception details" do
+      Stasher.format_exception(type_name, message, backtrace).should == {
+        :exception => {
+          :name => type_name,
+          :message => message,
+          :backtrace => backtrace
+        }
+      }
+    end
+  end
+
+  describe '.log' do
+    let(:logger) { MockLogger.new }
+    
+    before :each do
+      Stasher.logger = logger
+      Stasher.source = "source"
+      LogStash::Time.stub(:now => 'timestamp')
+    end
+
+    it 'ensures the log is configured to log at the given level' do
+      logger.should_receive(:send).with('warn?').and_return(true)
+      Stasher.log('warn', 'WARNING')
+    end
+
+    it "does not log if the log level is higher than the severity" do      
+      expect {
+        Stasher.log('debug', 'DEBUG')        
+      }.not_to change{logger.messages.size}
+    end
+
+    it 'adds to log with specified level' do     
+      Stasher.log('warn', 'WARNING')
+
+      logger.messages.first.should include '"@fields":{"severity":"WARN"}'
+    end
+
+    it "adds the 'log' tag" do
+      Stasher.log('warn', 'WARNING')
+      logger.messages.first.should match %r|"@tags":\[[^\[]*"log"[^\]]*\]|
+    end
+
+    it "adds a tag indicating the severity" do
+      Stasher.log('warn', 'WARNING')
+      logger.messages.first.should match %r|"@tags":\[[^\[]*"warn"[^\]]*\]|
+    end
+
+    it "logs the message to @message" do
+      Stasher.log('warn', "MESSAGE")
+      logger.messages.first.should include '"@message":"MESSAGE"'
+    end
+
+    it "logs the source to @source" do
+      Stasher.log('warn', "MESSAGE")
+      logger.messages.first.should include '"@source":"source"'
+    end
+
+    it "strips out ANSI color sequences" do
+      Stasher.log('warn', "\e[7;1mHELLO\e[0m WORLD")
+      logger.messages.first.should include '"@message":"HELLO WORLD"'
+    end
+
+    context "with fields in the current scope" do      
+      before :each do
+        Stasher::CurrentScope.fields = { :field => "value" }
+      end
+
+      it 'includes the current scope fields' do
+        Stasher.log('warn', 'WARNING')
+        
+        logger.messages.first.should match %r|"@fields":{[^}]*"field":"value"[^}]*}|
+      end
+    end
+
+    context "when logging an Exception" do
+      let(:exception) { Exception.new("Message") }
+
+      before :each do
+        exception.set_backtrace ["first", "second"]
+      end
+
+      it "logs the exception details" do
+        Stasher.log('error', exception)
+        logger.messages.first.should match %r|"exception":{"name":"Exception","message":"Message","backtrace":"first\\nsecond"}|
+      end
+
+      it "adds the 'exception' tag" do
+        Stasher.log('error', exception)
+        logger.messages.first.should match %r|\"@tags\":\[[^\[]*\"exception\"[^\]]*\]|
+      end
+    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
+        Stasher.should_receive(:log).with(severity.to_sym, message)
+        Stasher.send(severity, message )
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,64 @@
+# 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 'active_record'
+require 'socket'
+require 'stasher'
+require 'active_support/notifications'
+require 'active_support/core_ext/string'
+require 'active_support/log_subscriber'
+require 'active_record/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'
+
+FactoryGirl.find_definitions
+
+Dir[File.expand_path("spec/support/**/*.rb")].each {|f| require f}
+
+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.before :each do
+    # Clear the current scope object, if it's set
+    Stasher::CurrentScope.clear!
+  end
+
+end

data/spec/support/mock_logger.rb

@@ -0,0 +1,19 @@
+##
+# A standard Logger that logs messages to an array (accessible as #messages)
+class MockLogger < ::Logger
+  def initialize(log_level = ::Logger::WARN)
+    super(nil)
+    @messages = []
+    self.level = log_level
+  end
+
+  attr_reader :messages
+
+  def reset!
+    @messages = []
+  end
+
+  def <<(message)
+    @messages << message
+  end
+end

data/stasher.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stasher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stasher"
+  spec.version       = Stasher::VERSION
+  spec.authors       = ["Chris Micacchi"]
+  spec.email         = ["cdmicacc@gmail.com"]
+  spec.description   = %q{Send Rails log messages to logstash}
+  spec.summary       = %q{Send Rails log messages to logstash}
+  spec.homepage      = "https://github.com/cdmicacc/stasher"
+  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_runtime_dependency "logstash-event"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rails", ">= 3.2"
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: stasher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Chris Micacchi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-26 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Send Rails log messages to logstash
+email:
+- cdmicacc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitattributes
+- .gitignore
+- .rspec
+- .ruby-gemset
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stasher.rb
+- lib/stasher/current_scope.rb
+- lib/stasher/log_subscriber.rb
+- lib/stasher/logger.rb
+- lib/stasher/rails_ext/action_controller/metal/instrumentation.rb
+- lib/stasher/rails_ext/rack/logger.rb
+- lib/stasher/railtie.rb
+- lib/stasher/version.rb
+- spec/factories/payloads.rb
+- spec/lib/stasher/current_scope_spec.rb
+- spec/lib/stasher/log_subscriber_spec.rb
+- spec/lib/stasher/logger_spec.rb
+- spec/lib/stasher_spec.rb
+- spec/spec_helper.rb
+- spec/support/mock_logger.rb
+- stasher.gemspec
+homepage: https://github.com/cdmicacc/stasher
+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: 2540691357130130508
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2540691357130130508
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Send Rails log messages to logstash
+test_files:
+- spec/factories/payloads.rb
+- spec/lib/stasher/current_scope_spec.rb
+- spec/lib/stasher/log_subscriber_spec.rb
+- spec/lib/stasher/logger_spec.rb
+- spec/lib/stasher_spec.rb
+- spec/spec_helper.rb
+- spec/support/mock_logger.rb