semantic_logger 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88a1f36f6ef4d857e13b696e283f6bbd643329a0ca7f3fd9ac4c9ef1e670aaae
-  data.tar.gz: 01a175a96d750f9692bb28512d914434e442336c68eadd9f7b9f409a4d2f4a2b
+  metadata.gz: 34b3b78799e196b270d81aba7deb9b0accd1187a900967a3943dd03301c63199
+  data.tar.gz: 775b6eeca4ca6b9c38e9213e7f32fee9d179ce36148433dfa91a8630f74873b3
 SHA512:
-  metadata.gz: e06dd57a7ee95bfc5aea5d4b2948101a1fbdb00dd76ac1b9ac0b68a4a3f666670b227d559451d4137e510d1c63b9ec9bd8f99326bfe765f9a610294221c2259f
-  data.tar.gz: 0e2b66a5da5f5e2d21c185555f3502e7982d8d197ec9bade63092acae1750dcf1d8191de71dc8fbe0598d844b2c5f85931c407030a599260f41ad35470802a14
+  metadata.gz: 7cda8a50c62a2dcdb079d5f96cbde61e5cc941c443122a3bbc102a1513bc3686d44a20cca28e7627444bf640a6329035aefc43cb6111a3e6b9cb91411fe33782
+  data.tar.gz: caf355bf16e08b133fe07ddd6b4cab813b6e7224b3e1f152e1ab54cf30f574fc8665f99ae3938078fb35fcfeea3643d565a814cbe2774d263135c93722147b06

data/README.md

