logasm 0.5.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9ade685a2af887a257340ed2dab29d09abceb8a
-  data.tar.gz: 1b5671acbe54ce055156a496a481ce524270a3b1
+  metadata.gz: 56e3d511b8873dffb529444790ec2c111f2e06ce
+  data.tar.gz: 26ae968b0af65670a1fe9db8801b69748f6d6c96
 SHA512:
-  metadata.gz: d5a206ab30b603af225468e52195c9ef3e87b42d2bf71cd7794ebe98b3eabe952fe9df666d1a1618915a379e7ac0559fba7e5543d6dbf5d1de1574157fb3ce83
-  data.tar.gz: b363d87991efde13a6ea82b82e673536aa83179ad1f103f1d8098fe00222bf2b9e321b5a9bc59cf3ce0b9fbf451ec53eeb11c5ebfd8b3f11c21265d9a363d88e
+  metadata.gz: f71ce0380318847e9fe3eafd4cd4f9ab26b4175e2cd796dd575d9cf2f4192ca298d0b801b5e9464ccdc649c7dc0b0071b4f29fce2514bd099f8342806123de89
+  data.tar.gz: 38cf576d4f1e8f2961cbf8416373de2a06f6960bb83e13dc692940a56cd1554ca5537eac9be9650aba935030ea0dbd4b83d4e396f826dfac1178d6205b9303ef

data/README.md

@@ -108,7 +108,7 @@ Received request {"info":{"phone":"************"}}
 
 Masks all the fields except those whitelisted in the configuration using [JSON Pointer](https://tools.ietf.org/html/rfc6901).
 Only simple values(`string`, `number`, `boolean`) can be whitelisted.
-Whitelisting array elements can be done using wildcard symbol `~`.
+Whitelisting array and hash elements can be done using wildcard symbol `~`.
 
 #### Configuration
 

data/lib/logasm/adapters/stdout_json_adapter.rb

@@ -0,0 +1,43 @@
+class Logasm
+  module Adapters
+    class StdoutJsonAdapter
+      def initialize(level, service_name, *)
+        @level = level
+        @service_name = service_name
+      end
+
+      def log(level, metadata = {})
+        if meets_threshold?(level)
+          message = Utils.build_event(metadata, level, @service_name)
+          STDOUT.puts(JSON.dump(message))
+        end
+      end
+
+      def debug?
+        meets_threshold?(:debug)
+      end
+
+      def info?
+        meets_threshold?(:info)
+      end
+
+      def warn?
+        meets_threshold?(:warn)
+      end
+
+      def error?
+        meets_threshold?(:error)
+      end
+
+      def fatal?
+        meets_threshold?(:fatal)
+      end
+
+      private
+
+      def meets_threshold?(level)
+        LOG_LEVELS.index(level.to_s) >= @level
+      end
+    end
+  end
+end

data/lib/logasm/adapters.rb

@@ -3,8 +3,24 @@ class Logasm
     LOG_LEVELS = %w(debug info warn error fatal unknown).freeze
 
     def self.get(type, service_name, arguments)
-      require_relative "adapters/#{type.to_s}_adapter"
-      adapter = const_get(Inflecto.camelize(type.to_s) + 'Adapter')
+      adapter =
+        if type == 'rabbitmq'
+          require_relative 'adapters/rabbitmq_adapter'
+          RabbitmqAdapter
+        elsif type == 'logstash'
+          require_relative 'adapters/logstash_adapter'
+          LogstashAdapter
+        elsif type == 'stdout'
+          if arguments.fetch(:json, false)
+            require_relative 'adapters/stdout_json_adapter'
+            StdoutJsonAdapter
+          else
+            require_relative 'adapters/stdout_adapter'
+            StdoutAdapter
+          end
+        else
+          raise "Unsupported logger: #{type}"
+        end
       level = LOG_LEVELS.index(arguments.fetch(:level, 'debug'))
       adapter.new(level, service_name, arguments)
     end

data/lib/logasm/preprocessors/blacklist.rb

@@ -4,6 +4,7 @@ class Logasm
 
       DEFAULT_ACTION = 'exclude'
       MASK_SYMBOL = '*'
+      MASKED_VALUE = MASK_SYMBOL * 5
 
       class UnsupportedActionException < Exception
       end
@@ -48,20 +49,12 @@ class Logasm
       end
 
       def mask_field(data, key, val)
-        if val.is_a?(Hash) || val.is_a?(Array) || is_boolean?(val)
-          data.merge(key => MASK_SYMBOL)
-        else
-          data.merge(key => MASK_SYMBOL * val.to_s.length)
-        end
+        data.merge(key => MASKED_VALUE)
       end
 
       def exclude_field(data, *)
         data
       end
-
-      def is_boolean?(val)
-        val.is_a?(TrueClass) || val.is_a?(FalseClass)
-      end
     end
   end
 end

data/lib/logasm/preprocessors/whitelist.rb

@@ -4,6 +4,7 @@ class Logasm
 
       DEFAULT_WHITELIST = %w(/id /message /correlation_id /queue)
       MASK_SYMBOL = '*'
+      MASKED_VALUE = MASK_SYMBOL * 5
       WILDCARD = '~'
 
       class InvalidPointerFormatException < Exception
@@ -85,8 +86,14 @@ class Logasm
       end
 
       def process_hash(parent_pointer, hash)
+        create_child_pointer =
+          if @wildcards["#{parent_pointer}/~"]
+            lambda { |_| "#{parent_pointer}/~" }
+          else
+            lambda { |key| "#{parent_pointer}/#{key}" }
+          end
         hash.inject({}) do |mem, (key, value)|
-          pointer = "#{parent_pointer}/#{key}"
+          pointer = create_child_pointer.call(key)
           processed_value = process_data(pointer, value)
           mem.merge(key => processed_value)
         end
@@ -110,21 +117,9 @@ class Logasm
         if @fields_to_include[parent_pointer]
           value
         else
-          mask value
+          MASKED_VALUE
         end
       end
-
-      def mask(value)
-        if value && value.respond_to?(:to_s) && !is_boolean?(value)
-          MASK_SYMBOL * value.to_s.length
-        else
-          MASK_SYMBOL
-        end
-      end
-
-      def is_boolean?(value)
-        value.is_a?(TrueClass) || value.is_a?(FalseClass)
-      end
     end
   end
 end

data/logasm.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |gem|
   gem.name          = "logasm"
-  gem.version       = '0.5.2'
+  gem.version       = '0.7.0'
   gem.authors       = ["Salemove"]
   gem.email         = ["support@salemove.com"]
   gem.description   = %q{It's logasmic}

data/spec/adapters/stdout_json_adapter_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require_relative '../../lib/logasm/adapters/stdout_json_adapter'
+
+describe Logasm::Adapters::StdoutJsonAdapter do
+  let(:debug_level_code) { 0 }
+  let(:debug_level) { Logasm::Adapters::LOG_LEVELS[debug_level_code] }
+  let(:info_level_code) { 1 }
+  let(:info_level) { Logasm::Adapters::LOG_LEVELS[info_level_code] }
+
+  describe '#log' do
+    context 'when below threshold' do
+      let(:adapter) { described_class.new(debug_level_code, service_name) }
+      let(:metadata) { {x: 'y'} }
+      let(:event) { {a: 'b', x: 'y'} }
+      let(:serialized_event) { JSON.dump(event) }
+      let(:service_name) { 'my-service' }
+
+      before do
+        allow(Logasm::Utils).to receive(:build_event)
+          .with(metadata, info_level, service_name)
+          .and_return(event)
+      end
+
+      it 'sends serialized event to STDOUT' do
+        expect(STDOUT).to receive(:puts).with(serialized_event)
+        adapter.log(info_level, metadata)
+      end
+    end
+
+    context 'when above threshold' do
+      let(:adapter) { described_class.new(info_level_code, service_name) }
+      let(:metadata) { {x: 'y'} }
+      let(:service_name) { 'my-service' }
+
+      it 'does not log the event' do
+        expect(STDOUT).to_not receive(:puts)
+        adapter.log(debug_level, metadata)
+      end
+    end
+  end
+end

data/spec/logasm_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Logasm do
   describe '.build' do
-    it 'creates file logger' do
+    it 'creates stdout logger' do
       expect(described_class).to receive(:new) do |adapters|
         expect(adapters.count).to be(1)
         expect(adapters.first).to be_a(described_class::Adapters::StdoutAdapter)
@@ -11,6 +11,15 @@ describe Logasm do
       described_class.build('test_service', stdout: nil)
     end
 
+    it 'creates stdout json logger' do
+      expect(described_class).to receive(:new) do |adapters|
+        expect(adapters.count).to be(1)
+        expect(adapters.first).to be_a(described_class::Adapters::StdoutJsonAdapter)
+      end
+
+      described_class.build('test_service', stdout: {json: true})
+    end
+
     it 'creates logstash logger' do
       expect(described_class).to receive(:new) do |adapters|
         expect(adapters.count).to be(1)

data/spec/preprocessors/blacklist_spec.rb

@@ -56,18 +56,18 @@ describe Logasm::Preprocessors::Blacklist do
     let(:action) { 'mask' }
 
     it 'masks nested field' do
-      expect(processed_data).to include_at_depth({field: '******'}, 1)
+      expect(processed_data).to include_at_depth({field: '*****'}, 1)
     end
 
     it 'masks nested in array field' do
-      expect(processed_data[:array]).to include({field: '******'})
+      expect(processed_data[:array]).to include({field: '*****'})
     end
 
     context 'when field is string' do
       let(:value) { 'secret' }
 
       it 'masks value with asterisks' do
-        expect(processed_data).to include(field: '******')
+        expect(processed_data).to include(field: '*****')
       end
     end
 
@@ -75,31 +75,31 @@ describe Logasm::Preprocessors::Blacklist do
       let(:value) { 42 }
 
       it 'masks number value' do
-        expect(processed_data).to include(field: '**')
+        expect(processed_data).to include(field: '*****')
       end
     end
 
     context 'when field is boolean' do
       let(:value) { true }
 
-      it 'masks value with one asterisk' do
-        expect(processed_data).to include(field: '*')
+      it 'masks value with asterisks' do
+        expect(processed_data).to include(field: '*****')
       end
     end
 
     context 'when field is array' do
       let(:value) { [1,2,3,4] }
 
-      it 'masks value with one asterisk' do
-        expect(processed_data).to include(field: '*')
+      it 'masks value with asterisks' do
+        expect(processed_data).to include(field: '*****')
       end
     end
 
     context 'when field is hash' do
       let(:value) { {data: {}} }
 
-      it 'masks value with one asterisk' do
-        expect(processed_data).to include(field: '*')
+      it 'masks value with asterisks' do
+        expect(processed_data).to include(field: '*****')
       end
     end
 
@@ -108,7 +108,7 @@ describe Logasm::Preprocessors::Blacklist do
       let(:data) { data_with_nested_field({field: 'secret'}, depth) }
 
       it 'masks deeply nested field' do
-        expect(processed_data).to include_at_depth({field: '******'}, depth)
+        expect(processed_data).to include_at_depth({field: '*****'}, depth)
       end
     end
   end

data/spec/preprocessors/whitelist_spec.rb

@@ -16,11 +16,11 @@ describe Logasm::Preprocessors::Whitelist do
 
   it 'masks all non-whitelisted fields' do
     expect(processed_data).to eq({
-      field: '******',
+      field: '*****',
       data: {
-        field: '******'
+        field: '*****'
       },
-      array: [{field: '******'}]
+      array: [{field: '*****'}]
     })
   end
 
@@ -39,9 +39,9 @@ describe Logasm::Preprocessors::Whitelist do
       expect(processed_data).to eq({
         field: 'secret',
         data: {
-          field: '******'
+          field: '*****'
         },
-        array: [{field: '******'}]
+        array: [{field: '*****'}]
       })
     end
   end
@@ -51,11 +51,11 @@ describe Logasm::Preprocessors::Whitelist do
 
     it 'includes nested field' do
       expect(processed_data).to eq({
-        field: '******',
+        field: '*****',
         data: {
           field: 'secret'
         },
-        array: [{field: '******'}]
+        array: [{field: '*****'}]
       })
     end
   end
@@ -65,15 +65,29 @@ describe Logasm::Preprocessors::Whitelist do
 
     it 'includes array element' do
       expect(processed_data).to eq({
-        field: '******',
+        field: '*****',
         data: {
-          field: '******'
+          field: '*****'
         },
         array: [{field: 'secret'}]
       })
     end
   end
 
+  context 'with whitelisted hash' do
+    it 'includes all whitelisted hash elements' do
+      source = {foo: {bar: 'baz'}}
+      target = {foo: {bar: 'baz'}}
+      expect(process(['/foo/~'], source)).to eq(target)
+    end
+
+    it 'does not include nested elements' do
+      source = {foo: {bar: {baz: 'asd'}}}
+      target = {foo: {bar: {baz: '***'}}}
+      expect(process(['/foo/~'], source)).to eq(target)
+    end
+  end
+
   context 'with whitelisted array elements field with wildcard' do
     let(:data) {{
       array: [{field: 'data1', secret: 'secret1'}, {field: 'data2', secret: 'secret2'}]
@@ -82,7 +96,7 @@ describe Logasm::Preprocessors::Whitelist do
 
     it 'includes array elements field' do
       expect(processed_data).to include(
-        array: [{field: 'data1', secret: '*******'}, {field: 'data2', secret: '*******'}]
+        array: [{field: 'data1', secret: '*****'}, {field: 'data2', secret: '*****'}]
       )
     end
   end
@@ -102,7 +116,7 @@ describe Logasm::Preprocessors::Whitelist do
     let(:pointers) { ['/array/0'] }
 
     it 'masks array element' do
-      expect(processed_data).to include(array: [{field: '******'}])
+      expect(processed_data).to include(array: [{field: '*****'}])
     end
   end
 
@@ -110,7 +124,7 @@ describe Logasm::Preprocessors::Whitelist do
     let(:pointers) { ['/array'] }
 
     it 'masks array' do
-      expect(processed_data).to include(array: [{field: '******'}])
+      expect(processed_data).to include(array: [{field: '*****'}])
     end
   end
 
@@ -118,15 +132,15 @@ describe Logasm::Preprocessors::Whitelist do
     let(:pointers) { ['/data'] }
 
     it 'masks hash' do
-      expect(processed_data).to include(data: {field: '******'})
+      expect(processed_data).to include(data: {field: '*****'})
     end
   end
 
   context 'when boolean present' do
     let(:data) { {bool: true} }
 
-    it 'masks it with single asteriks' do
-      expect(processed_data).to eq(bool: '*')
+    it 'masks it with asteriks' do
+      expect(processed_data).to eq(bool: '*****')
     end
   end
 
@@ -173,7 +187,7 @@ describe Logasm::Preprocessors::Whitelist do
       expect(processed_data).to include('field_with_~'=> 'secret')
     end
   end
-  
+
   context 'when field has tilde and 1' do
     let(:data) {{
       'field_with_~1' => 'secret'
@@ -184,4 +198,8 @@ describe Logasm::Preprocessors::Whitelist do
       expect(processed_data).to include('field_with_~1'=> 'secret')
     end
   end
+
+  def process(pointers, data)
+    described_class.new(pointers: pointers).process(data)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logasm
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Salemove
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-01 00:00:00.000000000 Z
+date: 2017-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inflecto
@@ -86,6 +86,7 @@ files:
 - lib/logasm/adapters/logstash_adapter/formatter.rb
 - lib/logasm/adapters/rabbitmq_adapter.rb
 - lib/logasm/adapters/stdout_adapter.rb
+- lib/logasm/adapters/stdout_json_adapter.rb
 - lib/logasm/null_logger.rb
 - lib/logasm/preprocessors.rb
 - lib/logasm/preprocessors/blacklist.rb
@@ -96,6 +97,7 @@ files:
 - spec/adapters/logstash_adapter_spec.rb
 - spec/adapters/rabbitmq_adapter_spec.rb
 - spec/adapters/stdout_adapter_spec.rb
+- spec/adapters/stdout_json_adapter_spec.rb
 - spec/logasm_spec.rb
 - spec/preprocessors/blacklist_spec.rb
 - spec/preprocessors/whitelist_spec.rb
@@ -131,6 +133,7 @@ test_files:
 - spec/adapters/logstash_adapter_spec.rb
 - spec/adapters/rabbitmq_adapter_spec.rb
 - spec/adapters/stdout_adapter_spec.rb
+- spec/adapters/stdout_json_adapter_spec.rb
 - spec/logasm_spec.rb
 - spec/preprocessors/blacklist_spec.rb
 - spec/preprocessors/whitelist_spec.rb