logstasher 0.4.9 → 0.5.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjQ0MTI1YmFiNDhhZWU4ODczZmQ2MzUwOTJlYzJlY2Q5NmE0MDFjMQ==
+    ZGM0Y2IzY2FhZmU1OGI4ZGY3NmRhMWI4ZjBlMjY0ZGI4YTdjNDYzOA==
   data.tar.gz: !binary |-
-    MGU5ZGIwYWRhYTgwZDUxMDcxNTg1OGNlM2EzMDRkNjA4Yzk4ZDVhNA==
+    Y2NjYTljN2IwMGJhYjYwYjQ0ZDExMWU5OWYzNDcyZTRkOWI5YjViOA==
 SHA512:
   metadata.gz: !binary |-
-    YzY2ZGU0NWQxNjk3YjExNjY2YWZlMjQ0MDJhNjBiMjg4YWE3NDUwOTIxZDc2
-    OTkzNzk1ZTU0ZDM5MTM1YTE0ZDgyY2MxODZhNTFiNjJlZjIxYjQ3ZTFkYjUy
-    ZmFmYTBhNTc3MDIxZjkwYTk5NDMxZjIwNzdiNTZhOGQyOTE4NzY=
+    NjE1NmIxYzcwZDU4ODc4MGM3NmVlNjE4NzlhMzFiMjZjMTk3OTY4N2E3NDk1
+    Yjk0YzAyZjU5NDY4ZjY1YzE4MzljYjU3MTM1YzJiMTE4ZjgyNmQzMzBjZDVj
+    NTA5NzlmNWNmMjczYmM4YjdhYTQyMDVhMDFkNWU4MjVhMmY2N2E=
   data.tar.gz: !binary |-
-    YWNkNzc5OGEwMDVlN2Y0ZmYwMTUyM2U2NTY0NDZhY2ZmNzA3ZjI4M2NhZDIy
-    OWVlM2ZjZDVkMjAzYWU1ZjQ1ODI0ZTczYTBjNWRlNThhY2ViNzNiYTBjOGIx
-    ODNiZTdlYTg2MDVlMjEyN2JiOTM2N2Y3ZGI3YzUwOGU3OTJjNmI=
+    MDI0NDAwMGI4ZmYxNjJmMGRjYzRhMTM2NzhkOTgwOTFkOTg1MzQ1OWRlNTAw
+    YThiNWM0YzA5NjQ2NDZiYzAyMmU2NmRhYTdjNDQwNzEzYzc3YThmNjZlYjBj
+    NDU3NTFjZjkxYzg1MGM5NTIyODlhYjkwNDlkZGFkNjE2YWU2NDM=

data/README.md

@@ -59,6 +59,9 @@ In your Gemfile:
     # This line is optional if you do not want to suppress app logs in your <environment>.log
     config.logstasher.suppress_app_log = false
 
+    # This line is optional, it allows you to set a custom value for the @source field of the log event
+    config.logstasher.source = 'your.arbitrary.source'
+
 ## Logging params hash
 
 Logstasher can be configured to log the contents of the params hash.  When enabled, the contents of the params hash (minus the ActionController internal params)
@@ -79,7 +82,7 @@ Since some fields are very specific to your application for e.g. *user_name*, so
 
     if LogStasher.enabled
       LogStasher.add_custom_fields do |fields|
-        # This block is run in application_controller context, 
+        # This block is run in application_controller context,
         # so you have access to all controller methods
         fields[:user] = current_user && current_user.mail
         fields[:site] = request.path =~ /^\/api/ ? 'api' : 'user'

data/Rakefile

@@ -39,4 +39,12 @@ else
     ENV['COVERAGE'] = "true"
     Rake::Task['spec'].execute
   end
-end
+end
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'logstasher'
+  ARGV.clear
+  IRB.start
+end

data/lib/logstasher.rb

@@ -6,7 +6,9 @@ require 'active_support/ordered_options'
 
 module LogStasher
   extend self
-  attr_accessor :logger, :enabled, :log_controller_parameters
+  attr_accessor :logger, :enabled, :log_controller_parameters, :source
+  # Setting the default to 'unknown' to define the default behaviour
+  @source = 'unknown'
 
   def remove_existing_log_subscriptions
     ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
@@ -54,6 +56,7 @@ module LogStasher
     LogStasher::RequestLogSubscriber.attach_to :action_controller
     self.logger = app.config.logstasher.logger || new_logger("#{Rails.root}/log/logstash_#{Rails.env}.log")
     self.logger.level = app.config.logstasher.log_level || Logger::WARN
+    self.source = app.config.logstasher.source unless app.config.logstasher.source.nil?
     self.enabled = true
     self.log_controller_parameters = !! app.config.logstasher.log_controller_parameters
   end
