semantic_logger 3.4.1 → 4.0.0.beta1

data/lib/semantic_logger/subscriber.rb

@@ -99,10 +99,10 @@ module SemanticLogger
     def extract_formatter(formatter, &block)
       case
       when formatter.is_a?(Symbol)
-        SemanticLogger.constantize_symbol(formatter, 'SemanticLogger::Formatters').new
+        SemanticLogger::Appender.constantize_symbol(formatter, 'SemanticLogger::Formatters').new
       when formatter.is_a?(Hash) && formatter.size > 0
         fmt, options = formatter.first
-        SemanticLogger.constantize_symbol(fmt.to_sym, 'SemanticLogger::Formatters').new(options)
+        SemanticLogger::Appender.constantize_symbol(fmt.to_sym, 'SemanticLogger::Formatters').new(options)
       when formatter.respond_to?(:call)
         formatter
       when block

data/lib/semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module SemanticLogger #:nodoc
-  VERSION = '3.4.1'
+  VERSION = '4.0.0.beta1'
 end

data/test/appender/bugsnag_test.rb

@@ -5,7 +5,7 @@ module Appender
   class BugsnagTest < Minitest::Test
     describe SemanticLogger::Appender::Bugsnag do
       before do
-        @appender = SemanticLogger::Appender::Bugsnag.new(:info)
+        @appender = SemanticLogger::Appender::Bugsnag.new(level: :info)
         @message  = 'AppenderBugsnagTest log message'
       end
 
@@ -25,8 +25,8 @@ module Appender
             @appender.send(level, @message)
           end
           if [:trace, :debug].include?(level)
-            assert_equal nil, exception
-            assert_equal nil, hash
+            assert_nil exception
+            assert_nil hash
           else
             assert_equal 'RuntimeError', exception.class.to_s
             assert_equal @message, exception.message
@@ -40,13 +40,14 @@ module Appender
             @appender.send(level, @message, {key1: 1, key2: 'a'})
           end
           if [:trace, :debug].include?(level)
-            assert_equal nil, exception
-            assert_equal nil, hash
+            assert_nil exception
+            assert_nil hash
           else
             assert_equal 'RuntimeError', exception.class.to_s
             assert_equal @message, exception.message
-            assert_equal 1, hash[:key1], hash
-            assert_equal 'a', hash[:key2], hash
+            assert payload = hash[:payload], hash
+            assert_equal 1, payload[:key1], payload
+            assert_equal 'a', payload[:key2], payload
           end
         end
 
@@ -57,8 +58,8 @@ module Appender
             @appender.send(level, @message, error)
           end
           if [:trace, :debug].include?(level)
-            assert_equal nil, exception
-            assert_equal nil, hash
+            assert_nil exception
+            assert_nil hash
           else
             assert_equal error.class.to_s, exception.class.to_s
             assert_equal error.message, exception.message

data/test/appender/elasticsearch_test.rb

@@ -64,8 +64,9 @@ module Appender
           assert_equal @message, message['message']
           assert_equal level.to_s, message['level']
           refute message['stack_trace']
-          assert_equal(1, message['key1'], message)
-          assert_equal('a', message['key2'], message)
+          assert payload = message['payload'], message
+          assert_equal 1, payload['key1'], message
+          assert_equal 'a', payload['key2'], message
         end
       end
 

data/test/appender/graylog_test.rb

@@ -21,7 +21,7 @@ module Appender
 
       it 'send exception notifications to Graylog with severity' do
         hash = nil
-        exc = nil
+        exc  = nil
         begin
           Uh oh
         rescue Exception => e
@@ -55,8 +55,9 @@ module Appender
         assert_equal @message, hash[:short_message]
         assert_equal 3, hash[:level]
         refute hash[:stack_trace]
-        assert_equal(1, hash[:key1], hash)
-        assert_equal('a', hash[:key2], hash)
+        assert payload = hash[:payload], hash
+        assert_equal 1, payload[:key1], payload
+        assert_equal 'a', payload[:key2], payload
       end
     end
   end

data/test/appender/honeybadger_test.rb

@@ -5,8 +5,8 @@ module Appender
   class HoneybadgerTest < Minitest::Test
     describe SemanticLogger::Appender::Honeybadger do
       before do
-        @appender = SemanticLogger::Appender::Honeybadger.new(:trace)
-        @message  = 'AppenderHoneybadgerTest log message'
+        @appender                      = SemanticLogger::Appender::Honeybadger.new(:trace)
+        @message                       = 'AppenderHoneybadgerTest log message'
         SemanticLogger.backtrace_level = :error
       end
 

data/test/appender/http_test.rb

@@ -53,8 +53,9 @@ module Appender
           assert_equal @message, hash['message']
           assert_equal level.to_s, hash['level']
           refute hash['stack_trace']
-          assert_equal 1, hash['key1'], hash
-          assert_equal 'a', hash['key2'], hash
+          assert payload = hash['payload'], hash
+          assert_equal 1, payload['key1'], payload
+          assert_equal 'a', payload['key2'], payload
         end
 
       end

data/test/appender/mongodb_test.rb

@@ -1,14 +1,12 @@
 require_relative '../test_helper'
 
 # Unit Test for SemanticLogger::Appender::MongoDB
-#
 module Appender
   class MongoDBTest < Minitest::Test
     describe SemanticLogger::Appender::MongoDB do
       before do
