semantic_logger 5.0.0 → 5.1.0

data/lib/semantic_logger/appender/syslog.rb

@@ -151,7 +151,8 @@ module SemanticLogger
             require "syslog_protocol"
           rescue LoadError
             raise LoadError,
-                  "Missing gem: syslog_protocol. This gem is required when logging over TCP or UDP. To fix this error: gem install syslog_protocol"
+                  "Missing gem: syslog_protocol. This gem is required when logging over TCP or UDP. " \
+                  "To fix this error: gem install syslog_protocol"
           end
 
           # The net_tcp_client gem is required when logging over TCP.
@@ -160,7 +161,8 @@ module SemanticLogger
               require "net/tcp_client"
             rescue LoadError
               raise LoadError,
-                    "Missing gem: net_tcp_client. This gem is required when logging over TCP. To fix this error: gem install net_tcp_client"
+                    "Missing gem: net_tcp_client. This gem is required when logging over TCP. " \
+                    "To fix this error: gem install net_tcp_client"
             end
           end
         end
@@ -210,7 +212,8 @@ module SemanticLogger
         @remote_syslog.flush if @remote_syslog.respond_to?(:flush)
       end
 
-      # Returns [SemanticLogger::Formatters::Base] default formatter for this Appender depending on the protocal selected
+      # Returns [SemanticLogger::Formatters::Base] default formatter for this Appender
+      # depending on the protocol selected
       def default_formatter
         if protocol == :syslog
           # Format is text output without the time.

data/lib/semantic_logger/appender/tcp.rb

@@ -183,8 +183,8 @@ module SemanticLogger
       #     connect_retry_count:    5
       #   )
       def initialize(separator: "\n",
-                     level: nil, formatter: nil, filter: nil, application: nil, environment: nil, host: nil, metrics: false,
-                     **tcp_client_args, &)
+                     level: nil, formatter: nil, filter: nil, application: nil, environment: nil,
+                     host: nil, metrics: false, **tcp_client_args, &)
         @separator       = separator
         @tcp_client_args = tcp_client_args
 
@@ -192,7 +192,8 @@ module SemanticLogger
         Net::TCPClient.logger      = logger
         Net::TCPClient.logger.name = "Net::TCPClient"
 
-        super(level: level, formatter: formatter, filter: filter, application: application, environment: environment, host: host, metrics: metrics, &)
+        super(level: level, formatter: formatter, filter: filter, application: application,
+              environment: environment, host: host, metrics: metrics, &)
         reopen
       end
 

data/lib/semantic_logger/appender/wrapper.rb

@@ -45,7 +45,8 @@ module SemanticLogger
         does_not_implement = LEVELS[1..].find { |i| !@logger.respond_to?(i) }
         if does_not_implement
           raise(ArgumentError,
-                "Supplied logger does not implement:#{does_not_implement}. It must implement all of #{LEVELS[1..].inspect}")
+                "Supplied logger does not implement:#{does_not_implement}. " \
+                "It must implement all of #{LEVELS[1..].inspect}")
         end
 
         super(**args, &)

data/lib/semantic_logger/appender.rb

@@ -87,7 +87,8 @@ module SemanticLogger
           appender
         else
           raise(ArgumentError,
-                "Parameter :appender must be either a Symbol or an object derived from SemanticLogger::Subscriber, not: #{appender.inspect}")
+                "Parameter :appender must be either a Symbol or an object derived from " \
+                "SemanticLogger::Subscriber, not: #{appender.inspect}")
         end
       elsif metric
         if metric.is_a?(Symbol)
@@ -96,11 +97,13 @@ module SemanticLogger
           metric
         else
           raise(ArgumentError,
-                "Parameter :metric must be either a Symbol or an object derived from SemanticLogger::Subscriber, not: #{appender.inspect}")
+                "Parameter :metric must be either a Symbol or an object derived from " \
+                "SemanticLogger::Subscriber, not: #{appender.inspect}")
         end
       else
         raise(ArgumentError,
-              "To create an appender it must supply one of the following: :io, :file_name, :appender, :metric, or :logger")
+              "To create an appender it must supply one of the following: " \
+              ":io, :file_name, :appender, :metric, or :logger")
       end
     end
 

data/lib/semantic_logger/appenders.rb

@@ -14,7 +14,8 @@ module SemanticLogger
 
       stream = appender.respond_to?(:console_stream) && appender.console_stream
       if stream && console_streams.include?(stream)
-        logger.warn "Ignoring attempt to add a second #{stream} console appender since it would result in duplicate console output."
+        logger.warn "Ignoring attempt to add a second #{stream} console appender since it " \
+                    "would result in duplicate console output."
         return
       end
 

data/lib/semantic_logger/base.rb

@@ -155,8 +155,6 @@ module SemanticLogger
           log.named_tags  = (thread[:semantic_logger_named_tags] || {}).clone
           thread.backtrace
         end
