logstasher 0.4.7 → 0.4.8

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDAyMmQ1MzFmZDM2NzVlNjQ0ZDkwMzI5MzExOGE5ZThhYzVlYTk4Ng==
+    MjdkMjE3MDE0ZWEzMDQ3Y2VkOTdjNjllODg4Y2UzNzZkOTg1Yjc5MA==
   data.tar.gz: !binary |-
-    ZGJlYjA5OTYxNzFjMjM3MTZmZjk5YzM2YTdiYjM4OWM5YzFlMjc0NA==
+    YTcyYTI4MDY1NTY0YjJhMzg3MjlkMTM4NjQ0N2VmNTRmNTJlZGNmNA==
 SHA512:
   metadata.gz: !binary |-
-    OWFiNmFkMjA5MzBhNjhiMWU4Yzc5ZTZlNjA4MmIyNzFmOTUxOTYzZjI4NjIx
-    YzhhYTA4M2E5YTNjNGI4MzdjNjAxOTQ2OTY3OWUxYjZkMzJkZjIzY2I3NDJh
-    NmIwM2NiMGViY2ZjNTEwY2ZkYWYwMWMzNTc4NzViYzc4ZGNmOWI=
+    YTEzNmI5ZmU0MTJhZWYzN2IwMzhlMTJhYjc1NGU0OTA3MGQzNWI4Mjc4ODNl
+    NTU0NGJiMTc3NmNlM2E4ZDliOTMzYmMyYmQ0ZWUxY2E1NWE0ZWJlZWZlNTZl
+    NTFjZjQxOWIwNzQ0NzhkNzE0NDYyYzg1YWEwYzdmNjBhYWM1MTU=
   data.tar.gz: !binary |-
-    ZGJhNTA4OTk4YWNjMTQ1NTNiNDM3NzAyNzA3ZmU3MDEwMmExNjdlODhmY2Iw
-    YTE3ZWZhZmFlYTBkMWZiZWY2YTg5MzcxYWM1Zjk2NTE1MTgzZWZiZTVjZDU1
-    MzgyYWI3YjIwZjQzMjY1N2JlN2QxM2E4ZWY5NTg3YTMyMmRhNmU=
+    YTllN2NlMzFkNDI4MTNjN2QxNjRhNjI1ZTk5NTAxZjc2ZTYwNDdiODgwZTAz
+    NDU1MDUwYjM4NTBkZDc1MzlkMzc0MmU1NzQ4MGY3ZDNlMzNjZDliYmM3MWM3
+    YjgzMmU1MzdkNzM0MTkxNmRiNGNmMjdjZmU5Zjk0MGRhYjU3MmE=

data/README.md

@@ -59,6 +59,18 @@ 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
 
+## 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)
+will be added to the log as a deep hash.  This can cause conflicts within the Elasticsearch mappings though, so should be enabled with care.  Conflicts will occur
+if different actions (or even different applications logging to the same Elasticsearch cluster) use the same params key, but with a different data type (e.g. a
+string vs. a hash).  This can lead to lost log entries.  Enabling this can also significantly increase the size of the Elasticsearch indexes.
+
+To enable this, add the following to your `<environment>.rb`
+
+    # Enable logging of controller params
+    config.logstasher.log_controller_parameters = true
+
 ## Adding custom fields to the log
 
 Since some fields are very specific to your application for e.g. *user_name*, so it is left upto you, to add them. Here's how to add those fields to the logs:

data/lib/logstasher.rb

@@ -6,7 +6,7 @@ require 'active_support/ordered_options'
 
 module LogStasher
   extend self
-  attr_accessor :logger, :enabled
+  attr_accessor :logger, :enabled, :log_controller_parameters
 
   def remove_existing_log_subscriptions
     ActiveSupport::LogSubscriber.log_subscribers.each do |subscriber|
@@ -33,8 +33,11 @@ module LogStasher
   def 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)
-    self.custom_fields += [:ip, :route, :parameters]
+    self.custom_fields += [:ip, :route]
+    if self.log_controller_parameters
+      payload[:parameters] = payload[:params].except(*ActionController::LogSubscriber::INTERNAL_PARAMS)
+      self.custom_fields += [:parameters]
+    end
   end
 
   def add_custom_fields(&block)
@@ -52,6 +55,7 @@ module LogStasher
     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.enabled = true
+    self.log_controller_parameters = !! app.config.logstasher.log_controller_parameters
   end
 
   def suppress_app_logs(app)

data/lib/logstasher/version.rb

@@ -1,3 +1,3 @@
 module LogStasher
-  VERSION = "0.4.7"
+  VERSION = "0.4.8"
 end

data/spec/lib/logstasher/log_subscriber_spec.rb

@@ -14,8 +14,12 @@ describe LogStasher::RequestLogSubscriber do
   }
   before do
     LogStasher.logger = logger
+    LogStasher.log_controller_parameters = true
     LogStasher.custom_fields = []
   end
+  after do
+    LogStasher.log_controller_parameters = false
+  end
 
   let(:subscriber) {LogStasher::RequestLogSubscriber.new}
   let(:event) {

data/spec/lib/logstasher_spec.rb

@@ -38,8 +38,10 @@ describe LogStasher do
     let(:request) { double(:params => params, :remote_ip => '10.0.0.1')}
     after do
       LogStasher.custom_fields = []
+      LogStasher.log_controller_parameters = false
     end
     it 'appends default parameters to payload' do
+      LogStasher.log_controller_parameters = true
       LogStasher.custom_fields = []
       LogStasher.add_default_fields_to_payload(payload, request)
       payload[:ip].should == '10.0.0.1'
@@ -47,6 +49,13 @@ describe LogStasher do
       payload[:parameters].should == {'a' => '1', 'b' => 2}
       LogStasher.custom_fields.should == [:ip, :route, :parameters]
     end
+
+    it 'does not include parameters when not configured to' do
+      LogStasher.custom_fields = []
+      LogStasher.add_default_fields_to_payload(payload, request)
+      payload.should_not have_key(:parameters)
+      LogStasher.custom_fields.should == [:ip, :route]
+    end
   end
 
   describe '.append_custom_params' do
@@ -59,7 +68,7 @@ describe LogStasher do
 
   describe '.setup' do
     let(:logger) { double }
-    let(:logstasher_config) { double(:logger => logger,:log_level => 'warn') }
+    let(:logstasher_config) { double(:logger => logger,:log_level => 'warn',:log_controller_parameters => nil) }
     let(:config) { double(:logstasher => logstasher_config) }
     let(:app) { double(:config => config) }
     before do
@@ -74,6 +83,7 @@ describe LogStasher do
       LogStasher.setup(app)
       LogStasher.enabled.should be_true
       LogStasher.custom_fields.should == []
+      LogStasher.log_controller_parameters.should == false
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstasher
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.4.8
 platform: ruby
 authors:
 - Shadab Ahmed