-        @db                 = Mongo::Connection.new['test']
         @appender           = SemanticLogger::Appender::MongoDB.new(
-          db:              @db,
+          uri:             'mongodb://127.0.0.1:27017/test',
           collection_size: 10*1024**2, # 10MB
           host:            'test',
           application:     'test_application',
@@ -25,27 +23,28 @@ module Appender
       describe 'format logs into documents' do
         it 'handle no arguments' do
           @appender.debug
-          document = @appender.collection.find_one
+          document = @appender.collection.find.first
           assert_equal :debug, document['level']
-          assert_equal nil, document['message']
+          assert_nil document['message']
           assert_equal 'thread', document['thread']
           assert document['time'].is_a?(Time)
-          assert_equal nil, document['payload']
+          assert_nil document['payload']
           assert_equal $$, document['pid']
           assert_equal 'test', document['host']
           assert_equal 'test_application', document['application']
         end
 
-        it 'handle hash message' do
-          @appender.debug(@hash)
+        it 'handle named parameters' do
+          @appender.debug(payload: @hash)
 
-          document = @appender.collection.find_one
+          document = @appender.collection.find.first
           assert_equal :debug, document['level']
-          assert_equal nil, document['message']
+          assert_nil document['message']
           assert_equal 'thread', document['thread']
           assert document['time'].is_a?(Time)
-          assert_equal 12345, document['tracking_number']
-          assert_equal 'HSSKLEU@JDK767', document['session_id']
+          assert payload = document['payload']
+          assert_equal 12345, payload['tracking_number'], payload
+          assert_equal 'HSSKLEU@JDK767', payload['session_id']
           assert_equal $$, document['pid']
           assert_equal 'test', document['host']
           assert_equal 'test_application', document['application']
@@ -54,13 +53,14 @@ module Appender
         it 'handle message and payload' do
           @appender.debug('hello world', @hash)
 
-          document = @appender.collection.find_one
+          document = @appender.collection.find.first
           assert_equal :debug, document['level']
           assert_equal 'hello world', document['message']
           assert_equal 'thread', document['thread']
           assert document['time'].is_a?(Time)
-          assert_equal 12345, document['tracking_number']
-          assert_equal 'HSSKLEU@JDK767', document['session_id']
+          assert payload = document['payload']
+          assert_equal 12345, payload['tracking_number'], payload
+          assert_equal 'HSSKLEU@JDK767', payload['session_id']
           assert_equal $$, document['pid']
           assert_equal 'test', document['host']
           assert_equal 'test_application', document['application']
@@ -69,7 +69,7 @@ module Appender
         it 'handle message without payload' do
           @appender.debug('hello world')
 
-          document = @appender.collection.find_one
+          document = @appender.collection.find.first
           assert_equal :debug, document['level']
           assert_equal 'hello world', document['message']
           assert_equal 'thread', document['thread']
@@ -80,18 +80,19 @@ module Appender
         end
       end
 
-      describe 'for each log level' do
-        # Ensure that any log level can be logged
-        SemanticLogger::LEVELS.each do |level|
-          it 'log #{level} information' do
+      # Ensure that any log level can be logged
+      SemanticLogger::LEVELS.each do |level|
+        describe "##{level}" do
+          it 'logs' do
             @appender.send(level, 'hello world -- Calculations', @hash)
-            document = @appender.collection.find_one
+            document = @appender.collection.find.first
             assert_equal level, document['level']
             assert_equal 'hello world -- Calculations', document['message']
             assert_equal 'thread', document['thread']
             assert document['time'].is_a?(Time)
-            assert_equal 12345, document['tracking_number']
-            assert_equal 'HSSKLEU@JDK767', document['session_id']
+            assert payload = document['payload']
+            assert_equal 12345, payload['tracking_number'], payload
+            assert_equal 'HSSKLEU@JDK767', payload['session_id']
             assert_equal $$, document['pid']
             assert_equal 'test', document['host'], document.ai
             assert_equal 'test_application', document['application']

data/test/appender/new_relic_test.rb

@@ -44,9 +44,9 @@ module Appender
       it 'send notification to New Relic with custom attributes' do
         exception = hash = nil
         NewRelic::Agent.stub(:notice_error, -> exc, h { exception = exc; hash = h }) do
-          @appender.tagged('test') do
-            @appender.with_payload({key1: 1, key2: 'a'}) do
-              @appender.measure(:error, @message) do
+          SemanticLogger.tagged('test') do
+            SemanticLogger.named_tagged(key1: 1, key2: 'a') do
+              @appender.measure_error(message: @message, payload: {key3: 4}) do
                 sleep 0.001
               end
             end
@@ -54,11 +54,18 @@ module Appender
         end
         assert_equal 'RuntimeError', exception.class.to_s
         assert_equal @message, exception.message
-        assert_equal ['test'], hash[:custom_params][:tags], hash
-        assert_equal 1, hash[:custom_params][:key1], hash
-        assert_equal 'a', hash[:custom_params][:key2], hash
-        assert hash[:custom_params][:duration], hash
-        assert hash[:custom_params][:thread], hash
+        assert params = hash[:custom_params], hash
+        assert params[:duration], params
+        assert params[:thread], params
+
+        assert_equal ['test'], params[:tags], params
+
+        assert named_tags = params[:named_tags], params
+        assert_equal 1, named_tags[:key1], named_tags
+        assert_equal 'a', named_tags[:key2], named_tags
+
+        assert payload = params[:payload], params
+        assert_equal 4, payload[:key3], payload
       end
     end
   end

data/test/appender/sentry_test.rb

@@ -5,8 +5,8 @@ module Appender
   class SentryTest < Minitest::Test
     describe SemanticLogger::Appender::Sentry do
       before do
-        @appender = SemanticLogger::Appender::Sentry.new(:trace)
-        @message  = 'AppenderRavenTest log message'
+        @appender                      = SemanticLogger::Appender::Sentry.new(:trace)
+        @message                       = 'AppenderRavenTest log message'
         SemanticLogger.backtrace_level = :error
       end
 

data/test/appender/splunk_http_test.rb

@@ -13,7 +13,7 @@ module Appender
             token: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
           )
         end
-        @message  = 'AppenderSplunkHttpTest log message'
+        @message = 'AppenderSplunkHttpTest log message'
       end
 
       SemanticLogger::LEVELS.each do |level|
@@ -57,12 +57,13 @@ module Appender
           end
           body    = decompress_data(request.body)
           message = JSON.parse(body)
-          assert message['event'], message.ai
-          assert_equal @message, message['event']['message']
-          assert_equal level.to_s, message['event']['level']
-          refute message['event']['stack_trace']
-          assert_equal(1, message['event']['key1'], message)
-          assert_equal('a', message['event']['key2'], message)
+          assert event = message['event'], message.ai
+          assert_equal @message, event['message']
+          assert_equal level.to_s, event['level']
+          refute event['stack_trace']
+          assert payload = event['payload'], event
+          assert_equal(1, payload['key1'], message)
+          assert_equal('a', payload['key2'], message)
         end
       end
 

