semantic_logger 4.0.0 → 4.1.0

data/test/formatters/default_test.rb

@@ -0,0 +1,176 @@
+require_relative '../test_helper'
+
+module SemanticLogger
+  module Formatters
+    class DefaultTest < Minitest::Test
+      describe Default 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('DefaultTest', 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:99: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(:formatter) do
+          formatter = SemanticLogger::Formatters::Default.new
+          # Does not use the logger instance for formatting purposes
+          formatter.call(log, nil)
+          formatter
+        end
+
+        describe 'time' do
+          it 'logs time' do
+            assert_equal expected_time, formatter.time
+          end
+
+          it 'supports time_format' do
+            formatter = SemanticLogger::Formatters::Default.new(time_format: "%H:%M:%S")
+            formatter.call(log, nil)
+            assert_equal '08:32:05', formatter.time
+          end
+        end
+
+        describe 'level' do
+          it 'logs single character' do
+            assert_equal 'D', formatter.level
+          end
+        end
+
+        describe 'process_info' do
+          it 'logs pid and thread name' do
+            assert_equal "[#{$$}:#{Thread.current.name}]", formatter.process_info
+          end
+
+          it 'logs pid, thread name, and file name' do
+            set_exception
+            log.backtrace = backtrace
+            assert_equal "[#{$$}:#{Thread.current.name} default_test.rb:99]", formatter.process_info
+          end
+        end
+
+        describe 'tags' do
+          it 'logs tags' do
+            log.tags = %w(first second third)
+            assert_equal "[first] [second] [third]", formatter.tags
+          end
+        end
+
+        describe 'named_tags' do
+          it 'logs named tags' do
+            log.named_tags = {first: 1, second: 2, third: 3}
+            assert_equal "{first: 1, second: 2, third: 3}", formatter.named_tags
+          end
+        end
+
+        describe 'duration' do
+          it 'logs long duration' do
+            log.duration = 1_000_000.34567
+            assert_equal "(16m 40s)", formatter.duration
+          end
+
+          it 'logs short duration' do
+            log.duration = 1.34567
+            duration = SemanticLogger::Formatters::Base::PRECISION == 3 ? "(1ms)" : "(1.346ms)"
+            assert_equal duration, formatter.duration
+          end
+        end
+
+        describe 'name' do
+          it 'logs name' do
+            assert_equal "DefaultTest", formatter.name
+          end
+        end
+
+        describe 'message' do
+          it 'logs message' do
+            log.message = "Hello World"
+            assert_equal "-- Hello World", formatter.message
+          end
+
+          it 'skips empty message' do
+            refute formatter.message
+          end
+        end
+
+        describe 'payload' do
+          it 'logs hash payload' do
+            log.payload = {first: 1, second: 2, third: 3}
+            assert_equal "-- {:first=>1, :second=>2, :third=>3}", 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
+            assert_match /-- Exception: RuntimeError: Oh no/, formatter.exception
+          end
+
+          it 'skips nil exception' do
+            refute formatter.exception
+          end
+        end
+
+        describe 'call' do
+          it 'returns minimal elements' do
+            assert_equal "#{expected_time} D [#{$$}:#{Thread.current.name}] DefaultTest", 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} D [#{$$}:#{Thread.current.name} default_test.rb:99] [first] [second] [third] {first: 1, second: 2, third: 3} (#{duration}ms) DefaultTest -- Hello World -- {:first=>1, :second=>2, :third=>3} -- Exception: RuntimeError: Oh no\n"
+            assert_equal str, formatter.call(log, nil).lines.first
+          end
+        end
+
+      end
+    end
+  end
+end

data/test/loggable_test.rb

@@ -76,7 +76,7 @@ class AppenderFileTest < Minitest::Test
       before do
         @time                        = Time.new
         @io                          = StringIO.new
-        @appender                    = SemanticLogger::Appender::File.new(@io)
+        @appender                    = SemanticLogger::Appender::File.new(io: @io)
         SemanticLogger.default_level = :trace
         @mock_logger                 = MockLogger.new
         @appender                    = SemanticLogger.add_appender(logger: @mock_logger)

data/test/logger_test.rb

@@ -109,11 +109,11 @@ class LoggerTest < Minitest::Test
           end
 
           it 'logs duration' do
-            @logger.send(level, duration: 123.45, message: 'Hello world', payload: {tracking_number: '123456', even: 2, more: 'data'})
+            @logger.send(level, duration: 123.44, message: 'Hello world', payload: {tracking_number: '123456', even: 2, more: 'data'})
             hash = {tracking_number: '123456', even: 2, more: 'data'}
             SemanticLogger.flush
             hash_str       = hash.inspect.sub('{', '\{').sub('}', '\}')
-            duration_match = defined?(JRuby) ? '\(123ms\)' : '\(123\.5ms\)'
+            duration_match = SemanticLogger::Formatters::Base::PRECISION == 3 ? '\(123ms\)' : '\(123\.4ms\)'
             assert_match(/\d+-\d+-\d+ \d+:\d+:\d+.\d+ #{level_char} \[\d+:#{@thread_name}\] #{duration_match} LoggerTest -- Hello world -- #{hash_str}/, @mock_logger.message)
           end
 
@@ -131,11 +131,11 @@ class LoggerTest < Minitest::Test
             end
 
             metric_name = '/my/custom/metric'
-            @logger.send(level, metric: metric_name, duration: 123.45, message: 'Hello world', payload: {tracking_number: '123456', even: 2, more: 'data'})
+            @logger.send(level, metric: metric_name, duration: 123.44, message: 'Hello world', payload: {tracking_number: '123456', even: 2, more: 'data'})
             hash = {tracking_number: '123456', even: 2, more: 'data'}
             SemanticLogger.flush
             hash_str       = hash.inspect.sub('{', '\{').sub('}', '\}')
-            duration_match = defined?(JRuby) ? '\(123ms\)' : '\(123\.5ms\)'
+            duration_match = SemanticLogger::Formatters::Base::PRECISION == 3 ? '\(123ms\)' : '\(123\.4ms\)'
             assert_match(/\d+-\d+-\d+ \d+:\d+:\d+.\d+ #{level_char} \[\d+:#{@thread_name}\] #{duration_match} LoggerTest -- Hello world -- #{hash_str}/, @mock_logger.message)
             assert metric_name, $last_metric.metric
           end
@@ -213,5 +213,48 @@ class LoggerTest < Minitest::Test
       end
     end
 
+    describe '.tagged' do
+      it 'add tags to log entries' do
+        @logger.tagged('12345', 'DJHSFK') do
+          @logger.info('Hello world')
+          SemanticLogger.flush
+          assert_match(/\d+-\d+-\d+ \d+:\d+:\d+.\d+ I \[\d+:#{@thread_name}\] \[12345\] \[DJHSFK\] LoggerTest -- Hello world/, @mock_logger.message)
+        end
+      end
+
+      it 'add embedded tags to log entries' do
+        @logger.tagged('First Level', 'tags') do
+          @logger.tagged('Second Level') do
+            @logger.info('Hello world')
+            SemanticLogger.flush
+            assert_match(/\d+-\d+-\d+ \d+:\d+:\d+.\d+ I \[\d+:#{@thread_name}\] \[First Level\] \[tags\] \[Second Level\] LoggerTest -- Hello world/, @mock_logger.message)
+          end
+          assert_equal 2, @logger.tags.count, @logger.tags
+          assert_equal 'First Level', @logger.tags.first
+          assert_equal 'tags', @logger.tags.last
+        end
+      end
+
+      it 'also supports named tagging' do
+        @logger.tagged(level1: 1) do
+          assert_equal({level1: 1}, SemanticLogger.named_tags)
+          @logger.tagged(level2: 2, more: 'data') do
+            assert_equal({level1: 1, level2: 2, more: 'data'}, SemanticLogger.named_tags)
+            @logger.tagged(level3: 3) do
+              assert_equal({level1: 1, level2: 2, more: 'data', level3: 3}, SemanticLogger.named_tags)
+            end
+          end
+        end
+      end
+
+      it 'is compatible with rails logging that uses arrays and nils' do
+        @logger.tagged('', ['12345', 'DJHSFK'], nil) do
+          @logger.info('Hello world')
+          SemanticLogger.flush
+          assert_match(/\d+-\d+-\d+ \d+:\d+:\d+.\d+ I \[\d+:#{@thread_name}\] \[12345\] \[DJHSFK\] LoggerTest -- Hello world/, @mock_logger.message)
+        end
+      end
+    end
+
   end
 end

data/test/measure_test.rb

@@ -44,7 +44,7 @@ class MeasureTest < Minitest::Test
 
         describe ':min_duration' do
           it 'not log when faster' do
-            assert_equal 'result', @logger.send(measure_level, 'hello world', min_duration: 1000) { 'result' } # Measure duration of the supplied block
+            assert_equal 'result', @logger.send(measure_level, 'hello world', min_duration: 2000) { 'result' } # Measure duration of the supplied block
             SemanticLogger.flush
             assert_nil @mock_logger.message
           end
@@ -156,7 +156,7 @@ class MeasureTest < Minitest::Test
 
         describe ':min_duration' do
           it 'not log when faster' do
-            assert_equal 'result', @logger.send(measure_level, message: 'hello world', min_duration: 1000) { 'result' } # Measure duration of the supplied block
+            assert_equal 'result', @logger.send(measure_level, message: 'hello world', min_duration: 2000) { 'result' } # Measure duration of the supplied block
             SemanticLogger.flush
             assert_nil @mock_logger.message
           end

data/test/semantic_logger_test.rb

@@ -156,15 +156,43 @@ class SemanticLoggerTest < Minitest::Test
             assert_equal 'tags', SemanticLogger.tags.last
           end
         end
+
+        it 'also supports named tagging' do
+          SemanticLogger.tagged(level1: 1) do
+            assert_equal({level1: 1}, SemanticLogger.named_tags)
+            SemanticLogger.tagged(level2: 2, more: 'data') do
+              assert_equal({level1: 1, level2: 2, more: 'data'}, SemanticLogger.named_tags)
+              SemanticLogger.tagged(level3: 3) do
+                assert_equal({level1: 1, level2: 2, more: 'data', level3: 3}, SemanticLogger.named_tags)
+              end
+            end
+          end
+        end
+      end
+
+      describe '.named_tags' do
+        it 'returns named tags in creation order' do
+          SemanticLogger.named_tagged(level1: 1) do
+            assert_equal({level1: 1}, SemanticLogger.named_tags)
+            SemanticLogger.named_tagged(level2: 2, more: 'data') do
+              assert_equal({level1: 1, level2: 2, more: 'data'}, SemanticLogger.named_tags)
+              SemanticLogger.named_tagged(level3: 3) do
+                assert_equal({level1: 1, level2: 2, more: 'data', level3: 3}, SemanticLogger.named_tags)
+              end
+            end
+          end
+        end
       end
 
       describe '.named_tagged' do
-        it 'logs named tags' do
-          SemanticLogger.named_tagged(tracking_number: '123456') do
-            SemanticLogger.named_tagged(even: 2, more: 'data') do
-              @logger.info('Hello world')
-              SemanticLogger.flush
-              assert_match(/\d+-\d+-\d+ \d+:\d+:\d+.\d+ I \[\d+:#{@thread_name}\] \[even: 2\] \[more: data\] \[tracking_number: 123456\] LoggerTest -- Hello world/, @mock_logger.message)
+        it 'logs named tags in creation order' do
+          SemanticLogger.named_tagged(level1: 1) do
+            SemanticLogger.named_tagged(level2: 2, more: 'data') do
+              SemanticLogger.named_tagged(level3: 3) do
+                @logger.info('Hello world')
+                SemanticLogger.flush
+                assert_match(/\d+-\d+-\d+ \d+:\d+:\d+.\d+ I \[\d+:#{@thread_name}\] \{level1: 1, level2: 2, more: data, level3: 3\} LoggerTest -- Hello world/, @mock_logger.message)
+              end
             end
           end
         end

data/test/test_helper.rb

@@ -13,3 +13,11 @@ require_relative 'mock_logger'
 require 'awesome_print'
 
 #Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+Signal.trap('TTIN') do
+  Thread.list.each do |thread|
+    puts
+    puts
+    ap thread.name
+    ap thread.backtrace
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semantic_logger
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-02 00:00:00.000000000 Z
+date: 2017-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -40,10 +40,12 @@ files:
 - lib/semantic_logger/appender.rb
 - lib/semantic_logger/appender/bugsnag.rb
 - lib/semantic_logger/appender/elasticsearch.rb
+- lib/semantic_logger/appender/elasticsearch_http.rb
 - lib/semantic_logger/appender/file.rb
 - lib/semantic_logger/appender/graylog.rb
 - lib/semantic_logger/appender/honeybadger.rb
 - lib/semantic_logger/appender/http.rb
+- lib/semantic_logger/appender/kafka.rb
 - lib/semantic_logger/appender/mongodb.rb
 - lib/semantic_logger/appender/new_relic.rb
 - lib/semantic_logger/appender/sentry.rb
@@ -63,6 +65,7 @@ files:
 - lib/semantic_logger/formatters/json.rb
 - lib/semantic_logger/formatters/raw.rb
 - lib/semantic_logger/formatters/syslog.rb
+- lib/semantic_logger/formatters/syslog_cee.rb
 - lib/semantic_logger/jruby/garbage_collection_logger.rb
 - lib/semantic_logger/log.rb
 - lib/semantic_logger/loggable.rb
@@ -75,11 +78,13 @@ files:
 - lib/semantic_logger/subscriber.rb
 - lib/semantic_logger/version.rb
 - test/appender/bugsnag_test.rb
+- test/appender/elasticsearch_http_test.rb
 - test/appender/elasticsearch_test.rb
 - test/appender/file_test.rb
 - test/appender/graylog_test.rb
 - test/appender/honeybadger_test.rb
 - test/appender/http_test.rb
+- test/appender/kafka_test.rb
 - test/appender/mongodb_test.rb
 - test/appender/new_relic_test.rb
 - test/appender/newrelic_rpm.rb
@@ -92,6 +97,8 @@ files:
 - test/appender/wrapper_test.rb
 - test/concerns/compatibility_test.rb
 - test/debug_as_trace_logger_test.rb
+- test/formatters/color_test.rb
+- test/formatters/default_test.rb
 - test/loggable_test.rb
 - test/logger_test.rb
 - test/measure_test.rb
@@ -118,17 +125,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Scalable, next generation enterprise logging for Ruby
 test_files:
 - test/appender/bugsnag_test.rb
+- test/appender/elasticsearch_http_test.rb
 - test/appender/elasticsearch_test.rb
 - test/appender/file_test.rb
 - test/appender/graylog_test.rb
 - test/appender/honeybadger_test.rb
 - test/appender/http_test.rb
+- test/appender/kafka_test.rb
 - test/appender/mongodb_test.rb
 - test/appender/new_relic_test.rb
 - test/appender/newrelic_rpm.rb
@@ -141,6 +150,8 @@ test_files:
 - test/appender/wrapper_test.rb
 - test/concerns/compatibility_test.rb
 - test/debug_as_trace_logger_test.rb
+- test/formatters/color_test.rb
+- test/formatters/default_test.rb
 - test/loggable_test.rb
 - test/logger_test.rb
 - test/measure_test.rb