-      # TODO: Keep backtrace instead of transforming into a text message at this point
-      # Maybe log_backtrace: true
       if backtrace
         message += "\n"
         message << backtrace.join("\n")

data/lib/semantic_logger/formatters/color.rb

@@ -97,7 +97,9 @@ module SemanticLogger
         return if named_tags.nil? || named_tags.empty?
 
         list = []
-        named_tags.each_pair { |name, value| list << "#{color}#{escape_control_characters(name)}: #{escape_control_characters(value)}#{color_map.clear}" }
+        named_tags.each_pair do |name, value|
+          list << "#{color}#{escape_control_characters(name)}: #{escape_control_characters(value)}#{color_map.clear}"
+        end
         "{#{list.join(', ')}}"
       end
 
@@ -126,7 +128,8 @@ module SemanticLogger
       def exception
         return unless log.exception
 
-        "-- Exception: #{color}#{log.exception.class}: #{escape_control_characters(log.exception.message)}#{color_map.clear}\n#{log.backtrace_to_s}"
+        "-- Exception: #{color}#{log.exception.class}: " \
+          "#{escape_control_characters(log.exception.message)}#{color_map.clear}\n#{log.backtrace_to_s}"
       end
 
       def call(log, logger)

data/lib/semantic_logger/formatters/default.rb

@@ -43,7 +43,9 @@ module SemanticLogger
         return if named_tags.nil? || named_tags.empty?
 
         list = []
-        named_tags.each_pair { |name, value| list << "#{escape_control_characters(name)}: #{escape_control_characters(value)}" }
+        named_tags.each_pair do |name, value|
+          list << "#{escape_control_characters(name)}: #{escape_control_characters(value)}"
+        end
         "{#{list.join(', ')}}"
       end
 
@@ -72,7 +74,10 @@ module SemanticLogger
 
       # Exception
       def exception
-        "-- Exception: #{log.exception.class}: #{escape_control_characters(log.exception.message)}\n#{log.backtrace_to_s}" if log.exception
+        return unless log.exception
+
+        "-- Exception: #{log.exception.class}: #{escape_control_characters(log.exception.message)}\n" \
+          "#{log.backtrace_to_s}"
       end
 
       # Default text log format

data/lib/semantic_logger/formatters/logfmt.rb

@@ -8,11 +8,13 @@ module SemanticLogger
     #   :timestamp, :level, :name, :message, :duration, :tags, :named_tags
     #
     # E.g.
-    #   timestamp="2020-07-20T08:32:05.375276Z" level=info name="DefaultTest" base="breakfast" spaces="second breakfast" double_quotes="\"elevensies\"" single_quotes="'lunch'" tag="success"
+    #   timestamp="2020-07-20T08:32:05.375276Z" level=info name="DefaultTest" base="breakfast"
+    #   spaces="second breakfast" double_quotes="\"elevensies\"" single_quotes="'lunch'" tag="success"
     #
     # All timestamps are ISO8601 formatteed
     # All user supplied values are escaped and surrounded by double quotes to avoid ambiguious message delimeters
-    # `tags` are treated as keys with boolean values. Tag names are not formatted or validated, ensure you use valid logfmt format for tag names.
+    # `tags` are treated as keys with boolean values. Tag names are not formatted or validated;
+    # ensure you use valid logfmt format for tag names.
     # `named_tags` are flattened are merged into the top level message field. Any conflicting fields are overridden.
     # `payload` values take precedence over `tags` and `named_tags`. Any conflicting fields are overridden.
     #

data/lib/semantic_logger/formatters/pattern.rb

@@ -172,7 +172,9 @@ module SemanticLogger
         if key
           escape_control_characters(named[key.to_sym] || named[key.to_s])
         else
-          named.map { |name, value| "#{escape_control_characters(name)}: #{escape_control_characters(value)}" }.join(", ")
+          named.map do |name, value|
+            "#{escape_control_characters(name)}: #{escape_control_characters(value)}"
+          end.join(", ")
         end
       end
 

data/lib/semantic_logger/formatters/syslog.rb

@@ -2,7 +2,8 @@ begin
   require "syslog_protocol"
 rescue LoadError
   raise LoadError,
-        'Gem syslog_protocol is required for remote logging using the Syslog protocol. Please add the gem "syslog_protocol" to your Gemfile.'
+        "Gem syslog_protocol is required for remote logging using the Syslog protocol. " \
+        'Please add the gem "syslog_protocol" to your Gemfile.'
 end
 
 module SemanticLogger

data/lib/semantic_logger/formatters/syslog_cee.rb

@@ -2,7 +2,8 @@ begin
   require "syslog_protocol"
 rescue LoadError
   raise LoadError,
