rv-logstasher 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea6daba64559c9c69a821753732edf9e8b77edaa
-  data.tar.gz: 554087f41c7d7020a63f4b33d1c03a1cdc4c88b7
+  metadata.gz: ae42bed976297c0bd68a70f5c8c1c2b6f7bdb24f
+  data.tar.gz: 11b24849c5ec9abf497e5585afb754ed9e262c51
 SHA512:
-  metadata.gz: 8fdc8e9a709c4e1986e94d3c64d1ab6e8d46648635e845d18ca8f732daca8adb419fe45818867f457dd7d584cbe1c4ace989f44a2ed0b0756a27cc49a2c48466
-  data.tar.gz: 6efb4264890e4d316fb5ca027436aec251f3007ead6d037b02b6423014b899217ce6bb99735c084ab97e2b32d53de6f91eb6d6d23cd38f3a8887099d7f2c64cd
+  metadata.gz: b8d12f21f733c625f27fc2de6ec78ccf07aa29ea4d2475b6249ce09c217fdb42b495074e8c60aa0ecbb86c72179d006bc6f6292c44e09a3852218baa97cf7aa6
+  data.tar.gz: 999f1d3d9137d865310ab239a13639a608bd5c33160c0b09bdb98253bd6d87d143de5d2dd8f8fddb40a5eab88e81a9d0aa3d5396fdf2d10eb623ab76f86d766e

data/lib/logstasher.rb

@@ -74,8 +74,8 @@ module LogStasher
       @filter_parameters ||= ['password', 'password_confirmation']
     end
 
-    def filter_parameters=(params)
-      @filter_parameters = params
+    def filter_paramterss=(params)
+      @filter_paramterss = params
     end
   end
 end

data/lib/logstasher/log_formatter.rb

@@ -34,12 +34,29 @@ module LogStasher
     private
 
     def format_hash(data)
-      data.merge!(request_path: data[:path]) if data[:path] # logstash overrides the path attribute
-      if data[:exception]
-        format_exception(data.delete(:exception)).merge(data)
+      formatted_data = filter_parameters(data)
+
+      # logstash overrides the path attribute
+      formatted_data.merge!(request_path: formatted_data[:path]) if formatted_data[:path]
+
+      if formatted_data[:exception]
+        format_exception(formatted_data.delete(:exception)).merge(formatted_data)
       else
-        data
+        formatted_data
+      end
+    end
+
+    def filter_parameters(data)
+      return data unless data[:params]
+
+      # We override fields, don't want to risk mutating params object!
+      filtered_data = data.dup
+
+      LogStasher.filter_parameters.each do |param|
+        filtered_data[:params][param] = '[FILTERED]' unless filtered_data[:params][param].nil?
       end
+
+      filtered_data
     end
 
     def format_exception(exception)

data/lib/logstasher/log_subscriber.rb

@@ -93,9 +93,6 @@ module LogStasher
     def extract_parameters(payload)
       if LogStasher.include_parameters?
         external_params = payload[:params].except(*INTERNAL_PARAMS)
-        LogStasher.filter_parameters.each do |param|
-          external_params[param] = '[FILTERED]' unless external_params[param].nil?
-        end
 
         if LogStasher.serialize_parameters?
           { :params => JSON.generate(external_params) }

data/lib/logstasher/version.rb

@@ -1,3 +1,3 @@
 module LogStasher
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

data/spec/lib/logstasher/log_formater_spec.rb

@@ -25,25 +25,32 @@ describe LogStasher::LogFormatter do
     ]
   end
 
-  subject { described_class.new('base-tag', '/my/root/releases/12345') }
+  let(:instance) { described_class.new('base-tag', '/my/root/releases/12345') }
 
   describe '#release' do
+    subject(:release) { instance.release }
+
     it 'returns indetifier of release from the root dir' do
-      expect(subject.release).to eq('12345')
+      expect(release).to eq('12345')
     end
   end
 
   describe '#format' do
+    subject(:format) { instance.format(data) }
+
     context 'with string as an argument' do
+      let(:data) { 'foo' }
+
       it 'returns hash with message key' do
-        expect(subject.format('foo')).to eq({ message: 'foo' })
+        expect(format).to eq({ message: 'foo' })
       end
     end
 
     context 'with exception as an argument' do
+      let(:data) { exception }
 
       it 'returns hash describing the exception' do
-        expect(subject.format(exception)).to match({
+        expect(format).to match({
           tags:            'exception',
           error_class:     'TestError',
           error_message:   exception_message,
@@ -60,9 +67,11 @@ describe LogStasher::LogFormatter do
     end
 
     context 'with hash as an argument' do
+      let(:data) { { foo: 'bar', path: '/my/path' } }
+
       it 'returns hash as it is with path attribute copied to request_path' do
         # logstash overrides the path attribute
-        expect(subject.format({ foo: 'bar', path: '/my/path' })).to match({
+        expect(format).to match({
           foo:          'bar',
           path:         '/my/path',
           request_path: '/my/path',
@@ -71,8 +80,10 @@ describe LogStasher::LogFormatter do
     end
 
     context 'with hash containing exception key as an argument' do
+      let(:data) { { exception: exception, tags: 'custom_tag', foo: 'bar' } }
+
       it 'returns hash describing the exception merged with items from origina hash' do
-        expect(subject.format({ exception: exception, tags: 'custom_tag', foo: 'bar' })).to match({
+        expect(format).to match({
           tags:            'custom_tag',
           error_class:     'TestError',
           error_message:   exception_message,
@@ -88,18 +99,58 @@ describe LogStasher::LogFormatter do
         })
       end
     end
+
+    context 'when the hash contains filtered parameters' do
+      describe 'defaults' do
+        let(:data) do
+          {
+            params: {
+              'password' => '1337passWORD',
+              'password_confirmation' => '1337passWORD'
+            }
+          }
+        end
+
+        it 'filters out password and password_confirmation' do
+          expect(format).to match(
+            params: {
+              'password' => '[FILTERED]',
+              'password_confirmation' => '[FILTERED]'
+            }
+          )
+        end
+      end
+
+      context 'with specified filtering' do
+        let(:data) { {params: {'foo' => 'bar', 'blah' => 'something'}} }
+        before(:each) do
+          allow(::LogStasher).to receive(:filter_parameters).and_return(['foo'])
+        end
+
+        it 'filters out the specified fields only' do
+          expect(format).to match(params: {'foo' => '[FILTERED]', 'blah' => 'something'})
+        end
+      end
+    end
   end
 
   describe '#call' do
+    let(:args) do
+      [
+        :error,
+        Time.new(2016, 01, 02, 03, 04, 05),
+        progname,
+        exception_message
+      ]
+    end
+
+    subject(:call) { instance.call(*args) }
+
     context 'when progname is nil' do
       let(:progname) { nil }
 
       it 'returns hash with message key' do
-        result = JSON.parse(subject.call(
-          :error,
-          Time.new(2016, 01, 02, 03, 04, 05),
-          progname,
-          exception_message)).deep_symbolize_keys!
+        result = JSON.parse(call).deep_symbolize_keys!
 
         expect(result).to include({
           message:  exception_message,
@@ -115,15 +166,10 @@ describe LogStasher::LogFormatter do
       let(:progname) { exception }
 
       it 'returns hash describing the exception' do
-        result = JSON.parse(subject.call(
-          :error,
-          Time.new(2016, 01, 02, 03, 04, 05),
-          progname,
-          exception_message)).deep_symbolize_keys!
+        result = JSON.parse(call).deep_symbolize_keys!
 
         expect(result).to include({
           message:         exception_message,
-          tags:            'exception',
           error_class:     'TestError',
           error_message:   exception_message,
           error_source:    '/foo/broken.rb',

data/spec/lib/logstasher/log_subscriber_spec.rb

@@ -35,12 +35,11 @@ describe LogStasher::LogSubscriber do
   describe '#process_action' do
     let(:timestamp) { ::Time.new.utc.iso8601(3) }
     let(:duration) { 12.4 }
-    let(:params) { {'foo' => 'bar'} }
     let(:json_params) { JSON.dump(payload[:params]) }
     let(:payload) {{
       :controller => 'users',
       :action     => 'show',
-      :params     => params,
+      :params     => { 'foo' => 'bar' },
       :format     => 'text/plain',
       :method     => 'method',
       :path       => '/users/1',
@@ -106,32 +105,6 @@ describe LogStasher::LogSubscriber do
       subject.process_action(event)
     end
 
-    it 'can be configured to filter out certain parameters' do
-      allow(::LogStasher).to receive(:filter_parameters).and_return(['foo'])
-
-      expect(logger).to receive(:<<) do |json|
-        expect(JSON.parse(json)['params']).to eq('{"foo":"[FILTERED]"}')
-      end
-
-      subject.process_action(event)
-    end
-
-    context 'with passwords in parameters' do
-      let(:params) do
-        {'password' => '1337passWORD', 'password_confirmation' => '1337passWORD'}
-      end
-
-      it 'filters them out by default' do
-        expect(logger).to receive(:<<) do |json|
-          expect(JSON.parse(json)['params']).to eq(
-            '{"password":"[FILTERED]","password_confirmation":"[FILTERED]"}'
-          )
-        end
-
-        subject.process_action(event)
-      end
-    end
-
     it 'includes redirect location in the log' do
       redirect_event = double(:payload => {:location => 'new/location'})
       subject.redirect_to(redirect_event)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rv-logstasher
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - David Sevcik