dry-logger 1.0.0.rc1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 343929c403f114dcb22a13c0406ef82982800e9bed8e58d483a86ab3442d7f13
-  data.tar.gz: 2a224fba0dc7f8d5771219ba0bee0eef0322cefe11e14fbb49ca066319e68bca
+  metadata.gz: 730cb488952659e0a7499948d6f77e3ed61b7be38e462d7a000479d7e6a8c7f2
+  data.tar.gz: 81ddc5b02fc960cb3650f1305e19bfc33d21488722455c8bfdcb3e411cb07bf4
 SHA512:
-  metadata.gz: e945a3fde7a2bc2fb8731ae46aabac59df1c8da6208d125d09759af04cc848f5b09453c66b7f65da49ecc79094809ea76746c1610b25f47980833965f43a8037
-  data.tar.gz: 7af951d7152c84f8dbbec03a2c57bbd527b10791a39d585597885378036e823594b5d9b50754b765a445811fc46c3fb34d546a7c33a3a75f8de60b70bad90b88
+  metadata.gz: 02d8e2eb6e2029a3c29269db001e5e3f50eacf1605efa4cdd62ae01a1e8349b80073e0b591761ed3bc82f7acda5b139a2a03c120c32b3716c27c2d054eee0a64
+  data.tar.gz: 2f11fec53ac321f0157f3c620944d460a189fa4da112a5b2d617a21171533dcacf17370bf1288d2ef1e4574ab4f35518aca2e280a7063df669768d1c3dda73b6

data/CHANGELOG.md

@@ -1,13 +1,27 @@
 <!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
 
-## 1.0.0.rc1 2022-11-07
+## 1.0.0 
 
 This is a port of the original Hanami logger from hanami-utils extended with support for logging
-dispatchers that can log to different destinations.
+dispatchers that can log to different destinations and plenty more.
 
 
 ### Added
 
+- Support arbitrary logging backends through proxy (via #12) (@solnic)
+- Support for conditional logging when using arbitrary logging backends (via #13) (@solnic)
+- Support for registering templates via `Dry::Logger.register_template` (via #14) (@solnic)
+- Support for payload keys as template tokens (via #14) (@solnic)
+- Support for payload value formatter methods, ie if there's `:verb` token your formatter can implement `format_verb(value)` (via #14) (@solnic)
+- Support block-based setup (via #16) (@solnic)
+- Support for defining cherry-picked keys from the payload in string templates (via #17) (@solnic)
+- Support for `%<payload>s` template token. It will be replaced by a formatted payload, excluding any key that you specified explicitly in the template (via #17) (@solnic)
+- Support for colorized output using color tags in templates (via #18) (@solnic)
+- Support for `colorize: true` logger option which enables severity coloring in string formatter (via #18) (@solnic)
+- `:details` template: `"[%<progname>s] [%<severity>s] [%<time>s] %<message>s %<payload>s"` (@solnic)
+- A new option `on_crash` for setting up a logger-crash handling proc (via #21) (@solnic)
+- Handle logger crashes by default using a simple `$stdout` logger (via #21) (@solnic)
+- Support for regular logger backends that don't support `log?` predicate (@solnic)
 - Support for providing a string template for log entries via `template` option (via #7) (@solnic)
 - `:rack` string log formatter which inlines request info and displays params at the end (@solnic)
 - Conditional log dispatch via `#log_if` backend's predicate (via #9) (@solnic)

data/lib/dry/logger/backends/core.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "dry/logger/constants"
+
+module Dry
+  module Logger
+    module Backends
+      module Core
+        # Return a proc used by the log? predicate
+        #
+        # @since 1.0.0
+        # @api private
+        attr_reader :log_if
+
+        # Set a predicate proc that checks if an entry should be logged by a given backend
+        #
+        # The predicate will receive {Entry} as its argument and should return true/false
+        #
+        # @param [Proc, #to_proc] spec A proc-like object
+        # @since 1.0.0
+        # @api public
+        def log_if=(spec)
+          @log_if = spec&.to_proc
+        end
+
+        # @since 1.0.0
+        # @api private
+        def log?(entry)
+          if log_if
+            log_if.call(entry)
+          else
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/logger/backends/proxy.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "delegate"
+
+require "dry/logger/constants"
+require "dry/logger/backends/core"
+
+module Dry
+  module Logger
+    module Backends
+      # Logger proxy is used for regular loggers that don't work with log entries
+      #
+      # @since 1.0.0
+      # @api private
+      class Proxy < SimpleDelegator
+        include Core
+
+        # @since 0.1.0
+        # @api public
+        attr_accessor :log_if
+
+        LOG_METHODS.each do |method|
+          define_method(method) { |entry| __getobj__.public_send(method, entry.message) }
+        end
+
+        # @since 1.0.0
+        # @api private
+        def log?(entry)
+          if log_if
+            log_if.call(entry)
+          else
+            true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/logger/backends/stream.rb

@@ -3,11 +3,14 @@
 require "logger"
 
 require "dry/logger/constants"
+require "dry/logger/backends/core"
 
 module Dry
   module Logger
     module Backends
       class Stream < ::Logger
+        include Core
+
         # @since 0.1.0
         # @api private
         attr_reader :stream
@@ -16,10 +19,6 @@ module Dry
         # @api private
         attr_reader :level
 
-        # @since 0.1.0
-        # @api public
-        attr_accessor :log_if
-
         # @since 0.1.0
         # @api private
         def initialize(stream:, formatter:, level: DEFAULT_LEVEL, progname: nil, log_if: nil)
@@ -33,13 +32,9 @@ module Dry
         end
 
         # @since 1.0.0
-        # @api private
-        def log?(entry)
-          if log_if
-            log_if.call(entry)
-          else
-            true
-          end
+        # @api public
+        def inspect
+          %(#<#{self.class} stream=#{stream} level=#{level} log_if=#{log_if}>)
         end
       end
     end

data/lib/dry/logger/clock.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Dry
+  module Logger
+    # @since 1.0.0
+    # @api private
+    class Clock
+      # @since 1.0.0
+      # @api private
+      attr_reader :unit
+
+      # @since 1.0.0
+      # @api private
+      def initialize(unit: :nanosecond)
+        @unit = unit
+      end
+
+      # @since 1.0.0
+      # @api private
+      def now
+        Time.now
+      end
+
+      # @since 1.0.0
+      # @api private
+      def now_utc
+        now.getutc
+      end
+
+      # @since 1.0.0
+      # @api private
+      def measure
+        start = current
+        result = yield
+        [result, current - start]
+      end
+
+      private
+
+      # @since 1.0.0
+      # @api private
+      def current
+        Process.clock_gettime(Process::CLOCK_MONOTONIC, unit)
+      end
+    end
+  end
+end

data/lib/dry/logger/constants.rb

@@ -4,22 +4,67 @@ require "logger"
 
 module Dry
   module Logger
-    LOG_METHODS = %i[debug error fatal info warn].freeze
+    # @since 1.0.0
+    # @api private
+    NEW_LINE = $/ # rubocop:disable Style/SpecialGlobalVars
+
+    # @since 1.0.0
+    # @api private
+    SEPARATOR = " "
+
+    # @since 1.0.0
+    # @api private
+    TAB = SEPARATOR * 2
+
+    # @since 1.0.0
+    # @api private
+    EMPTY_ARRAY = [].freeze
 
+    # @since 1.0.0
+    # @api private
+    EMPTY_HASH = {}.freeze
+
+    # @since 1.0.0
+    # @api private
+    LOG_METHODS = %i[debug info warn error fatal unknown].freeze
+
+    # @since 1.0.0
+    # @api private
     BACKEND_METHODS = %i[close].freeze
 
+    # @since 1.0.0
+    # @api private
     DEBUG = ::Logger::DEBUG
+
+    # @since 1.0.0
+    # @api private
     INFO = ::Logger::INFO
+
+    # @since 1.0.0
+    # @api private
     WARN = ::Logger::WARN
+
+    # @since 1.0.0
+    # @api private
     ERROR = ::Logger::ERROR
+
+    # @since 1.0.0
+    # @api private
     FATAL = ::Logger::FATAL
+
+    # @since 1.0.0
+    # @api private
     UNKNOWN = ::Logger::UNKNOWN
 
+    # @since 1.0.0
+    # @api private
     LEVEL_RANGE = (DEBUG..UNKNOWN).freeze
 
+    # @since 1.0.0
+    # @api private
     DEFAULT_LEVEL = INFO
 
-    # @since 0.1.0
+    # @since 1.0.0
     # @api private
     LEVELS = Hash
       .new { |levels, key|
@@ -35,9 +80,16 @@ module Dry
       )
       .freeze
 
-    DEFAULT_OPTS = {level: DEFAULT_LEVEL, formatter: nil, progname: nil}.freeze
+    # @since 1.0.0
+    # @api private
+    DEFAULT_OPTS = {level: DEFAULT_LEVEL, formatter: nil, progname: nil, log_if: nil}.freeze
 
+    # @since 1.0.0
+    # @api private
     BACKEND_OPT_KEYS = DEFAULT_OPTS.keys.freeze
+
+    # @since 1.0.0
+    # @api private
     FORMATTER_OPT_KEYS = %i[filter].freeze
   end
 end

data/lib/dry/logger/dispatcher.rb

@@ -4,6 +4,7 @@ require "logger"
 require "pathname"
 
 require "dry/logger/constants"
+require "dry/logger/backends/proxy"
 require "dry/logger/entry"
 
 module Dry
@@ -37,21 +38,48 @@ module Dry
       # @api private
       attr_reader :options
 
+      # @since 1.0.0
+      # @api private
+      attr_reader :clock
+
+      # @since 1.0.0
+      # @api private
+      attr_reader :on_crash
+
       # @since 1.0.0
       # @api private
       attr_reader :mutex
 
+      # @since 1.0.0
+      # @api private
+      CRASH_LOGGER = ::Logger.new($stdout).tap { |logger|
+        logger.formatter = -> (_, _, _, message) { "#{message}#{NEW_LINE}" }
+        logger.level = FATAL
+      }.freeze
+
+      # @since 1.0.0
+      # @api private
+      ON_CRASH = -> (progname:, exception:, message:, payload:) {
+        CRASH_LOGGER.fatal(Logger.templates[:crash] % {
+          severity: "FATAL",
+          progname: progname,
+          time: Time.now,
+          log_entry: [message, payload].map(&:to_s).reject(&:empty?).join(SEPARATOR),
+          exception: exception.class,
+          message: exception.message,
+          backtrace: TAB + exception.backtrace.join(NEW_LINE + TAB)
+        })
+      }
+
       # Set up a dispatcher
       #
       # @since 1.0.0
-      #
-      # @param [String, Symbol] id The dispatcher id, can be used as progname in log entries
-      # @param [Hash] options Options that can be used for both the backend and formatter
+      # @api private
       #
       # @return [Dispatcher]
-      # @api public
       def self.setup(id, **options)
         dispatcher = new(id, **DEFAULT_OPTS, **options)
+        yield(dispatcher) if block_given?
         dispatcher.add_backend if dispatcher.backends.empty?
         dispatcher
       end
@@ -64,12 +92,17 @@ module Dry
 
       # @since 1.0.0
       # @api private
-      def initialize(id, backends: [], context: self.class.default_context, **options)
+      def initialize(
+        id, backends: [], tags: [], context: self.class.default_context, **options
+      )
         @id = id
         @backends = backends
         @options = {**options, progname: id}
         @mutex = Mutex.new
         @context = context
+        @tags = tags
+        @clock = Clock.new(**(options[:clock] || EMPTY_HASH))
+        @on_crash = options[:on_crash] || ON_CRASH
       end
 
       # Log an entry with UNKNOWN severity
@@ -128,7 +161,7 @@ module Dry
 
       BACKEND_METHODS.each do |name|
         define_method(name) do
-          call(name)
+          forward(name)
         end
       end
 
@@ -143,8 +176,25 @@ module Dry
 
       # Pass logging to all configured backends
       #
+      # @example logging a message
+      #   logger.log(:info, "Hello World")
+      #
+      # @example logging payload
+      #   logger.log(:info, verb: "GET", path: "/users")
+      #
+      # @example logging message and payload
+      #   logger.log(:info, "User index request", verb: "GET", path: "/users")
+      #
+      # @example logging exception
+      #   begin
+      #     # things that may raise
+      #   rescue => e
+      #     logger.log(:error, e)
+      #     raise e
+      #   end
+      #
       # @param [Symbol] severity The log severity name
-      # @param [String,Symbol,Array] message Optional message object
+      # @param [String] message Optional message
       # @param [Hash] payload Optional log entry payload
       #
       # @since 1.0.0
@@ -155,15 +205,24 @@ module Dry
         when Hash then log(severity, nil, **message)
         else
           entry = Entry.new(
+            clock: clock,
             progname: id,
             severity: severity,
+            tags: @tags,
             message: message,
             payload: {**context, **payload}
           )
 
-          each_backend { |backend| backend.__send__(severity, entry) if backend.log?(entry) }
+          each_backend do |backend|
+            backend.__send__(severity, entry) if backend.log?(entry)
+          rescue StandardError => e
+            on_crash.(progname: id, exception: e, message: message, payload: payload)
+          end
         end
 
+        true
+      rescue StandardError => e
+        on_crash.(progname: id, exception: e, message: message, payload: payload)
         true
       end
 
@@ -180,11 +239,11 @@ module Dry
       #
       # @since 1.0.0
       # @api public
-      def tagged(tag)
-        context[:tag] = tag
+      def tagged(*tags)
+        @tags.concat(tags)
         yield
       ensure
-        context.delete(:tag)
+        @tags = []
       end
 
       # Add a new backend to an existing dispatcher
@@ -198,15 +257,27 @@ module Dry
       # @return [Dispatcher]
       # @api public
       def add_backend(instance = nil, **backend_options)
-        backend = instance || Dry::Logger.new(**options, **backend_options)
+        backend =
+          case (instance ||= Dry::Logger.new(**options, **backend_options))
+          when Backends::Stream then instance
+          else Backends::Proxy.new(instance)
+          end
+
         yield(backend) if block_given?
+
         backends << backend
         self
       end
 
+      # @since 1.0.0
+      # @api public
+      def inspect
+        %(#<#{self.class} id=#{id} options=#{options} backends=#{backends}>)
+      end
+
       # @since 1.0.0
       # @api private
-      def each_backend(*_args, &block)
+      def each_backend(&block)
         mutex.synchronize do
           backends.each(&block)
         end
@@ -217,7 +288,7 @@ module Dry
       # @since 1.0.0
       # @return [true]
       # @api private
-      def call(meth, ...)
+      def forward(meth, ...)
         each_backend { |backend| backend.public_send(meth, ...) }
         true
       end

data/lib/dry/logger/entry.rb

@@ -10,14 +10,6 @@ module Dry
     class Entry
       include Enumerable
 
-      # @since 1.0.0
-      # @api private
-      EMPTY_PAYLOAD = {}.freeze
-
-      # @since 1.0.0
-      # @api private
-      EMPTY_BACKTRACE = [].freeze
-
       # @since 1.0.0
       # @api public
       attr_reader :progname
@@ -28,16 +20,19 @@ module Dry
 
       # @since 1.0.0
       # @api public
-      attr_reader :level
+      attr_reader :tags
 
       # @since 1.0.0
       # @api public
-      attr_reader :time
+      attr_reader :level
 
       # @since 1.0.0
       # @api public
       attr_reader :message
-      alias_method :exception, :message
+
+      # @since 1.0.0
+      # @api public
+      attr_reader :exception
 
       # @since 1.0.0
       # @api public
@@ -45,14 +40,23 @@ module Dry
 
       # @since 1.0.0
       # @api private
-      def initialize(progname:, severity:, time: Time.now, message: nil, payload: EMPTY_PAYLOAD)
+      attr_reader :clock
+
+      # @since 1.0.0
+      # @api private
+      # rubocop:disable Metrics/ParameterLists
+      def initialize(clock:, progname:, severity:, tags: EMPTY_ARRAY, message: nil,
+                     payload: EMPTY_HASH)
+        @clock = clock
         @progname = progname
-        @severity = severity.to_s.upcase # TODO: this doesn't feel right
+        @severity = severity.to_s
+        @tags = tags
         @level = LEVELS.fetch(severity.to_s)
-        @time = time
-        @message = message
+        @message = message unless message.is_a?(Exception)
+        @exception = message if message.is_a?(Exception)
         @payload = build_payload(payload)
       end
+      # rubocop:enable Metrics/ParameterLists
 
       # @since 1.0.0
       # @api public
@@ -99,7 +103,7 @@ module Dry
       # @since 1.0.0
       # @api public
       def exception?
-        message.is_a?(Exception)
+        !exception.nil?
       end
 
       # @since 1.0.0
@@ -109,28 +113,21 @@ module Dry
       end
 
       # @since 1.0.0
-      # @api private
-      def to_h
-        @to_h ||= meta.merge(payload)
+      # @api public
+      def tag?(value)
+        tags.include?(value)
       end
 
       # @since 1.0.0
       # @api private
       def meta
-        @meta ||= {progname: progname, severity: severity, time: time}
+        @meta ||= {progname: progname, severity: severity, time: clock.now}
       end
 
       # @since 1.0.0
       # @api private
-      def utc_time
-        @utc_time ||= time.utc.iso8601
-      end
-
-      # @since 1.0.0
-      # @api private
-      def as_json
-        # TODO: why are we enforcing UTC in JSON but not in String?
-        @as_json ||= to_h.merge(message: message, time: utc_time).compact
+      def to_h
+        @to_h ||= meta.merge(message: message, **payload)
       end
 
       # @since 1.0.0
@@ -146,10 +143,7 @@ module Dry
       # @api private
       def build_payload(payload)
         if exception?
-          {message: exception.message,
-           backtrace: exception.backtrace || EMPTY_BACKTRACE,
-           error: exception.class,
-           **payload}
+          {exception: exception, **payload}
         else
           payload
         end

data/lib/dry/logger/formatters/colors.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Dry
+  module Logger
+    module Formatters
+      # Shell colorizer
+      #
+      # This was ported from hanami-utils
+      #
+      # @since 1.0.0
+      # @api private
+      class Colors
+        # Unknown color code error
+        #
+        # @since 1.0.0
+        class UnknownColorCodeError < StandardError
+          def initialize(code)
+            super("Unknown color code: `#{code.inspect}'")
+          end
+        end
+
+        # Escapes codes for terminals to output strings in colors
+        #
+        # @since 1.2.0
+        # @api private
+        COLORS = {black: 30,
+                  red: 31,
+                  green: 32,
+                  yellow: 33,
+                  blue: 34,
+                  magenta: 35,
+                  cyan: 36,
+                  gray: 37}.freeze
+
+        # @api private
+        def self.evaluate(input)
+          COLORS.keys.reduce(input.dup) { |output, color|
+            output.gsub!("<#{color}>", start(color))
+            output.gsub!("</#{color}>", stop)
+            output
+          }
+        end
+
+        # Colorizes output
+        # 8 colors available: black, red, green, yellow, blue, magenta, cyan, and gray
+        #
+        # @param input [#to_s] the string to colorize
+        # @param color [Symbol] the color
+        #
+        # @raise [UnknownColorError] if the color code is unknown
+        #
+        # @return [String] the colorized string
+        #
+        # @since 1.0.0
+        # @api private
+        def self.call(color, input)
+          "#{start(color)}#{input}#{stop}"
+        end
+
+        # @since 1.0.0
+        # @api private
+        def self.start(color)
+          "\e[#{self[color]}m"
+        end
+
+        # @since 1.0.0
+        # @api private
+        def self.stop
+          "\e[0m"
+        end
+
+        # Helper method to translate between color names and terminal escape codes
+        #
+        # @since 1.0.0
+        # @api private
+        #
+        # @raise [UnknownColorError] if the color code is unknown
+        def self.[](code)
+          COLORS.fetch(code) { raise UnknownColorCodeError, code }
+        end
+      end
+    end
+  end
+end