-        'Gem syslog_protocol is required for remote logging using the Syslog protocol. Please add the gem "syslog_protocol" to your Gemfile.'
+        "Gem syslog_protocol is required for remote logging using the Syslog protocol. " \
+        'Please add the gem "syslog_protocol" to your Gemfile.'
 end
 
 module SemanticLogger

data/lib/semantic_logger/metric/signalfx.rb

@@ -66,8 +66,10 @@ module SemanticLogger
       #   logger.info(metric: 'Common/User/authorize', duration: 1.4)
       #
       # Then it is translated into the following 2 log entries under the covers:
-      #   logger.info(metric: 'Application.average', metric_amount: 1.4, dimensions: {class: 'Common::User', action: 'authorize'})
-      #   logger.info(metric: 'Application.counter', metric_amount: 1, dimensions: {class: 'Common::User', action: 'authorize'})
+      #   logger.info(metric: 'Application.average', metric_amount: 1.4,
+      #               dimensions: {class: 'Common::User', action: 'authorize'})
+      #   logger.info(metric: 'Application.counter', metric_amount: 1,
+      #               dimensions: {class: 'Common::User', action: 'authorize'})
       #
       # Similarly with a measure block which automatically supplies the duration:
       #   logger.measure_info(metric: 'Common/User/authorize') do

data/lib/semantic_logger/queue_processor.rb

@@ -224,7 +224,8 @@ module SemanticLogger
         if async_max_retries == -1 || retry_count < async_max_retries
           @retry_count += 1
           limit = async_max_retries == -1 ? "unlimited" : async_max_retries
-          safe_log(:warn, "Async: Restarting due to exception, retry #{retry_count} of #{limit}, sleeping #{retry_count}s", e)
+          safe_log(:warn,
+                   "Async: Restarting due to exception, retry #{retry_count} of #{limit}, sleeping #{retry_count}s", e)
           sleep(retry_count)
           retry
         else
@@ -341,7 +342,9 @@ module SemanticLogger
       diff = Time.now - log.time
       return unless diff > lag_threshold_s
 
-      logger.warn "Async: Appender thread has fallen behind by #{diff} seconds with #{queue.size} messages queued up. Consider reducing the log level or changing the appenders"
+      logger.warn "Async: Appender thread has fallen behind by #{diff} seconds with " \
+                  "#{queue.size} messages queued up. Consider reducing the log level or " \
+                  "changing the appenders"
     end
 
     # Submit a command to the worker thread and wait for the reply.

data/lib/semantic_logger/reporters/minitest.rb

@@ -16,10 +16,10 @@ module SemanticLogger
     #
     # Log entries similar to the following should show up in the log file:
     #
-    # 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
+    # 2019-02-06 18:58:17.522467 I [84730:70256] Minitest -- START MyJob test_0001_archives file
+    # 2019-02-06 18:58:17.527492 I [84730:70256] (4.980ms) Minitest -- PASS MyJob test_0001_archives file
+    # 2019-02-06 18:58:17.527835 I [84730:70256] Minitest -- START MyJob test_0002_returns job class
+    # 2019-02-06 18:58:17.529761 I [84730:70256] (1.882ms) Minitest -- PASS MyJob test_0002_returns job class
     class Minitest < ::Minitest::AbstractReporter
       include SemanticLogger::Loggable
 

data/lib/semantic_logger/test/capture_log_events.rb

@@ -24,7 +24,7 @@ module SemanticLogger
 
       # By default collect all log levels, and collect metric only log events.
       def initialize(level: :trace, metrics: true)
-        super(level: level, metrics: true)
+        super
         @events = []
       end
 

data/lib/semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module SemanticLogger
-  VERSION = "5.0.0".freeze
+  VERSION = "5.1.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: semantic_logger
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Reid Morrison
@@ -33,6 +33,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- docs/api.md
+- docs/appenders.md
+- docs/config.md
+- docs/index.md
+- docs/log.md
+- docs/metrics.md
+- docs/operations.md
+- docs/rails.md
+- docs/security.md
+- docs/testing.md
+- docs/upgrading.md
 - lib/semantic_logger.rb
 - lib/semantic_logger/ansi_colors.rb
 - lib/semantic_logger/appender.rb
@@ -112,9 +123,9 @@ licenses:
 - Apache-2.0
 metadata:
   bug_tracker_uri: https://github.com/reidmorrison/semantic_logger/issues
-  changelog_uri: https://github.com/reidmorrison/semantic_logger/releases
+  changelog_uri: https://github.com/reidmorrison/semantic_logger/blob/main/CHANGELOG.md
   documentation_uri: https://logger.rocketjob.io
-  source_code_uri: https://github.com/reidmorrison/semantic_logger/tree/v5.0.0
+  source_code_uri: https://github.com/reidmorrison/semantic_logger/tree/v5.1.0
   rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths: