semantic_logger 4.3.1 → 4.4.0

data/lib/semantic_logger/semantic_logger.rb

@@ -3,18 +3,18 @@ require 'socket'
 
 module SemanticLogger
   # Logging levels in order of most detailed to most severe
-  LEVELS = %i[trace debug info warn error fatal].freeze
+  LEVELS = Levels::LEVELS
 
   # Return a logger for the supplied class or class_name
   def self.[](klass)
-    SemanticLogger::Logger.new(klass)
+    Logger.new(klass)
   end
 
   # Sets the global default log level
   def self.default_level=(level)
     @default_level = level
     # For performance reasons pre-calculate the level index
-    @default_level_index = level_to_index(level)
+    @default_level_index = Levels.index(level)
   end
 
   # Returns the global default log level
@@ -35,7 +35,7 @@ module SemanticLogger
   def self.backtrace_level=(level)
     @backtrace_level = level
     # For performance reasons pre-calculate the level index
-    @backtrace_level_index = level.nil? ? 65_535 : level_to_index(level)
+    @backtrace_level_index = level.nil? ? 65_535 : Levels.index(level)
   end
 
   # Returns the current backtrace level
@@ -152,19 +152,16 @@ module SemanticLogger
   #   logger.info "Hello World"
   #   logger.debug("Login time", user: 'Joe', duration: 100, ip_address: '127.0.0.1')
   def self.add_appender(options, deprecated_level = nil, &block)
-    options  = options.is_a?(Hash) ? options.dup : convert_old_appender_args(options, deprecated_level)
-    appender = SemanticLogger::Appender.factory(options, &block)
-    @appenders << appender
-
+    appender = Logger.processor.appenders.add(options, deprecated_level, &block)
     # Start appender thread if it is not already running
-    SemanticLogger::Processor.start
+    Logger.processor.start
     appender
   end
 
   # Remove an existing appender
   # Currently only supports appender instances
   def self.remove_appender(appender)
-    @appenders.delete(appender)
+    Logger.processor.appenders.delete(appender)
   end
 
   # Returns [SemanticLogger::Subscriber] a copy of the list of active
@@ -172,30 +169,28 @@ module SemanticLogger
   # Use SemanticLogger.add_appender and SemanticLogger.remove_appender
   # to manipulate the active appenders list
   def self.appenders
-    @appenders.clone
+    Logger.processor.appenders.to_a
   end
 
   # Flush all queued log entries disk, database, etc.
   #  All queued log messages are written and then each appender is flushed in turn.
   def self.flush
-    SemanticLogger::Processor.instance.flush
+    Logger.processor.flush
   end
 
   # Close all appenders and flush any outstanding messages.
   def self.close
-    SemanticLogger::Processor.instance.close
+    Logger.processor.close
   end
 
   # After forking an active process call SemanticLogger.reopen to re-open
   # any open file handles etc to resources.
   #
   # Note:
-  #   Not all appenders implement reopen.
+  #   Not all appender's implement reopen.
   #   Check the code for each appender you are using before relying on this behavior.
   def self.reopen
-    @appenders.each { |appender| appender.reopen if appender.respond_to?(:reopen) }
-    # After a fork the appender thread is not running, start it if it is not running.
-    SemanticLogger::Processor.start
+    Logger.processor.reopen
   end
 
   # Supply a callback to be called whenever a log entry is created.
@@ -223,7 +218,7 @@ module SemanticLogger
   # * This callback is called within the thread of the application making the logging call.
   # * If these callbacks are slow they will slow down the application.
   def self.on_log(object = nil, &block)
-    Processor.instance.appender.on_log(object, &block)
+    Logger.subscribe(object, &block)
   end
 
   # Add signal handlers for Semantic Logger
@@ -443,79 +438,49 @@ module SemanticLogger
   #   explicitly. I.e. That do not rely on the global default level
   def self.silence(new_level = :error)
     current_index                            = Thread.current[:semantic_logger_silence]
-    Thread.current[:semantic_logger_silence] = SemanticLogger.level_to_index(new_level)
+    Thread.current[:semantic_logger_silence] = Levels.index(new_level)
     yield
   ensure
     Thread.current[:semantic_logger_silence] = current_index
   end
 
-  def self.default_level_index
-    Thread.current[:semantic_logger_silence] || @default_level_index
+  # Returns [Integer] the number of log entries waiting to be written to the appenders.
+  #
+  # When this number grows it is because the logging appender thread is not
+  # able to write to the appenders fast enough. Either reduce the amount of
+  # logging, increase the log level, reduce the number of appenders, or
+  # look into speeding up the appenders themselves
+  def self.queue_size
+    Logger.processor.queue.size
   end
 
-  # private_class_method :default_level_index
-
-  # Returns the symbolic level for the supplied level index
-  def self.index_to_level(level_index)
-    LEVELS[level_index]
+  # Returns the check_interval which is the number of messages between checks
+  # to determine if the appender thread is falling behind.
+  def self.lag_check_interval
+    Logger.processor.lag_check_interval
   end
 
-  # private_class_method :index_to_level
-
-  # Internal method to return the log level as an internal index
-  # Also supports mapping the ::Logger levels to SemanticLogger levels
-  def self.level_to_index(level)
-    return if level.nil?
-
-    index =
-      if level.is_a?(Symbol)
-        LEVELS.index(level)
-      elsif level.is_a?(String)
-        level = level.downcase.to_sym
-        LEVELS.index(level)
-      elsif level.is_a?(Integer) && defined?(::Logger::Severity)
-        # Mapping of Rails and Ruby Logger levels to SemanticLogger levels
-        @map_levels ||= begin
-          levels = []
-          ::Logger::Severity.constants.each do |constant|
-            levels[::Logger::Severity.const_get(constant)] =
-              LEVELS.find_index(constant.downcase.to_sym) || LEVELS.find_index(:error)
-          end
-          levels
-        end
-        @map_levels[level]
-      end
-    raise "Invalid level:#{level.inspect} being requested. Must be one of #{LEVELS.inspect}" unless index
-    index
+  # Set the check_interval which is the number of messages between checks
+  # to determine if the appender thread is falling behind.
+  def self.lag_check_interval=(lag_check_interval)
+    Logger.processor.lag_check_interval = lag_check_interval
   end
 
-  # private_class_method :level_to_index
-
-  # Backward compatibility
-  def self.convert_old_appender_args(appender, level)
-    options         = {}
-    options[:level] = level if level
-
-    if appender.is_a?(String)
-      options[:file_name] = appender
-    elsif appender.is_a?(IO)
-      options[:io] = appender
-    elsif appender.is_a?(Symbol) || appender.is_a?(Subscriber)
-      options[:appender] = appender
-    else
-      options[:logger] = appender
-    end
-    warn "[DEPRECATED] SemanticLogger.add_appender parameters have changed. Please use: #{options.inspect}"
-    options
+  # Returns the amount of time in seconds
+  # to determine if the appender thread is falling behind.
+  def self.lag_threshold_s
+    Logger.processor.lag_threshold_s
   end
 
-  private_class_method :convert_old_appender_args
+  def self.default_level_index
+    Thread.current[:semantic_logger_silence] || @default_level_index
+  end
 
-  @appenders = Concurrent::Array.new
+  private
 
   # Initial default Level for all new instances of SemanticLogger::Logger
   @default_level         = :info
-  @default_level_index   = level_to_index(@default_level)
+  @default_level_index   = Levels.index(@default_level)
   @backtrace_level       = :error
-  @backtrace_level_index = level_to_index(@backtrace_level)
+  @backtrace_level_index = Levels.index(@backtrace_level)
 end

