semantic_logger 4.0.0 → 4.1.0

data/lib/semantic_logger/subscriber.rb

@@ -7,7 +7,7 @@ module SemanticLogger
     attr_accessor :formatter
     attr_writer :application, :host
 
-    # Returns the current log level if set, otherwise it logs everything it receives
+    # Returns the current log level if set, otherwise it logs everything it receives.
     def level
       @level || :trace
     end
@@ -22,17 +22,17 @@ module SemanticLogger
       # NOOP
     end
 
-    # Returns [SemanticLogger::Formatters::Default] formatter default for this subscriber
+    # Returns [SemanticLogger::Formatters::Default] default formatter for this subscriber.
     def default_formatter
       SemanticLogger::Formatters::Default.new
     end
 
-    # Allow application name to be set globally or per subscriber
+    # Allow application name to be set globally or on a per subscriber basis.
     def application
       @application || SemanticLogger.application
     end
 
-    # Allow host name to be set globally or per subscriber
+    # Allow host name to be set globally or on a per subscriber basis.
     def host
       @host || SemanticLogger.host
     end
@@ -57,37 +57,32 @@ module SemanticLogger
     #     Proc: Only include log messages where the supplied Proc returns true
     #           The Proc must return true or false.
     #
-    #   host: [String]
-    #     Name of this host to appear in log messages.
-    #     Default: SemanticLogger.host
-    #
     #   application: [String]
     #     Name of this application to appear in log messages.
     #     Default: SemanticLogger.application
-    def initialize(options={}, &block)
-      # Backward compatibility
-      options      = {level: options} unless options.is_a?(Hash)
-      options      = options.dup
-      level        = options.delete(:level)
-      filter       = options.delete(:filter)
-      @formatter   = extract_formatter(options.delete(:formatter), &block)
-      @application = options.delete(:application)
-      @host        = options.delete(:host)
-      raise(ArgumentError, "Unknown options: #{options.inspect}") if options.size > 0
+    #
+    #   host: [String]
+    #     Name of this host to appear in log messages.
+    #     Default: SemanticLogger.host
+    def initialize(level: nil, formatter: nil, filter: nil, application: nil, host: nil, &block)
+      @formatter   = extract_formatter(formatter, &block)
+      @application = application
+      @host        = host
 
-      # Subscribers don't take a class name, so use this class name if an subscriber
-      # is logged to directly
+      # Subscribers don't take a class name, so use this class name if a subscriber
+      # is logged to directly.
       super(self.class, level, filter)
     end
 
-    # Return the level index for fast comparisons
+    # Return the level index for fast comparisons.
     # Returns the lowest level index if the level has not been explicitly
-    # set for this instance
+    # set for this instance.
     def level_index
       @level_index || 0
     end
 
-    # Return formatter that responds to call
+    # Return formatter that responds to call.
+    #
     # Supports formatter supplied as:
     # - Symbol
     # - Hash ( Symbol => { options })
@@ -114,14 +109,5 @@ module SemanticLogger
       end
     end
 
-    SUBSCRIBER_OPTIONS = [:level, :formatter, :filter, :application, :host].freeze
-
-    # Returns [Hash] the subscriber common options from the supplied Hash
-    def extract_subscriber_options!(options)
-      subscriber_options = {}
-      SUBSCRIBER_OPTIONS.each { |key| subscriber_options[key] = options.delete(key) if options.has_key?(key) }
-      subscriber_options
-    end
-
   end
 end

data/lib/semantic_logger/version.rb

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

data/test/appender/elasticsearch_http_test.rb

@@ -0,0 +1,75 @@
+require_relative '../test_helper'
+
+# Unit Test for SemanticLogger::Appender::Elasticsearch
+module Appender
+  class ElasticsearchHttpTest < Minitest::Test
+    response_mock = Struct.new(:code, :body)
+
+    describe SemanticLogger::Appender::ElasticsearchHttp do
+      before do
+        Net::HTTP.stub_any_instance(:start, true) do
+          @appender = SemanticLogger::Appender::ElasticsearchHttp.new(
+            url: 'http://localhost:9200'
+          )
+        end
+        @message = 'AppenderElasticsearchTest log message'
+      end
+
+      it 'logs to daily indexes' do
+        index = nil
+        @appender.stub(:post, -> json, ind { index = ind }) do
+          @appender.info @message
+        end
+        assert_equal "/semantic_logger-#{Time.now.utc.strftime('%Y.%m.%d')}/log", index
+      end
+
+      SemanticLogger::LEVELS.each do |level|
+        it "send #{level}" do
+          request = nil
+          @appender.http.stub(:request, -> r { request = r; response_mock.new('200', 'ok') }) do
+            @appender.send(level, @message)
+          end
+          message = JSON.parse(request.body)
+          assert_equal @message, message['message']
+          assert_equal level.to_s, message['level']
+          refute message['exception']
+        end
+
+        it "sends #{level} exceptions" do
+          exc = nil
+          begin
+            Uh oh
+          rescue Exception => e
+            exc = e
+          end
+          request = nil
+          @appender.http.stub(:request, -> r { request = r; response_mock.new('200', 'ok') }) do
+            @appender.send(level, 'Reading File', exc)
+          end
+          hash = JSON.parse(request.body)
+          assert 'Reading File', hash['message']
+          assert exception = hash['exception']
+          assert 'NameError', exception['name']
+          assert 'undefined local variable or method', exception['message']
+          assert_equal level.to_s, hash['level']
+          assert exception['stack_trace'].first.include?(__FILE__), exception
+        end
+
+        it "sends #{level} custom attributes" do
+          request = nil
+          @appender.http.stub(:request, -> r { request = r; response_mock.new('200', 'ok') }) do
+            @appender.send(level, @message, {key1: 1, key2: 'a'})
+          end
+          message = JSON.parse(request.body)
+          assert_equal @message, message['message']
+          assert_equal level.to_s, message['level']
+          refute message['stack_trace']
+          assert payload = message['payload'], message
+          assert_equal 1, payload['key1'], message
+          assert_equal 'a', payload['key2'], message
+        end
+      end
+
+    end
+  end
+end

data/test/appender/elasticsearch_test.rb

@@ -3,36 +3,40 @@ require_relative '../test_helper'
 # Unit Test for SemanticLogger::Appender::Elasticsearch
 module Appender
   class ElasticsearchTest < Minitest::Test
-    response_mock = Struct.new(:code, :body)
-
     describe SemanticLogger::Appender::Elasticsearch do
       before do
-        Net::HTTP.stub_any_instance(:start, true) do
+        skip('Concurrent::TimerTask issue is preventing the process from stopping.') if defined? JRuby
+        Elasticsearch::Transport::Client.stub_any_instance(:bulk, true) do
           @appender = SemanticLogger::Appender::Elasticsearch.new(
-            url: 'http://localhost:9200'
+            url: 'http://localhost:9200',
+            batch_size: 1 # immediate flush
           )
         end
         @message = 'AppenderElasticsearchTest log message'
       end
 
+      after do
+        @appender.close if @appender
+      end
+
       it 'logs to daily indexes' do
         index = nil
-        @appender.stub(:post, -> json, ind { index = ind }) do
+        @appender.stub(:enqueue, ->(ind, json){ index = ind['index']['_index'] } ) do
           @appender.info @message
         end
-        assert_equal "/semantic_logger-#{Time.now.utc.strftime('%Y.%m.%d')}/log", index
+        assert_equal "semantic_logger-#{Time.now.strftime('%Y.%m.%d')}", index
       end
 
       SemanticLogger::LEVELS.each do |level|
         it "send #{level}" do
           request = nil
-          @appender.http.stub(:request, -> r { request = r; response_mock.new('200', 'ok') }) do
+          @appender.client.stub(:bulk, -> r { request = r; {"status" => 201 } }) do
             @appender.send(level, @message)
           end
-          message = JSON.parse(request.body)
-          assert_equal @message, message['message']
-          assert_equal level.to_s, message['level']
-          refute message['exception']
+
+          message = request[:body][1]
+          assert_equal @message, message[:message]
+          assert_equal level, message[:level]
         end
 
         it "sends #{level} exceptions" do
@@ -43,30 +47,33 @@ module Appender
             exc = e
           end
           request = nil
-          @appender.http.stub(:request, -> r { request = r; response_mock.new('200', 'ok') }) do
+          @appender.client.stub(:bulk, -> r { request = r; {"status" => 201 } }) do
             @appender.send(level, 'Reading File', exc)
           end
-          hash = JSON.parse(request.body)
-          assert 'Reading File', hash['message']
-          assert exception = hash['exception']
-          assert 'NameError', exception['name']
-          assert 'undefined local variable or method', exception['message']
-          assert_equal level.to_s, hash['level']
-          assert exception['stack_trace'].first.include?(__FILE__), exception
+
+          hash = request[:body][1]
+
+          assert 'Reading File', hash[:message]
+          assert exception = hash[:exception]
+          assert 'NameError', exception[:name]
+          assert 'undefined local variable or method', exception[:message]
+          assert_equal level, hash[:level]
+          assert exception[:stack_trace].first.include?(__FILE__), exception
         end
 
         it "sends #{level} custom attributes" do
           request = nil
-          @appender.http.stub(:request, -> r { request = r; response_mock.new('200', 'ok') }) do
+          @appender.client.stub(:bulk, -> r { request = r; {"status" => 201 } }) do
             @appender.send(level, @message, {key1: 1, key2: 'a'})
           end
-          message = JSON.parse(request.body)
-          assert_equal @message, message['message']
-          assert_equal level.to_s, message['level']
-          refute message['stack_trace']
-          assert payload = message['payload'], message
-          assert_equal 1, payload['key1'], message
-          assert_equal 'a', payload['key2'], message
+
+          message = request[:body][1]
+          assert_equal @message, message[:message]
+          assert_equal level, message[:level]
+          refute message[:stack_trace]
+          assert payload = message[:payload], message
+          assert_equal 1, payload[:key1], message
+          assert_equal 'a', payload[:key2], message
         end
       end
 

data/test/appender/file_test.rb

@@ -10,7 +10,7 @@ module Appender
         SemanticLogger.default_level = :trace
         @time                        = Time.new
         @io                          = StringIO.new
-        @appender                    = SemanticLogger::Appender::File.new(@io)
+        @appender                    = SemanticLogger::Appender::File.new(io: @io)
         @hash                        = {session_id: 'HSSKLEU@JDK767', tracking_number: 12345}
         @hash_str                    = @hash.inspect.sub("{", "\\{").sub("}", "\\}")
         @thread_name                 = Thread.current.name
@@ -86,7 +86,7 @@ module Appender
 
       describe 'custom formatter' do
         before do
-          @appender = SemanticLogger::Appender::File.new(@io) do |log|
+          @appender = SemanticLogger::Appender::File.new(io: @io) do |log|
             tags = log.tags.collect { |tag| "[#{tag}]" }.join(' ') + ' ' if log.tags && (log.tags.size > 0)
 
             message = log.message.to_s

data/test/appender/honeybadger_test.rb

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

data/test/appender/kafka_test.rb

@@ -0,0 +1,36 @@
+require_relative '../test_helper'
+
+module Appender
+  class KafkaTest < Minitest::Test
+    describe SemanticLogger::Appender::Kafka do
+      before do
+        @appender = SemanticLogger::Appender::Kafka.new(
+          seed_brokers: ['http://localhost:9092']
+        )
+        @message  = 'AppenderKafkaTest log message'
+      end
+
+      after do
+        @appender.close if @appender
+      end
+
+      it 'sends log messages in JSON format' do
+        message = nil
+        options = nil
+        ::Kafka::Producer.stub_any_instance(:produce, -> value, **opts { message = value; options = opts }) do
+          @appender.info(@message)
+          @appender.flush
+        end
+
+        h = JSON.parse(message)
+        assert_equal 'info', h['level']
+        assert_equal @message, h['message']
+        assert_equal "SemanticLogger::Appender::Kafka", h['name']
+        assert_equal $$, h['pid']
+
+        assert_equal 'log_messages', options[:topic]
+      end
+
+    end
+  end
+end

data/test/appender/new_relic_test.rb

@@ -8,7 +8,7 @@ module Appender
     describe SemanticLogger::Appender::NewRelic do
 
       before do
-        @appender = SemanticLogger::Appender::NewRelic.new(:error)
+        @appender = SemanticLogger::Appender::NewRelic.new
         @message  = 'AppenderNewRelicTest log message'
       end
 

data/test/appender/sentry_test.rb

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

data/test/appender/syslog_test.rb

@@ -22,7 +22,7 @@ module Appender
         message = nil
         Net::TCPClient.stub_any_instance(:closed?, false) do
           Net::TCPClient.stub_any_instance(:connect, nil) do
-            syslog_appender = SemanticLogger::Appender::Syslog.new(server: 'tcp://localhost:88888', level: :debug)
+            syslog_appender = SemanticLogger::Appender::Syslog.new(url: 'tcp://localhost:88888', level: :debug)
             syslog_appender.remote_syslog.stub(:write, Proc.new { |data| message = data }) do
               syslog_appender.debug 'AppenderSyslogTest log message'
             end
@@ -33,7 +33,7 @@ module Appender
 
       it 'handle remote syslog over UDP' do
         message         = nil
-        syslog_appender = SemanticLogger::Appender::Syslog.new(server: 'udp://localhost:88888', level: :debug)
+        syslog_appender = SemanticLogger::Appender::Syslog.new(url: 'udp://localhost:88888', level: :debug)
         UDPSocket.stub_any_instance(:send, -> msg, num, host, port { message = msg }) do
           syslog_appender.debug 'AppenderSyslogTest log message'
         end

data/test/appender/wrapper_test.rb

@@ -11,7 +11,7 @@ module Appender
 
         @time              = Time.new
         @mock_logger       = MockLogger.new
-        @appender          = SemanticLogger::Appender::Wrapper.new(@mock_logger)
+        @appender          = SemanticLogger::Appender::Wrapper.new(logger: @mock_logger)
         @hash              = {session_id: 'HSSKLEU@JDK767', tracking_number: 12345}
         @hash_str          = @hash.inspect.sub("{", "\\{").sub("}", "\\}")
         @thread_name       = Thread.current.name

data/test/formatters/color_test.rb

@@ -0,0 +1,154 @@
+require_relative '../test_helper'
+
+module SemanticLogger
+  module Formatters
+    class ColorTest < Minitest::Test
+      describe Color do
+        let(:log_time) do
+          Time.utc(2017, 1, 14, 8, 32, 5.375276)
+        end
+
+        let(:level) do
+          :debug
+        end
+
+        let(:log) do
+          # :level, :thread_name, :name, :message, :payload, :time, :duration, :tags, :level_index, :exception, :metric, :backtrace, :metric_amount, :named_tags
+          log      = SemanticLogger::Log.new('ColorTest', level)
+          log.time = log_time
+          log
+        end
+
+        let(:expected_time) do
+          SemanticLogger::Formatters::Base::PRECISION == 3 ? '2017-01-14 08:32:05.375' : '2017-01-14 08:32:05.375276'
+        end
+
+        let(:set_exception) do
+          begin
+            raise 'Oh no'
+          rescue Exception => exc
+            log.exception = exc
+          end
+        end
+
+        let(:backtrace) do
+          [
+            "test/formatters/default_test.rb:35:in `block (2 levels) in <class:DefaultTest>'",
+            "gems/ruby-2.3.3/gems/minitest-5.10.1/lib/minitest/spec.rb:247:in `instance_eval'",
+            "gems/ruby-2.3.3/gems/minitest-5.10.1/lib/minitest/spec.rb:247:in `block (2 levels) in let'",
+            "gems/ruby-2.3.3/gems/minitest-5.10.1/lib/minitest/spec.rb:247:in `fetch'",
+            "ruby-2.3.3/gems/minitest-5.10.1/lib/minitest/spec.rb:247:in `block in let'",
+            "test/formatters/default_test.rb:65:in `block (3 levels) in <class:DefaultTest>'",
+            "ruby-2.3.3/gems/minitest-5.10.1/lib/minitest/test.rb:105:in `block (3 levels) in run'"
+          ]
+        end
+
+        let(:bold) do
+          SemanticLogger::AnsiColors::BOLD
+        end
+
+        let(:clear) do
+          SemanticLogger::AnsiColors::CLEAR
+        end
+
+        let(:color) do
+          SemanticLogger::AnsiColors::GREEN
+        end
+
+        let(:formatter) do
+          formatter = SemanticLogger::Formatters::Color.new
+          # Does not use the logger instance for formatting purposes
+          formatter.call(log, nil)
+          formatter
+        end
+
+        describe 'level' do
+          it 'logs single character' do
+            assert_equal "#{color}D#{clear}", formatter.level
+          end
+        end
+
+        describe 'tags' do
+          it 'logs tags' do
+            log.tags = %w(first second third)
+            assert_equal "[#{color}first#{clear}] [#{color}second#{clear}] [#{color}third#{clear}]", formatter.tags
+          end
+        end
+
+        describe 'named_tags' do
+          it 'logs named tags' do
+            log.named_tags = {first: 1, second: 2, third: 3}
+            assert_equal "{#{color}first: 1#{clear}, #{color}second: 2#{clear}, #{color}third: 3#{clear}}", formatter.named_tags
+          end
+        end
+
+        describe 'duration' do
+          it 'logs long duration' do
+            log.duration = 1_000_000.34567
+            assert_equal "(#{bold}16m 40s#{clear})", formatter.duration
+          end
+
+          it 'logs short duration' do
+            log.duration = 1.34567
+            duration = SemanticLogger::Formatters::Base::PRECISION == 3 ? "(#{bold}1ms#{clear})" : "(#{bold}1.346ms#{clear})"
+            assert_equal duration, formatter.duration
+          end
+        end
+
+        describe 'name' do
+          it 'logs name' do
+            assert_equal "#{color}ColorTest#{clear}", formatter.name
+          end
+        end
+
+        describe 'payload' do
+          it 'logs hash payload' do
+            log.payload = {first: 1, second: 2, third: 3}
+            assert_equal "-- #{log.payload.ai(multiline: false)}", formatter.payload
+          end
+
+          it 'skips nil payload' do
+            refute formatter.payload
+          end
+
+          it 'skips empty payload' do
+            log.payload = {}
+            refute formatter.payload
+          end
+        end
+
+        describe 'exception' do
+          it 'logs exception' do
+            set_exception
+            str = "-- Exception: #{color}RuntimeError: Oh no#{clear}\n"
+            assert_equal str, formatter.exception.lines.first
+          end
+
+          it 'skips nil exception' do
+            refute formatter.exception
+          end
+        end
+
+        describe 'call' do
+          it 'returns minimal elements' do
+            assert_equal "#{expected_time} #{color}D#{clear} [#{$$}:#{Thread.current.name}] #{color}ColorTest#{clear}", formatter.call(log, nil)
+          end
+
+          it 'retuns all elements' do
+            log.tags       = %w(first second third)
+            log.named_tags = {first: 1, second: 2, third: 3}
+            log.duration   = 1.34567
+            log.message    = "Hello World"
+            log.payload    = {first: 1, second: 2, third: 3}
+            log.backtrace  = backtrace
+            set_exception
+            duration = SemanticLogger::Formatters::Base::PRECISION == 3 ? '1' : '1.346'
+            str = "#{expected_time} #{color}D#{clear} [#{$$}:#{Thread.current.name} default_test.rb:35] [#{color}first#{clear}] [#{color}second#{clear}] [#{color}third#{clear}] {#{color}first: 1#{clear}, #{color}second: 2#{clear}, #{color}third: 3#{clear}} (#{bold}#{duration}ms#{clear}) #{color}ColorTest#{clear} -- Hello World -- #{{:first => 1, :second => 2, :third => 3}.ai(multiline: false)} -- Exception: #{color}RuntimeError: Oh no#{clear}\n"
+            assert_equal str, formatter.call(log, nil).lines.first
+          end
+        end
+
+      end
+    end
+  end
+end