@@ -11,6 +11,16 @@ Semantic Logger is a feature rich logging framework, and replacement for existin
 
 [Reference Documentation](http://www.rubydoc.info/gems/semantic_logger/)
 
+## Upgrading to Semantic Logger v4.4
+
+With some forking frameworks it is necessary to call `reopen` after the fork. With v4.4 the
+workaround for Ruby 2.5 crashes is no longer needed. 
+I.e. Please remove the following line if being called anywhere:
+
+~~~ruby
+SemanticLogger::Processor.instance.instance_variable_set(:@queue, Queue.new)
+~~~
+
 ## Logging Destinations
 
 Logging to the following destinations are all supported "out-of-the-box":
@@ -70,7 +80,7 @@ The following changes need to be made when upgrading to V4:
 - Replace calls to Logger#with_payload with SemanticLogger.named_tagged.
 - Replace calls to Logger#payload with SemanticLogger.named_tags.
 - MongoDB Appender requires Mongo Ruby Client V2 or greater.
-- Appenders now write payload data in a seperate :payload tag instead of mixing them.
+- Appenders now write payload data in a seperate :payload tag instead of mixing them
   directly into the root elements to avoid name clashes.
 
 As a result any calls like the following:

data/lib/semantic_logger/appender/elasticsearch.rb

@@ -17,7 +17,7 @@ require 'date'
 module SemanticLogger
   module Appender
     class Elasticsearch < SemanticLogger::Subscriber
-      attr_accessor :url, :index, :type, :client, :flush_interval, :timeout_interval, :batch_size, :elasticsearch_args
+      attr_accessor :url, :index, :date_pattern, :type, :client, :flush_interval, :timeout_interval, :batch_size, :elasticsearch_args
 
       # Create Elasticsearch appender over persistent HTTP(S)
       #
@@ -28,6 +28,11 @@ module SemanticLogger
       #       I.e. The final index will look like 'semantic_logger-YYYY.MM.DD'
       #     Default: 'semantic_logger'
       #
+      #   date_pattern: [String]
+      #     The time format used to generate the full index name. Useful
+      #       if you want monthly indexes ('%Y.%m') or weekly ('%Y.%W').
+      #     Default: '%Y.%m.%d'
+      #
       #   type: [String]
       #     Document type to associate with logs when they are written.
       #     Default: 'log'
@@ -120,6 +125,7 @@ module SemanticLogger
       #     Default: 'GET'
       def initialize(url: 'http://localhost:9200',
                      index: 'semantic_logger',
+                     date_pattern: '%Y.%m.%d',
                      type: 'log',
                      level: nil,
                      formatter: nil,
@@ -132,6 +138,7 @@ module SemanticLogger
 
         @url                         = url
         @index                       = index
+        @date_pattern                = date_pattern
         @type                        = type
         @elasticsearch_args          = elasticsearch_args.dup
         @elasticsearch_args[:url]    = url if url && !elasticsearch_args[:hosts]
@@ -173,8 +180,8 @@ module SemanticLogger
       end
 
       def bulk_index(log)
-        daily_index = log.time.strftime("#{index}-%Y.%m.%d")
-        {'index' => {'_index' => daily_index, '_type' => type}}
+        expanded_index_name = log.time.strftime("#{index}-#{date_pattern}")
+        {'index' => {'_index' => expanded_index_name, '_type' => type}}
       end
 
       def default_formatter

data/lib/semantic_logger/appender/syslog.rb

@@ -170,10 +170,10 @@ module SemanticLogger
           method = ::Syslog.opened? ? :reopen : :open
           ::Syslog.send(method, application, options, facility)
         when :tcp
-          # Use the local logger for @remote_syslog so errors with the remote logger can be recorded locally.
-          @tcp_client_options[:logger] = logger
           @tcp_client_options[:server] = "#{@server}:#{@port}"
           @remote_syslog               = Net::TCPClient.new(@tcp_client_options)
+          # Use the local logger for @remote_syslog so errors with the remote logger can be recorded locally.
+          @remote_syslog.logger = logger
         when :udp
           @remote_syslog = UDPSocket.new
         else

data/lib/semantic_logger/appenders.rb

@@ -43,7 +43,7 @@ module SemanticLogger
           logger.trace "Closing appender: #{appender.name}"
           appender.flush
           appender.close
-          appenders.delete(appender)
+          delete(appender)
         rescue Exception => exc
           logger.error "Failed to close appender: #{appender.inspect}", exc
         end

data/lib/semantic_logger/base.rb

@@ -341,7 +341,7 @@ module SemanticLogger
         params  = message
         message = nil
       end
-      start = Time.now
+      start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       begin
         if block_given?
           result =
@@ -362,7 +362,7 @@ module SemanticLogger
         message   = params[:message] if params[:message]
         duration  =
           if block_given?
-            1000.0 * (Time.now - start)
+            1_000.0 * (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start)
           else
             params[:duration] || raise('Mandatory block missing when :duration option is not supplied')
           end
@@ -401,7 +401,7 @@ module SemanticLogger
 
       # Ignores filter, silence, payload
       exception = nil
-      start     = Time.now
+      start     = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       begin
         yield
       rescue Exception => exc
@@ -414,7 +414,7 @@ module SemanticLogger
           min_duration:       min_duration,
           exception:          exception,
           metric:             metric,
-          duration:           1000.0 * (Time.now - start),
+          duration:           1_000.0 * (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start),
           log_exception:      log_exception,
           on_exception_level: on_exception_level
         )

data/lib/semantic_logger/formatters/color.rb

@@ -44,8 +44,20 @@ module SemanticLogger
       #   SemanticLogger.add_appender(io: $stdout, formatter: :color)
       #
       # Example:
-      #   # Use a colorized output logger chenging the color for info to green.
-      #   SemanticLogger.add_appender(io: $stdout, formatter: :color, color_map: {info: SemanticLogger::AnsiColors::YELLOW})
+      #   # Use a colorized output logger changing the color for info to yellow.
+      #   SemanticLogger.add_appender(io: $stdout, formatter: {color: {color_map: {info: SemanticLogger::AnsiColors::YELLOW}}})
+      #
+      # Example:
+      #   # Override the Awesome Print options to output hashes over multiple lines:
+      #   SemanticLogger.add_appender(io: $stdout, formatter: {color: {ap: {multiline: true}}})
+      #
+      #   # Calling the appender added above:
+      #   SemanticLogger['Test'].info('hi', {a: 1, b: 2})
+      #   => true
+      #   => 2019-02-12 11:47:50.794339 I [35832:70112015269920] Test -- hi -- {
+      #        :a => 1,
+      #        :b => 2
+      #      }
       #
       # Parameters:
       #  ap: [Hash]

data/lib/semantic_logger/reporters/minitest.rb

@@ -4,26 +4,22 @@ module SemanticLogger
     # On completion the time it took to run the test is also logged.
     #
     # For example, add the following lines to `test_helper.rb`:
+    #   require 'minitest/reporters'
+    #
     #   reporters = [
     #     Minitest::Reporters::ProgressReporter.new,
     #     SemanticLogger::Reporters::Minitest.new
     #   ]
     #   Minitest::Reporters.use!(reporters)
     #
-    # Log entries similar to the following should show up in the log file:
+    # And add `gem minitest-reporters` to the Gemfile.
     #
-    # 2019-01-30 14:41:21.590383 I [9989:70268303433760] (9.958ms) Minitest -- Passed: test_0002_infinite timeout
-    # 2019-01-30 14:41:21.590951 I [9989:70268303433760] Minitest -- Started: test_0002_must return the servers in the supplied order
-    # 2019-01-30 14:41:21.592012 I [9989:70268303433760] (1.019ms) Minitest -- Passed: test_0002_must return the servers in the supplied order
-    # 2019-01-30 14:41:21.592054 I [9989:70268303433760] Minitest -- Started: test_0003_must handle an empty list of servers
-    # 2019-01-30 14:41:21.592094 I [9989:70268303433760] (0.014ms) Minitest -- Passed: test_0003_must handle an empty list of servers
-    # 2019-01-30 14:41:21.592118 I [9989:70268303433760] Minitest -- Started: test_0001_must return one server, once
-    # 2019-01-30 14:41:21.592510 I [9989:70268303433760] (0.361ms) Minitest -- Passed: test_0001_must return one server, once
+    # Log entries similar to the following should show up in the log file:
     #
-    # Note:
-    # - To use `Minitest::Reporters::ProgressReporter` the gem `minitest-reporters` is required, as well as the
-    #   following line in `test_helper.rb`:
-    #     `require 'minitest/reporters'`
+    # 2019-02-06 18:58:17.522467 I [84730:70256441962000] Minitest -- START RocketJob::DirmonEntry::with valid entry::#archive_file test_0001_moves file to archive dir
+    # 2019-02-06 18:58:17.527492 I [84730:70256441962000] (4.980ms) Minitest -- PASS RocketJob::DirmonEntry::with valid entry::#archive_file test_0001_moves file to archive dir
+    # 2019-02-06 18:58:17.527835 I [84730:70256441962000] Minitest -- START RocketJob::DirmonEntry::#job_class::with a valid job_class_name test_0001_return job class
+    # 2019-02-06 18:58:17.529761 I [84730:70256441962000] (1.882ms) Minitest -- PASS RocketJob::DirmonEntry::#job_class::with a valid job_class_name test_0001_return job class
     class Minitest < ::Minitest::AbstractReporter
       include SemanticLogger::Loggable
 
@@ -32,16 +28,16 @@ module SemanticLogger
       attr_accessor :io
 
       def before_test(test)
-        logger.info('START', name: test.name)
+        logger.info("START #{test.class_name} #{test.name}")
       end
 
       def after_test(test)
         if test.error?
-          logger.benchmark_error('FAIL', payload: {name: test.name}, duration: test.time * 1_000, metric: 'minitest/fail')
+          logger.benchmark_error("FAIL #{test.class_name} #{test.name}", duration: test.time * 1_000, metric: 'minitest/fail')
         elsif test.skipped?
-          logger.benchmark_warn('SKIP', payload: {name: test.name}, duration: test.time * 1_000, metric: 'minitest/skip')
+          logger.benchmark_warn("SKIP #{test.class_name} #{test.name}", duration: test.time * 1_000, metric: 'minitest/skip')
         else
-          logger.benchmark_info('PASS', payload: {name: test.name}, duration: test.time * 1_000, metric: 'minitest/pass')
+          logger.benchmark_info("PASS #{test.class_name} #{test.name}", duration: test.time * 1_000, metric: 'minitest/pass')
         end
       end
     end

data/lib/semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module SemanticLogger
-  VERSION = '4.4.0'.freeze
+  VERSION = '4.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semantic_logger
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.5.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-03 00:00:00.000000000 Z
+date: 2019-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby