semantic_logger 4.6.1 → 4.7.0

data/lib/semantic_logger/logger.rb

@@ -1,4 +1,4 @@
-require 'concurrent'
+require "concurrent"
 module SemanticLogger
   # Logger stores the class name to be used for all log messages so that every
   # log message written by this instance will include the class name
@@ -9,7 +9,7 @@ module SemanticLogger
       subscriber = block || object
 
       unless subscriber.is_a?(Proc) || subscriber.respond_to?(:call)
-        raise('When supplying an on_log subscriber, it must support the #call method')
+        raise("When supplying an on_log subscriber, it must support the #call method")
       end
 
       subscribers = (@subscribers ||= Concurrent::Array.new)
@@ -21,7 +21,7 @@ module SemanticLogger
     end
 
     def self.processor
-      @processor
+      @processor ||= SemanticLogger.sync? ? SyncProcessor.new : Processor.new
     end
 
     # Returns a Logger instance
@@ -65,7 +65,7 @@ module SemanticLogger
 
     private
 
-    @processor   = Processor.new
+    @processor   = nil
     @subscribers = nil
 
     def self.call_subscribers(log)
@@ -74,8 +74,8 @@ module SemanticLogger
       @subscribers.each do |subscriber|
         begin
           subscriber.call(log)
-        rescue Exception => exc
-          self.class.processor.logger.error('Exception calling :on_log subscriber', exc)
+        rescue Exception => e
+          self.class.processor.logger.error("Exception calling :on_log subscriber", e)
         end
       end
     end

data/lib/semantic_logger/metric/new_relic.rb

@@ -1,7 +1,7 @@
 begin
-  require 'newrelic_rpm'
+  require "newrelic_rpm"
 rescue LoadError
-  raise LoadError.new('Gem newrelic_rpm is required for logging to New Relic. Please add the gem "newrelic_rpm" to your Gemfile.')
+  raise LoadError, 'Gem newrelic_rpm is required for logging to New Relic. Please add the gem "newrelic_rpm" to your Gemfile.'
 end
 
 # Send Metrics to NewRelic
@@ -37,7 +37,7 @@ module SemanticLogger
       #     regular expression. All other messages will be ignored.
       #     Proc: Only include log messages where the supplied Proc returns true
       #           The Proc must return true or false.
-      def initialize(prefix: 'Custom', **args, &block)
+      def initialize(prefix: "Custom", **args, &block)
         @prefix = prefix
         super(**args, &block)
       end

data/lib/semantic_logger/metric/signalfx.rb

@@ -10,7 +10,7 @@ module SemanticLogger
     class Signalfx < SemanticLogger::Appender::Http
       attr_reader :full_url
 
-      END_POINT = 'v2/datapoint'.freeze
+      END_POINT = "v2/datapoint".freeze
 
       # Create SignalFx metrics appender.
       #
@@ -75,7 +75,7 @@ module SemanticLogger
       #   end
       def initialize(token:,
                      dimensions: nil,
-                     url: 'https://ingest.signalfx.com',
+                     url: "https://ingest.signalfx.com",
                      formatter: nil,
                      **args,
                      &block)
@@ -84,7 +84,7 @@ module SemanticLogger
 
         super(url: url, formatter: formatter, **args, &block)
 
-        @header['X-SF-TOKEN'] = token
+        @header["X-SF-TOKEN"] = token
         @full_url             = "#{url}/#{END_POINT}"
       end
 

data/lib/semantic_logger/metric/statsd.rb

@@ -1,8 +1,8 @@
-require 'uri'
+require "uri"
 begin
-  require 'statsd-ruby'
+  require "statsd-ruby"
 rescue LoadError
-  raise LoadError.new('Gem statsd-ruby is required for logging metrics. Please add the gem "statsd-ruby" to your Gemfile.')
+  raise LoadError, 'Gem statsd-ruby is required for logging metrics. Please add the gem "statsd-ruby" to your Gemfile.'
 end
 
 module SemanticLogger
@@ -26,17 +26,17 @@ module SemanticLogger
       #     metric: :statsd,
       #     url:    'localhost:8125'
       #   )
-      def initialize(url: 'udp://localhost:8125')
+      def initialize(url: "udp://localhost:8125")
         @url = url
       end
 
       def reopen
         uri = URI.parse(@url)
-        raise('Statsd only supports udp. Example: "udp://localhost:8125"') if uri.scheme != 'udp'
+        raise('Statsd only supports udp. Example: "udp://localhost:8125"') if uri.scheme != "udp"
 
         @statsd           = ::Statsd.new(uri.host, uri.port)
-        path              = uri.path.chomp('/')
-        @statsd.namespace = path.sub('/', '') if path != ''
+        path              = uri.path.chomp("/")
+        @statsd.namespace = path.sub("/", "") if path != ""
       end
 
       def log(log)

data/lib/semantic_logger/processor.rb

@@ -13,11 +13,12 @@ module SemanticLogger
     #   For example when an appender is not working etc..
     #   By default logs to STDERR
     def self.logger