data/lib/semantic_logger/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semantic_logger
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 4.4.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-11 00:00:00.000000000 Z
+date: 2019-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -49,6 +49,7 @@ files:
 - lib/semantic_logger/appender/kafka.rb
 - lib/semantic_logger/appender/mongodb.rb
 - lib/semantic_logger/appender/new_relic.rb
+- lib/semantic_logger/appender/rabbitmq.rb
 - lib/semantic_logger/appender/sentry.rb
 - lib/semantic_logger/appender/splunk.rb
 - lib/semantic_logger/appender/splunk_http.rb
@@ -56,6 +57,7 @@ files:
 - lib/semantic_logger/appender/tcp.rb
 - lib/semantic_logger/appender/udp.rb
 - lib/semantic_logger/appender/wrapper.rb
+- lib/semantic_logger/appenders.rb
 - lib/semantic_logger/base.rb
 - lib/semantic_logger/concerns/compatibility.rb
 - lib/semantic_logger/core_ext/thread.rb
@@ -64,6 +66,7 @@ files:
 - lib/semantic_logger/formatters/base.rb
 - lib/semantic_logger/formatters/color.rb
 - lib/semantic_logger/formatters/default.rb
+- lib/semantic_logger/formatters/fluentd.rb
 - lib/semantic_logger/formatters/json.rb
 - lib/semantic_logger/formatters/one_line.rb
 - lib/semantic_logger/formatters/raw.rb
@@ -71,6 +74,7 @@ files:
 - lib/semantic_logger/formatters/syslog.rb
 - lib/semantic_logger/formatters/syslog_cee.rb
 - lib/semantic_logger/jruby/garbage_collection_logger.rb
+- lib/semantic_logger/levels.rb
 - lib/semantic_logger/log.rb
 - lib/semantic_logger/loggable.rb
 - lib/semantic_logger/logger.rb
@@ -78,48 +82,11 @@ files:
 - lib/semantic_logger/metric/signalfx.rb
 - lib/semantic_logger/metric/statsd.rb
 - lib/semantic_logger/processor.rb
+- lib/semantic_logger/reporters/minitest.rb
 - lib/semantic_logger/semantic_logger.rb
 - lib/semantic_logger/subscriber.rb
 - lib/semantic_logger/utils.rb
 - lib/semantic_logger/version.rb
-- test/appender/async_batch_test.rb
-- test/appender/async_test.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
-- test/appender/sentry_test.rb
-- test/appender/splunk_http_test.rb
-- test/appender/splunk_test.rb
-- test/appender/syslog_test.rb
-- test/appender/tcp_test.rb
-- test/appender/udp_test.rb
-- 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/formatters/one_line_test.rb
-- test/formatters/signalfx_test.rb
-- test/formatters_test.rb
-- test/in_memory_appender.rb
-- test/in_memory_appender_helper.rb
-- test/in_memory_batch_appender.rb
-- test/in_memory_metrics_appender.rb
-- test/loggable_test.rb
-- test/logger_test.rb
-- test/measure_test.rb
-- test/metric/new_relic_test.rb
-- test/metric/signalfx_test.rb
-- test/semantic_logger_test.rb
-- test/test_helper.rb
 homepage: https://github.com/rocketjob/semantic_logger
 licenses:
 - Apache-2.0
@@ -139,48 +106,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Feature rich logging framework, and replacement for existing Ruby & Rails
   loggers.
-test_files:
-- test/appender/sentry_test.rb
-- test/appender/splunk_http_test.rb
-- test/appender/honeybadger_test.rb
-- test/appender/splunk_test.rb
-- test/appender/graylog_test.rb
-- test/appender/syslog_test.rb
-- test/appender/async_batch_test.rb
-- test/appender/newrelic_rpm.rb
-- test/appender/tcp_test.rb
-- test/appender/mongodb_test.rb
-- test/appender/elasticsearch_http_test.rb
-- test/appender/new_relic_test.rb
-- test/appender/wrapper_test.rb
-- test/appender/file_test.rb
-- test/appender/udp_test.rb
-- test/appender/async_test.rb
-- test/appender/kafka_test.rb
-- test/appender/elasticsearch_test.rb
-- test/appender/bugsnag_test.rb
-- test/appender/http_test.rb
-- test/logger_test.rb
-- test/loggable_test.rb
-- test/measure_test.rb
-- test/in_memory_batch_appender.rb
-- test/in_memory_appender_helper.rb
-- test/formatters/color_test.rb
-- test/formatters/signalfx_test.rb
-- test/formatters/one_line_test.rb
-- test/formatters/default_test.rb
-- test/semantic_logger_test.rb
-- test/formatters_test.rb
-- test/test_helper.rb
-- test/debug_as_trace_logger_test.rb
-- test/metric/new_relic_test.rb
-- test/metric/signalfx_test.rb
-- test/in_memory_metrics_appender.rb
-- test/concerns/compatibility_test.rb
-- test/in_memory_appender.rb
+test_files: []

data/test/appender/async_batch_test.rb

@@ -1,60 +0,0 @@
-require_relative '../test_helper'
-
-module Appender
-  class AsyncBatchTest < Minitest::Test
-    describe SemanticLogger::Appender::Async do
-      include InMemoryAppenderHelper
-
-      let :appender do
-        InMemoryBatchAppender.new
-      end
-
-      describe 'with default batch_size' do
-        let :appender_options do
-          {appender: appender, batch: true}
-        end
-
-        it 'uses the batch proxy' do
-          assert_instance_of SemanticLogger::Appender::AsyncBatch, added_appender
-        end
-
-        it 'logs messages after a flush' do
-          logger.info('hello world1')
-          refute appender.message
-
-          logger.info('hello world2')
-          refute appender.message
-
-          logger.info('hello world3')
-          refute appender.message
-
-          # Calls flush
-          assert logs = log_message
-          assert_equal 3, logs.size, logs
-          assert_equal 'hello world1', logs[0].message
-          assert_equal 'hello world2', logs[1].message
-          assert_equal 'hello world3', logs[2].message
-        end
-      end
-
-      # :batch_size, :batch_seconds
-      describe 'with batch_size 1' do
-        let :appender_options do
-          {appender: appender, batch: true, batch_size: 1}
-        end
-
-        it 'uses the batch proxy' do
-          assert_instance_of SemanticLogger::Appender::AsyncBatch, added_appender
-        end
-
-        it 'logs message immediately' do
-          logger.info('hello world')
-
-          assert logs = log_message
-          assert_equal 1, logs.size, logs
-          assert_equal 'hello world', logs.first.message
-        end
-      end
-    end
-  end
-end

data/test/appender/async_test.rb

@@ -1,44 +0,0 @@
-require_relative '../test_helper'
-
-module Appender
-  class AsyncTest < Minitest::Test
-    describe SemanticLogger::Appender::Async do
-      include InMemoryAppenderHelper
-
-      describe 'with capped queue' do
-        let :appender_options do
-          {appender: appender, async: true}
-        end
-
-        it 'uses the async proxy' do
-          assert_instance_of SemanticLogger::Appender::Async, added_appender
-        end
-
-        it 'logs message immediately' do
-          logger.info('hello world')
-
-          assert log = log_message
-          assert_equal 'hello world', log.message
-        end
-
-        it 'uses an capped queue' do
-          assert_instance_of SizedQueue, added_appender.queue
-        end
-      end
-
-      describe 'with uncapped queue' do
-        let :appender_options do
-          {appender: appender, async: true, max_queue_size: -1}
-        end
-
-        it 'uses the async proxy' do
-          assert_instance_of SemanticLogger::Appender::Async, added_appender
-        end
-
-        it 'uses an uncapped queue' do
-          assert_instance_of Queue, added_appender.queue
-        end
-      end
-    end
-  end
-end