data/test/appender/splunk_test.rb

@@ -61,11 +61,12 @@ module Appender
           end
           assert_equal @message, mock.message
 
-          assert mock.event[:event], mock.event.ai
-          assert_equal level, mock.event[:event][:level]
-          refute mock.event[:event][:stack_trace]
-          assert_equal(1, mock.event[:event][:key1], mock.event)
-          assert_equal('a', mock.event[:event][:key2], mock.event)
+          assert event = mock.event[:event], mock.event.ai
+          assert_equal level, event[:level]
+          refute event[:stack_trace]
+          assert payload = event[:payload]
+          assert_equal(1, payload[:key1], payload)
+          assert_equal('a', payload[:key2], payload)
         end
       end
 

data/test/appender/tcp_test.rb

@@ -3,8 +3,6 @@ require_relative '../test_helper'
 # Unit Test for SemanticLogger::Appender::Tcp
 module Appender
   class TcpTest < Minitest::Test
-    response_mock = Struct.new(:code, :body)
-
     describe SemanticLogger::Appender::Tcp do
       before do
         Net::TCPClient.stub_any_instance(:connect, true) do
@@ -58,8 +56,9 @@ module Appender
           assert_equal @message, hash['message']
           assert_equal level.to_s, hash['level']
           refute hash['stack_trace']
-          assert_equal 1, hash['key1'], hash
-          assert_equal 'a', hash['key2'], hash
+          assert payload = hash['payload'], hash
+          assert_equal 1, payload['key1'], payload
+          assert_equal 'a', payload['key2'], payload
         end
 
       end

data/test/appender/udp_test.rb

@@ -3,12 +3,10 @@ require_relative '../test_helper'
 # Unit Test for SemanticLogger::Appender::Tcp
 module Appender
   class UdpTest < Minitest::Test
-    response_mock = Struct.new(:code, :body)
-
     describe SemanticLogger::Appender::Udp do
       before do
         @appender = SemanticLogger::Appender::Udp.new(server: 'localhost:8088')
-        @message = 'AppenderUdpTest log message'
+        @message  = 'AppenderUdpTest log message'
       end
 
       SemanticLogger::LEVELS.each do |level|
@@ -51,8 +49,9 @@ module Appender
           assert_equal @message, hash['message']
           assert_equal level.to_s, hash['level']
           refute hash['stack_trace']
-          assert_equal 1, hash['key1'], hash
-          assert_equal 'a', hash['key2'], hash
+          assert payload = hash['payload'], hash
+          assert_equal 1, payload['key1'], payload
+          assert_equal 'a', payload['key2'], payload
         end
 
       end

data/test/appender/wrapper_test.rb

@@ -6,59 +6,58 @@ module Appender
   class WrapperTest < Minitest::Test
     describe SemanticLogger::Appender::Wrapper do
       before do
-        @time        = Time.new
-        @mock_logger = MockLogger.new
-        @appender    = SemanticLogger::Appender::Wrapper.new(@mock_logger)
-        @hash        = {session_id: 'HSSKLEU@JDK767', tracking_number: 12345}
-        @hash_str    = @hash.inspect.sub("{", "\\{").sub("}", "\\}")
+        SemanticLogger.default_level   = :trace
+        SemanticLogger.backtrace_level = :trace
+
+        @time              = Time.new
+        @mock_logger       = MockLogger.new
+        @appender          = SemanticLogger::Appender::Wrapper.new(@mock_logger)
+        @hash              = {session_id: 'HSSKLEU@JDK767', tracking_number: 12345}
+        @hash_str          = @hash.inspect.sub("{", "\\{").sub("}", "\\}")
+        @thread_name       = Thread.current.name
+        @file_name_reg_exp = ' wrapper_test.rb:\d+'
       end
 
       describe 'format logs into text form' do
-        it 'handle nil name, message and payload' do
-          log       = SemanticLogger::Log.new
-          log.time  = Time.now
-          log.level = :debug
-          @appender.log(log)
-          assert_match(/\d+-\d+-\d+ \d+:\d+:\d+.\d+ D \[\d+:\] /, @mock_logger.message)
+        it 'logs blank data' do
+          @appender.debug
+          assert_match(/\d+-\d+-\d+ \d+:\d+:\d+.\d+ D \[\d+:#{@thread_name}#{@file_name_reg_exp}\] SemanticLogger::Appender::Wrapper/, @mock_logger.message)
         end
 
-        it 'handle nil message and payload' do
-          log       = SemanticLogger::Log.new
-          log.time  = Time.now
-          log.level = :debug
-          log.name  = 'class'
-          @appender.log(log)
-          assert_match(/\d+-\d+-\d+ \d+:\d+:\d+.\d+ D \[\d+:\] class/, @mock_logger.message)
+        it 'logs message' do
+          @appender.debug('hello world')
+          assert_match(/\d+-\d+-\d+ \d+:\d+:\d+.\d+ D \[\d+:#{@thread_name}#{@file_name_reg_exp}\] SemanticLogger::Appender::Wrapper -- hello world/, @mock_logger.message)
         end
 
-        it 'handle nil payload' do
-          log         = SemanticLogger::Log.new
-          log.time    = Time.now
-          log.level   = :debug
-          log.name    = 'class'
-          log.message = 'hello world'
-          @appender.log(log)
-          assert_match(/\d+-\d+-\d+ \d+:\d+:\d+.\d+ D \[\d+:\] class -- hello world/, @mock_logger.message)
+        it 'logs message and payload' do
+          @appender.debug('hello world', @hash)
+          assert_match(/\d+-\d+-\d+ \d+:\d+:\d+.\d+ D \[\d+:#{@thread_name}#{@file_name_reg_exp}\] SemanticLogger::Appender::Wrapper -- hello world -- #{@hash_str}/, @mock_logger.message)
         end
 
-        it 'handle payload' do
-          log         = SemanticLogger::Log.new
-          log.time    = Time.now
-          log.level   = :debug
-          log.name    = 'class'
-          log.message = 'hello world'
-          log.payload = @hash
-          @appender.log(log)
-          assert_match(/\d+-\d+-\d+ \d+:\d+:\d+.\d+ D \[\d+:\] class -- hello world -- #{@hash_str}/, @mock_logger.message)
+        it 'logs named parameters' do
+          @appender.debug(message: 'hello world', payload: @hash)
+          assert_match(/\d+-\d+-\d+ \d+:\d+:\d+.\d+ D \[\d+:#{@thread_name}#{@file_name_reg_exp}\] SemanticLogger::Appender::Wrapper -- hello world -- #{@hash_str}/, @mock_logger.message)
         end
       end
 
       describe 'for each log level' do
+        before do
+          @appender = SemanticLogger.add_appender(logger: @mock_logger)
+          @logger   = SemanticLogger[WrapperTest]
+        end
+
+        after do
+          SemanticLogger.remove_appender(@appender)
+        end
+
         # Ensure that any log level can be logged
         Logger::Severity.constants.each do |level|
-          it "log #{level.downcase.to_sym} info" do
-            @appender.log SemanticLogger::Log.new(level.downcase.to_sym, 'thread', 'class', 'hello world', @hash, Time.now)
-            assert_match(/\d+-\d+-\d+ \d+:\d+:\d+.\d+ \w \[\d+:thread\] class -- hello world -- #{@hash_str}/, @mock_logger.message)
+          it "log #{level.downcase.to_sym}" do
+            level_char = level[0].upcase
+            level_char = 'E' if level_char == 'U'
+            @logger.send(level.downcase.to_sym, 'hello world', @hash)
+            SemanticLogger.flush
+            assert_match(/\d+-\d+-\d+ \d+:\d+:\d+.\d+ #{level_char} \[\d+:#{@thread_name}#{@file_name_reg_exp}\] Appender::WrapperTest -- hello world -- #{@hash_str}/, @mock_logger.message)
           end
         end
       end