@@ -78,10 +81,9 @@ module LogStasher
     Thread.current[:logstasher_custom_fields] = val
   end
 
-
   def log(severity, msg)
     if self.logger && self.logger.send("#{severity}?")
-      event = LogStash::Event.new('@fields' => {:message => msg, :level => severity},'@tags' => ['log'])
+      event = LogStash::Event.new('@source' => self.source, '@fields' => {:message => msg, :level => severity}, '@tags' => ['log'])
       self.logger.send severity, event.to_json
     end
   end

data/lib/logstasher/log_subscriber.rb

@@ -15,7 +15,7 @@ module LogStasher
 
       tags = ['request']
       tags.push('exception') if payload[:exception]
-      event = LogStash::Event.new('@fields' => data, '@tags' => tags)
+      event = LogStash::Event.new('@source' => LogStasher.source, '@fields' => data, '@tags' => tags)
       LogStasher.logger << event.to_json + "\n"
     end
 

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

@@ -11,18 +11,20 @@ module ActionController
       }
 
       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
-        logtasher_add_custom_fields_to_payload(raw_payload)
-        after_keys = raw_payload.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)
 
       ActiveSupport::Notifications.instrument("process_action.action_controller", raw_payload) do |payload|
         result = super
+        
+        if self.respond_to?(:logtasher_add_custom_fields_to_payload)
+          before_keys = raw_payload.keys.clone
+          logtasher_add_custom_fields_to_payload(raw_payload)
+          after_keys = raw_payload.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
+        
         payload[:status] = response.status
         append_info_to_payload(payload)
         result
@@ -30,4 +32,4 @@ module ActionController
     end
 
   end
-end
+end

data/lib/logstasher/version.rb

@@ -1,3 +1,3 @@
 module LogStasher
-  VERSION = "0.4.9"
+  VERSION = "0.5.0"
 end

data/spec/lib/logstasher_spec.rb

@@ -66,14 +66,16 @@ describe LogStasher do
     end
   end
 
-  describe '.setup' do
+  shared_examples 'setup' do
     let(:logger) { double }
-    let(:logstasher_config) { double(:logger => logger,:log_level => 'warn',:log_controller_parameters => nil) }
+    let(:logstasher_config) { double(:logger => logger, :log_level => 'warn', :log_controller_parameters => nil, :source => logstasher_source) }
     let(:config) { double(:logstasher => logstasher_config) }
     let(:app) { double(:config => config) }
     before do
+      @previous_source = LogStasher.source
       config.stub(:action_dispatch => double(:rack_cache => false))
     end
+    after { LogStasher.source = @previous_source } # Need to restore old source for specs
     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')
@@ -81,12 +83,25 @@ describe LogStasher do
       LogStasher::RequestLogSubscriber.should_receive(:attach_to).with(:action_controller)
       logger.should_receive(:level=).with('warn')
       LogStasher.setup(app)
+      LogStasher.source.should == (logstasher_source || 'unknown')
       LogStasher.enabled.should be_true
       LogStasher.custom_fields.should == []
       LogStasher.log_controller_parameters.should == false
     end
   end
 
+  describe '.setup' do
+    describe 'with source set' do
+      let(:logstasher_source) { 'foo' }
+      it_behaves_like 'setup'
+    end
+
+    describe 'without source set (default behaviour)' do
+      let(:logstasher_source) { nil }
+      it_behaves_like 'setup'
+    end
+  end
+
   describe '.suppress_app_logs' do
     let(:logstasher_config){ double(:logstasher => double(:suppress_app_log => true))}
     let(:app){ double(:config => logstasher_config)}
@@ -140,6 +155,16 @@ describe LogStasher do
       logger.should_receive(:send).with('warn',"{\"@source\":\"unknown\",\"@tags\":[\"log\"],\"@fields\":{\"message\":\"WARNING\",\"level\":\"warn\"},\"@timestamp\":\"timestamp\"}")
       LogStasher.log('warn', 'WARNING')
     end
+    context 'with a source specified' do
+      before :each do
+        LogStasher.source = 'foo'
+      end
+      it 'sets the correct source' do
+        logger.should_receive(:send).with('warn?').and_return(true)
+        logger.should_receive(:send).with('warn',"{\"@source\":\"foo\",\"@tags\":[\"log\"],\"@fields\":{\"message\":\"WARNING\",\"level\":\"warn\"},\"@timestamp\":\"timestamp\"}")
+        LogStasher.log('warn', 'WARNING')
+      end
+    end
   end
 
   %w( fatal error warn info debug unknown ).each do |severity|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logstasher
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.5.0
 platform: ruby
 authors:
 - Shadab Ahmed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-21 00:00:00.000000000 Z
+date: 2014-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logstash-event