-      @logger ||= begin
-        l      = SemanticLogger::Appender::File.new(io: STDERR, level: :warn)
-        l.name = name
-        l
-      end
+      @logger ||=
+        begin
+          l      = SemanticLogger::Appender::File.new(io: STDERR, level: :warn)
+          l.name = name
+          l
+        end
     end
 
     attr_reader :appenders
@@ -30,6 +31,7 @@ module SemanticLogger
     # Start the appender thread
     def start
       return false if active?
+
       thread
       true
     end

data/lib/semantic_logger/reporters/minitest.rb

@@ -23,7 +23,7 @@ module SemanticLogger
     class Minitest < ::Minitest::AbstractReporter
       include SemanticLogger::Loggable
 
-      logger.name = 'Minitest'
+      logger.name = "Minitest"
 
       attr_accessor :io
 
@@ -33,11 +33,11 @@ module SemanticLogger
 
       def after_test(test)
         if test.error?
-          logger.benchmark_error("FAIL #{test.class_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 #{test.class_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 #{test.class_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/semantic_logger.rb

@@ -1,5 +1,5 @@
-require 'concurrent'
-require 'socket'
+require "concurrent"
+require "socket"
 
 module SemanticLogger
   # Logging levels in order of most detailed to most severe
@@ -52,7 +52,7 @@ module SemanticLogger
   # Returns [String] name of this host for logging purposes
   # Note: Not all appenders use `host`
   def self.host
-    @host ||= Socket.gethostname.force_encoding('UTF-8')
+    @host ||= Socket.gethostname.force_encoding("UTF-8")
   end
 
   # Override the default host name
@@ -82,8 +82,8 @@ module SemanticLogger
     @environment = environment
   end
 
-  @application = ENV['SEMANTIC_LOGGER_APP'] || 'Semantic Logger'
-  @environment = ENV['SEMANTIC_LOGGER_ENV'] || ENV['RAILS_ENV'] || ENV['RACK_ENV']
+  @application = ENV["SEMANTIC_LOGGER_APP"] || "Semantic Logger"
+  @environment = ENV["SEMANTIC_LOGGER_ENV"] || ENV["RAILS_ENV"] || ENV["RACK_ENV"]
 
   # Add a new logging appender as a new destination for all log messages
   # emitted from Semantic Logger
@@ -268,22 +268,23 @@ module SemanticLogger
   # Note:
   #   To only register one of the signal handlers, set the other to nil
   #   Set gc_log_microseconds to nil to not enable JRuby Garbage collections
-  def self.add_signal_handler(log_level_signal = 'USR2', thread_dump_signal = 'TTIN', gc_log_microseconds = 100_000)
+  def self.add_signal_handler(log_level_signal = "USR2", thread_dump_signal = "TTIN", gc_log_microseconds = 100_000)
     if log_level_signal
       Signal.trap(log_level_signal) do
         index     = default_level == :trace ? LEVELS.find_index(:error) : LEVELS.find_index(default_level)
         new_level = LEVELS[index - 1]
-        self['SemanticLogger'].warn "Changed global default log level to #{new_level.inspect}"
+        self["SemanticLogger"].warn "Changed global default log level to #{new_level.inspect}"
         self.default_level = new_level
       end
     end
 
     if thread_dump_signal
       Signal.trap(thread_dump_signal) do
-        logger = SemanticLogger['Thread Dump']
+        logger = SemanticLogger["Thread Dump"]
         Thread.list.each do |thread|
           # MRI re-uses the main thread for signals, JRuby uses `SIGTTIN handler` thread.
           next if defined?(JRuby) && (thread == Thread.current)
+
           logger.backtrace(thread: thread)
         end
       end
@@ -302,7 +303,7 @@ module SemanticLogger
   # If the tag being supplied is definitely a string then this fast
   # tag api can be used for short lived tags
   def self.fast_tag(tag)
-    return yield if tag.nil? || tag == ''
+    return yield if tag.nil? || tag == ""
 
     t = Thread.current[:semantic_logger_tags] ||= []
     begin
@@ -379,7 +380,7 @@ module SemanticLogger
   # :nodoc
   def self.named_tagged(hash)
     return yield if hash.nil? || hash.empty?
-    raise(ArgumentError, '#named_tagged only accepts named parameters (Hash)') unless hash.is_a?(Hash)
+    raise(ArgumentError, "#named_tagged only accepts named parameters (Hash)") unless hash.is_a?(Hash)
 
     begin
       push_named_tags(hash)
@@ -488,6 +489,19 @@ module SemanticLogger
     Thread.current[:semantic_logger_silence] || @default_level_index
   end
 
+  # Run Semantic Logger in Synchronous mode.
+  #
+  # I.e. Instead of logging messages in a separate thread for better performance,
+  # log them using the current thread.
+  def self.sync!
+    @sync = true
+  end
+
+  # Running in synchronous mode?
+  def self.sync?
+    @sync
+  end
+
   private
 
   # Initial default Level for all new instances of SemanticLogger::Logger
@@ -495,4 +509,5 @@ module SemanticLogger
   @default_level_index   = Levels.index(@default_level)
   @backtrace_level       = :error
   @backtrace_level_index = Levels.index(@backtrace_level)
+  @synchronous           = false
 end

data/lib/semantic_logger/subscriber.rb

@@ -45,11 +45,12 @@ module SemanticLogger
     # Give each appender its own logger for logging.
     # For example trace messages sent to services or errors when something fails.
     def logger
-      @logger ||= begin
-        logger      = SemanticLogger::Processor.logger.clone
-        logger.name = self.class.name
-        logger
-      end
+      @logger ||=
+        begin
+          logger      = SemanticLogger::Processor.logger.clone
+          logger.name = self.class.name
+          logger
+        end
     end
 
     # Set the formatter from Symbol|Hash|Block

data/lib/semantic_logger/sync.rb

@@ -0,0 +1,12 @@
+# Run Semantic Logger in Synchronous mode.
+#
+# I.e. Instead of logging messages in a separate thread for better performance,
+# log them using the current thread.
+#
+# Usage:
+#   require "semantic_logger/sync"
+#
+# Or, when using a Gemfile:
+#   gem "semantic_logger", require: "semantic_logger/sync"
+require "semantic_logger"
+SemanticLogger.sync!

data/lib/semantic_logger/sync_processor.rb

@@ -0,0 +1,44 @@
+module SemanticLogger
+  # Thread that submits and processes log requests
+  class SyncProcessor
+    extend Forwardable
+
+    # Forward methods that can be called directly
+    def_delegator :@appenders, :add
+    def_delegator :@appenders, :log
+    def_delegator :@appenders, :flush
+    def_delegator :@appenders, :close
+    def_delegator :@appenders, :reopen
+
+    # Allow the internal logger to be overridden from its default of STDERR
+    #   Can be replaced with another Ruby logger or Rails logger, but never to
+    #   SemanticLogger::Logger itself since it is for reporting problems
+    #   while trying to log to the various appenders
+    class << self
+      attr_writer :logger
+    end
+
+    # Internal logger for SemanticLogger
+    #   For example when an appender is not working etc..
+    #   By default logs to STDERR
+    def self.logger
+      @logger ||=
+        begin
+          l      = SemanticLogger::Appender::File.new(io: STDERR, level: :warn)
+          l.name = name
+          l
+        end
+    end
+
+    attr_reader :appenders
+
+    def initialize
+      @appenders = Appenders.new(self.class.logger.dup)
+    end
+
+    def start
+      # NOP
+    end
+
+  end
+end

data/lib/semantic_logger/utils.rb

@@ -2,7 +2,7 @@ module SemanticLogger
   # Internal-use only utility functions for Semantic Logger.
   # Not intended for public use.
   module Utils
-    def self.constantize_symbol(symbol, namespace = 'SemanticLogger::Appender')
+    def self.constantize_symbol(symbol, namespace = "SemanticLogger::Appender")
       klass = "#{namespace}::#{camelize(symbol.to_s)}"
       begin
         Object.const_get(klass)
@@ -15,8 +15,8 @@ module SemanticLogger
     def self.camelize(term)
       string = term.to_s
       string = string.sub(/^[a-z\d]*/, &:capitalize)
-      string.gsub!(/(?:_|(\/))([a-z\d]*)/i) { "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}" }
-      string.gsub!('/'.freeze, '::'.freeze)
+      string.gsub!(%r{(?:_|(/))([a-z\d]*)}i) { "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}" }
+      string.gsub!("/".freeze, "::".freeze)
       string
     end
 
@@ -32,7 +32,7 @@ module SemanticLogger
       end
     end
 
-    SELF_PATTERN = File.join('lib', 'semantic_logger')
+    SELF_PATTERN = File.join("lib", "semantic_logger")
 
     # Extract the backtrace leaving out the last few Semantic Logger lines.
     def self.extract_backtrace(stack = caller)
@@ -50,11 +50,11 @@ module SemanticLogger
       stack
     end
 
-    GEM_ROOT = File.expand_path('../../..', __dir__) + '/'
+    GEM_ROOT = File.expand_path("../../..", __dir__) + "/"
 
     def self.system_path?(path)
       path.start_with?(GEM_ROOT) ||
-        path.start_with?(RbConfig::CONFIG['rubylibdir'])
+        path.start_with?(RbConfig::CONFIG["rubylibdir"])
     end
   end
 end

data/lib/semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module SemanticLogger
-  VERSION = '4.6.1'.freeze
+  VERSION = "4.7.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semantic_logger
 version: !ruby/object:Gem::Version
-  version: 4.6.1
+  version: 4.7.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-24 00:00:00.000000000 Z
+date: 2020-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -85,6 +85,8 @@ files:
 - lib/semantic_logger/reporters/minitest.rb
 - lib/semantic_logger/semantic_logger.rb
 - lib/semantic_logger/subscriber.rb
+- lib/semantic_logger/sync.rb
+- lib/semantic_logger/sync_processor.rb
 - lib/semantic_logger/utils.rb
 - lib/semantic_logger/version.rb
 homepage: https://github.com/rocketjob/semantic_logger