debug_logging 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80eec636fd64a69b41aaf67704b79c784bc5ffa989e181c51106bc908bc645c8
-  data.tar.gz: 8feca3ec5aadd298bc0da9f75631834f4a16bd73aa9d39572c8caf72ec2834b4
+  metadata.gz: ca22c0dbc789a56d7f02d3ef685d92fb0423592bde3fccaa733afcd577c88a78
+  data.tar.gz: 279bdd5ecde603ff0be14ec128bea893a05a53d0d4c0f42fbdb6663964fff178
 SHA512:
-  metadata.gz: bd13ad1dca5706140626730a48dc4e9133efc5e3db3d55f64b4c79f3a0bb21765d82a237c2a021d93ec2b4d0632d4a0a4bc5a3c28ef2bad088de9de37d6fdc3e
-  data.tar.gz: 9be10f369557ed872853e387870528c0a64df4981c854b3df6b27d22f0d24eac741d51e69beec9c6e6cfd2398748838d47ac5955df951d906d77378f60d4331a
+  metadata.gz: 352720fb350ee3c404f64b631c6f27f178ca8bb07b66e779cb26a66077708df9e716f7b0ef49e80035f44a45bc8081e436f420a14ac07f17d44a6b7e67ba46d1
+  data.tar.gz: 5effc5e2ef194e6e90c9c57f3378523a6fda0d5ab2b4d5fd7c4161bc542385b9796cfef56f015a756a75ead1969bb83f94c81d3dc4ba54607b7d9e2adab4c46f

data/CHANGELOG.md

@@ -11,7 +11,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Removed
 
-## [4.0.0] - unreleased
+## [4.0.1] ([tag][4.0.1t]) - 2024-03-01
+### Added
+- Support for all Numeric types to be used as monotonic timestamps for ActiveSupport::Notifications
+- `time_formatter_proc` - used to format timestamp added to beginning of log lines
+- `add_timestamp` - Add timestamp to front of each log line
+### Changed
+- `DebugLogging::ArgumentPrinter.debug_time_to_s` => `DebugLogging::ArgumentPrinter.debug_event_time_to_s`
+### Fixed
+### Removed
+
+## [4.0.0] ([tag][4.0.0t]) - 2024-02-28
 ### Added
 - Class method DSL:
     - `logged`
@@ -30,57 +40,57 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Support for `include DebugLogging::InstanceLogger.new(...)`
 - Support for `include DebugLogging::InstanceNotifier.new(...)`
 
-## [3.1.9] - 2023-10-31
+## [3.1.9] ([tag][3.1.9t]) - 2023-10-31
 ### Fixed
 - Maximum Ruby version is 2.7. Versions 3.x are not compatible with Ruby >= 3
 
-## [3.1.8] - 2020-12-19
+## [3.1.8] ([tag][3.1.8t]) - 2020-12-19
 
-## [3.1.7] - 2020-12-19
+## [3.1.7] ([tag][3.1.7t]) - 2020-12-19
 
-## [3.1.6] - tagged, but unreleased
+## [3.1.6] ([tag][3.1.6t]) - tagged, but unreleased
 
-## [3.1.5] - 2020-12-18
+## [3.1.5] ([tag][3.1.5t]) - 2020-12-18
 
-## [3.1.4] - 2020-12-18
+## [3.1.4] ([tag][3.1.4t]) - 2020-12-18
 
-## [3.1.3] - 2020-12-18
+## [3.1.3] ([tag][3.1.3t]) - 2020-12-18
 
-## [3.1.2] - 2020-12-10
+## [3.1.2] ([tag][3.1.2t]) - 2020-12-10
 
-## [3.1.1] - 2020-12-09
+## [3.1.1] ([tag][3.1.1t]) - 2020-12-09
 
-## [3.1.0] - 2020-10-24
+## [3.1.0] ([tag][3.1.0t]) - 2020-10-24
 
-## [3.0.0] - 2020-10-07
+## [3.0.0] ([tag][3.0.0t]) - 2020-10-07
 
-## [2.0.0] - 2020-10-06
+## [2.0.0] ([tag][2.0.0t]) - 2020-10-06
 
-## [1.0.17] - 2018-09-10
+## [1.0.17] ([tag][1.0.17t]) - 2018-09-10
 
-## [1.0.16] - 2018-01-16
+## [1.0.16] ([tag][1.0.16t]) - 2018-01-16
 
-## [1.0.15] - 2017-10-17
+## [1.0.15] ([tag][1.0.15t]) - 2017-10-17
 
-## [1.0.14] - 2017-10-09
+## [1.0.14] ([tag][1.0.14t]) - 2017-10-09
 
-## [1.0.13] - 2017-10-08
+## [1.0.13] ([tag][1.0.13t]) - 2017-10-08
 
-## [1.0.12] - 2017-10-08
+## [1.0.12] ([tag][1.0.12t]) - 2017-10-08
 
-## [1.0.11] - 2017-10-06
+## [1.0.11] ([tag][1.0.11t]) - 2017-10-06
 
-## [1.0.10] - 2017-09-26
+## [1.0.10] ([tag][1.0.10t]) - 2017-09-26
 
-## [1.0.9] - 2017-09-06
+## [1.0.9] ([tag][1.0.9t]) - 2017-09-06
 
-## [1.0.8] - 2017-09-06
+## [1.0.8] ([tag][1.0.8t]) - 2017-09-06
 
-## [1.0.7] - 2017-09-06
+## [1.0.7] ([tag][1.0.7t]) - 2017-09-06
 
-## [1.0.6] - 2017-09-05
+## [1.0.6] ([tag][1.0.6t]) - 2017-09-05
 
-## [1.0.5] ([tag][1.0.1t]) - 2017-03-31
+## [1.0.5] ([tag][1.0.5t]) - 2017-03-31
 
 ## [1.0.4] ([tag][1.0.4t]) - 2017-03-31
 
@@ -95,7 +105,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.1.0] ([tag][0.1.0t]) - 2017-03-25
 - Initial release
 
-[Unreleased]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v3.1.9...HEAD
+[Unreleased]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v4.0.1...HEAD
+[4.0.1t]: https://gitlab.com/pboling/debug_logging/-/tags/v4.0.1
+[4.0.1]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v4.0.0...v4.0.1
+[4.0.0t]: https://gitlab.com/pboling/debug_logging/-/tags/v4.0.0
+[4.0.0]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v3.1.9...v4.0.0
 [3.1.9t]: https://gitlab.com/pboling/debug_logging/-/tags/v3.1.9
 [3.1.9]: https://gitlab.com/kettle-rb/kettle-soup-cover/-/compare/v3.1.8...v3.1.9
 [3.1.8t]: https://gitlab.com/pboling/debug_logging/-/tags/v3.1.8

data/README.md

@@ -148,7 +148,7 @@ Recommend creating `config/initializers/debug_logging.rb`, or adding to `config/
 ```ruby
 # Showing the defaults
 DebugLogging.configuration.logger = Logger.new($stdout) # you probably want to override to be the Rails.logger, and if so you can't set it in the initializer, as it needs to be set after Rails.logger is set.
-DebugLogging.configuration.log_level = :debug # at what level do the messages created by this gem sent at?
+DebugLogging.configuration.log_level = :debug # at what level are the messages created by this gem sent at?
 DebugLogging.configuration.multiple_last_hashes = false # pass every hash argument to last_hash_to_s_proc?
 DebugLogging.configuration.last_hash_to_s_proc = nil # e.g. ->(hash) { "keys: #{hash.keys}" }
 DebugLogging.configuration.last_hash_max_length = 1_000
@@ -160,6 +160,8 @@ DebugLogging.configuration.active_support_notifications = false
 DebugLogging.configuration.colorized_chain_for_method = false # e.g. ->(colorized_string) { colorized_string.red.on_blue.underline }
 DebugLogging.configuration.colorized_chain_for_class = false # e.g. ->(colorized_string) { colorized_string.colorize(:light_blue ).colorize( :background => :red) }
 DebugLogging.configuration.add_invocation_id = true # identify a method call uniquely in a log, pass a proc for colorization, e.g. ->(colorized_string) { colorized_string.light_black }
+DebugLogging.configuration.time_formatter_proc = DebugLogging::Constants::DEFAULT_TIME_FORMATTER
+DebugLogging.configuration.add_timestamp = false
 DebugLogging.configuration.ellipsis = " ✂️ …".freeze
 DebugLogging.configuration.mark_scope_exit = true # Only has an effect if benchmarking is off, since benchmarking always marks the scope exit
 DebugLogging.configuration.add_payload = false # or a proc which will be called to print the payload
@@ -183,6 +185,8 @@ DebugLogging.configure do |config|
   config.active_support_notifications = false
   config.colorized_chain_for_method = false # e.g. ->(colorized_string) { colorized_string.red.on_blue.underline }
   config.colorized_chain_for_class = false # e.g. ->(colorized_string) { colorized_string.colorize(:light_blue ).colorize( :background => :red) }
+  config.time_formatter_proc = DebugLogging::Constants::DEFAULT_TIME_FORMATTER
+  config.add_timestamp = false
   config.add_invocation_id = true # identify a method call uniquely in a log, pass a proc for colorization, e.g. ->(colorized_string) { colorized_string.light_black }
   config.ellipsis = " ✂️ …".freeze
   config.mark_scope_exit = true # Only has an effect if benchmarking is off, since benchmarking always marks the scope exit
@@ -208,7 +212,7 @@ Just send along a hash of the config options, similar to the following:
 
 See the example class below, and the specs.
 
-**NOTE ON** `Rails.logger` - It will probably be nil in your initializer, so setting the `config.logger` to `Rails.logger` there will result in setting it to `nil`, which means the default will end up being used: `Logger.new(STDOUT)`. Instead just config the logger in your application.rb, or anytime later, but *before your classes get loaded* and start inheriting the config:
+**NOTE ON** `Rails.logger` - It will probably be nil in your initializer, so setting the `config.logger` to `Rails.logger` there will result in setting it to `nil`, which means the default will end up being used: `Logger.new($stdout)`. Instead just config the logger in your application.rb, or anytime later, but *before your classes get loaded* and start inheriting the config:
 
 ```ruby
 DebugLogging.configuration.logger = Rails.logger
@@ -294,7 +298,28 @@ class Car
   # Override configuration options for any instance method(s), by passing a hash as the last argument
   # In the last hash any non-Configuration keys will be data that gets logged,
   #     and also made available to last_hash_to_s_proc
-  i_logged [:faster], {add_invocation_id: false}
+  # Here's an example that sets every possible option, while also showing what the default values are!
+  i_logged [:faster], {
+    logger: Logger.new($stdout), # probably want to override to be the Rails.logger
+    log_level: :debug, # at what level do the messages created by this gem sent at?
+    multiple_last_hashes: false,
+    last_hash_to_s_proc: nil, # e.g. ->(hash) { "keys: #{hash.keys}" }
+    last_hash_max_length: 1_000,
+    args_to_s_proc: nil, # e.g. ->(*record) { "record id: #{record.first.id}" }
+    args_max_length: 1_000,
+    colorized_chain_for_method: false, # e.g. ->(colorized_string) { colorized_string.red.on_blue.underline }
+    colorized_chain_for_class: false,  # e.g. ->(colorized_string) { colorized_string.colorize(:light_blue ).colorize( :background => :red) }
+    add_invocation_id: true, # allows unique identification of method call; association of entry and exit log lines
+    ellipsis: " ✂️ …".freeze,
+    mark_scope_exit: false,
+    add_payload: true, # Can also be a proc returning a string, which will be called when printing the payload
+    payload_max_length: 1_000,
+    error_handler_proc: nil,
+    time_formatter_proc: DebugLogging::Constants::DEFAULT_TIME_FORMATTER,
+    add_timestamp: false,
+    instance_benchmarks: false,
+    class_benchmarks: false,
+  }
 
   # You can also use `i_logged` as a true method decorator:
   i_logged def slower

data/SECURITY.md

@@ -4,8 +4,8 @@
 
 | Version | Supported |
 |---------|-----------|
-| 3.1.x   | ✅         |
-| 3.0.x   | ❌         |
+| 4.x     | ✅         |
+| 3.x     | ❌         |
 | 2.x     | ❌         |
 | 1.x     | ❌         |
 

data/lib/debug_logging/argument_printer.rb

@@ -7,11 +7,13 @@ module DebugLogging
       "completed in #{format("%f", tms.real)}s (#{format("%f", tms.total)}s CPU)"
     end
 
-    def debug_invocation_id_to_s(args: nil, kwargs: nil, config_proxy: nil)
+    def debug_invocation_id_to_s(args: nil, kwargs: nil, start_at: nil, config_proxy: nil)
       return "" unless (args || kwargs) && config_proxy
 
       if config_proxy.debug_add_invocation_id
-        invocation = " ~#{args.object_id}|#{kwargs.object_id}@#{(Time.now.to_f.to_s % "%#-21a")[4..-4]}~"
+        time = start_at ? Util.debug_time(start_at) : Time.now
+        unique_id = (time.to_f.to_s % "%#-21a")[4..-4]
+        invocation = " ~#{args.object_id}|#{kwargs.object_id}@#{unique_id}~"
         case config_proxy.debug_add_invocation_id
         when true
           invocation
@@ -23,21 +25,25 @@ module DebugLogging
       end
     end
 
-    def debug_time_to_s(time_or_monotonic)
+    # @return [String]
+    def debug_time_to_s(time_or_monotonic, config_proxy: nil)
+      return "" unless config_proxy&.debug_add_timestamp
+      return config_proxy.debug_time_formatter_proc.call(Time.now) unless time_or_monotonic
+
+      time = Util.debug_time(time_or_monotonic)
+
+      config_proxy.debug_time_formatter_proc.call(time)
+    end
+
+    # A custom time format will never apply here, because ActiveSupport::Notifications have a required time format
+    def debug_event_time_to_s(time_or_monotonic)
       # Time format must match:
       #   \d{4,}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} [-+]\d{4}
       #   YYYY-MM-DD HH:mm:ss +00:00
       #   strftime("%F %T %z")
-      case time_or_monotonic
-      when Float
-        Time.at(time_or_monotonic).strftime("%F %T %z")
-      when Time, DateTime
-        time_or_monotonic.strftime("%F %T %z")
-      when String
-        Time.parse(time_or_monotonic).strftime("%F %T %z")
-      else
-        time_or_monotonic
-      end
+      time_or_monotonic = Time.now if time_or_monotonic.nil? || (time_or_monotonic.respond_to?(:empty?) && time_or_monotonic.empty?)
+      time = Util.debug_time(time_or_monotonic)
+      DebugLogging::Constants::EVENT_TIME_FORMATTER.call(time)
     end
 
     def debug_invocation_to_s(klass: nil, separator: nil, method_to_log: nil, config_proxy: nil)
@@ -188,7 +194,7 @@ module DebugLogging
           proc_name: "add_payload",
           proc: config_proxy.debug_add_payload,
           args: payload,
-          max_length: config_proxy.payload_max_length,
+          max_length: config_proxy.debug_payload_max_length,
         )
         printed_payload += printed
         printed_payload += config_proxy.debug_ellipsis if add_payload_ellipsis

data/lib/debug_logging/configuration.rb

@@ -12,16 +12,25 @@ module DebugLogging
     #     extend DebugLogging::InstanceLogger
     #     i_logged [:drive, :stop],
     #       {
-    #         logger: Logger.new(STDOUT) # probably want to override to be the Rails.logger
-    #         log_level: :debug # at what level do the messages created by this gem sent at?
-    #         last_hash_to_s_proc: nil # e.g. ->(hash) { "keys: #{hash.keys}" }
-    #         last_hash_max_length: 1_000
-    #         args_to_s_proc: nil # e.g. ->(*record) { "record id: #{record.first.id}" }
-    #         args_max_length: 1_000
-    #         instance_benchmarks: false
-    #         class_benchmarks: false
-    #         add_invocation_id: true # invocation id allows you to identify a method call uniquely in a log
-    #         ellipsis: " ✂️ …".freeze
+    #         logger: Logger.new($stdout), # probably want to override to be the Rails.logger
+    #         log_level: :debug, # at what level do the messages created by this gem sent at?
+    #         multiple_last_hashes: false,
+    #         last_hash_to_s_proc: nil, # e.g. ->(hash) { "keys: #{hash.keys}" }
+    #         last_hash_max_length: 1_000,
+    #         args_to_s_proc: nil, # e.g. ->(*record) { "record id: #{record.first.id}" }
+    #         args_max_length: 1_000,
+    #         colorized_chain_for_method: false, # e.g. ->(colorized_string) { colorized_string.red.on_blue.underline }
+    #         colorized_chain_for_class: false,  # e.g. ->(colorized_string) { colorized_string.colorize(:light_blue ).colorize( :background => :red) }
+    #         add_invocation_id: true, # allows unique identification of method call; association of entry and exit log lines
+    #         ellipsis: " ✂️ …".freeze,
+    #         mark_scope_exit: false,
+    #         add_payload: true, # Can also be a proc returning a string, which will be called when printing the payload
+    #         payload_max_length: 1_000,
+    #         error_handler_proc: nil,
+    #         time_formatter_proc: DebugLogging::Constants::DEFAULT_TIME_FORMATTER,
+    #         add_timestamp: false,
+    #         instance_benchmarks: false,
+    #         class_benchmarks: false,
     #       }
     #
     CONFIG_KEYS.each do |key|

data/lib/debug_logging/constants.rb

@@ -1,23 +1,27 @@
 module DebugLogging
   module Constants
     DEFAULT_ELLIPSIS = " ✂️ …"
+    DEFAULT_TIME_FORMATTER = ->(time) { "[#{time.strftime("%Y%m%d %H:%M:%S")}] " }
+    EVENT_TIME_FORMATTER = ->(time) { time.strftime("%F %T %z") }
     CONFIG_ATTRS_DEFAULTS = {
       enabled: true,
-      logger: Logger.new($stdout),
-      log_level: :debug,
+      logger: Logger.new($stdout), # probably want to override to be the Rails.logger
+      log_level: :debug, # at what level do the messages created by this gem sent at?
       multiple_last_hashes: false,
-      last_hash_to_s_proc: nil,
+      last_hash_to_s_proc: nil, # e.g. ->(hash) { "keys: #{hash.keys}" }
       last_hash_max_length: 1_000,
-      args_to_s_proc: nil,
+      args_to_s_proc: nil, # e.g. ->(*record) { "record id: #{record.first.id}" }
       args_max_length: 1_000,
-      colorized_chain_for_method: false,
-      colorized_chain_for_class: false,
-      add_invocation_id: true,
+      colorized_chain_for_method: false, # e.g. ->(colorized_string) { colorized_string.red.on_blue.underline }
+      colorized_chain_for_class: false,  # e.g. ->(colorized_string) { colorized_string.colorize(:light_blue ).colorize( :background => :red) }
+      add_invocation_id: true, # allows unique identification of method call; association of entry and exit log lines
       ellipsis: DEFAULT_ELLIPSIS,
       mark_scope_exit: false,
       add_payload: true, # Can also be a proc returning a string, which will be called when printing the payload
       payload_max_length: 1_000,
       error_handler_proc: nil,
+      time_formatter_proc: DEFAULT_TIME_FORMATTER,
+      add_timestamp: false,
     }.freeze
     CONFIG_ATTRS = CONFIG_ATTRS_DEFAULTS.keys
     CONFIG_READERS_DEFAULTS = {

data/lib/debug_logging/instance_logger.rb

@@ -1,5 +1,27 @@
 module DebugLogging
   module InstanceLogger
+    # NOTE: These params can be passed in / hidden in a last hash of *args
+    # NOTE: They can also be passed in discretely for each method, by passing *args as an array of arrays
+    # TODO: Refactor to use modern Ruby 3 *args, **kwargs instead
+    # @param logger [Logger] Logger.new($stdout), # probably want to override to be the Rails.logger
+    # @param log_level [Symbol] default: :debug, at what level do the messages created by this gem sent at?
+    # @param multiple_last_hashes [true, false] default: false,
+    # @param last_hash_to_s_proc [nil, Proc] default: nil, e.g. ->(hash) { "keys: #{hash.keys}" }
+    # @param last_hash_max_length [Integer] default: 1_000,
+    # @param args_to_s_proc [nil, Proc] default: nil, e.g. ->(*record) { "record id: #{record.first.id}" }
+    # @param args_max_length [Integer] default: 1_000,
+    # @param colorized_chain_for_method [false, Proc] default: false, e.g. ->(colorized_string) { colorized_string.red.on_blue.underline }
+    # @param colorized_chain_for_class [false, Proc] default: false, e.g. ->(colorized_string) { colorized_string.colorize(:light_blue ).colorize( :background => :red) }
+    # @param add_invocation_id [true, false] default: true, allows unique identification of method call; association of entry and exit log lines
+    # @param ellipsis [String] default: " ✂️ …".freeze,
+    # @param mark_scope_exit [true, false] default: false,
+    # @param add_payload [true, false, Proc] default: true, # Can also be a proc returning a string, which will be called when printing the payload
+    # @param payload_max_length [Integer] default: 1_000,
+    # @param error_handler_proc [nil, Proc] default: nil,
+    # @param time_formatter_proc [nil, Proc] default: DebugLogging::Constants::DEFAULT_TIME_FORMATTER,
+    # @param add_timestamp [true, false] default: false,
+    # @param instance_benchmarks [true, false] default: false,
+    # @param class_benchmarks [true, false] default: false,
     def i_logged(*methods_to_log)
       methods_to_log, payload, config_opts = DebugLogging::Util.extract_payload_and_config(
         method_names: methods_to_log,

data/lib/debug_logging/instance_logger_modulizer.rb

@@ -28,19 +28,22 @@ module DebugLogging
                 method_to_log: method_to_log,
                 config_proxy: config_proxy,
               )
-              invocation_id = self.class.debug_invocation_id_to_s(args:, kwargs:, config_proxy:)
+              start_at = Time.now
+              start_timestamp = self.class.debug_time_to_s(start_at, config_proxy:)
+              invocation_id = self.class.debug_invocation_id_to_s(args:, kwargs:, start_at:, config_proxy:)
               config_proxy.log do
                 paydirt = DebugLogging::Util.payload_instance_variable_hydration(scope: self, payload: method_payload)
                 signature = self.class.debug_signature_to_s(args:, kwargs:, config_proxy:)
                 paymud = debug_payload_to_s(payload: paydirt, config_proxy:)
-                "#{log_prefix}#{signature}#{invocation_id} debug: #{paymud}"
+                "#{start_timestamp}#{log_prefix}#{signature}#{invocation_id} debug: #{paymud}"
               end
               if config_proxy.benchmarkable_for?(:debug_instance_benchmarks)
                 tms = Benchmark.measure do
                   method_return_value = super(*args, **kwargs, &block)
                 end
+                end_timestamp = self.class.debug_time_to_s(Time.now, config_proxy:)
                 config_proxy.log do
-                  "#{log_prefix} #{self.class.debug_benchmark_to_s(tms: tms)}#{invocation_id}"
+                  "#{end_timestamp}#{log_prefix} #{self.class.debug_benchmark_to_s(tms: tms)}#{invocation_id}"
                 end
               else
                 begin
@@ -53,8 +56,9 @@ module DebugLogging
                   end
                 end
                 if config_proxy.exit_scope_markable? && invocation_id && !invocation_id.empty?
+                  end_timestamp = self.class.debug_time_to_s(Time.now, config_proxy:)
                   config_proxy.log do
-                    "#{log_prefix} completed#{invocation_id}"
+                    "#{end_timestamp}#{log_prefix} completed#{invocation_id}"
                   end
                 end
               end

data/lib/debug_logging/log_subscriber.rb

@@ -32,8 +32,8 @@ module DebugLogging
       {
         name: event.name,
         duration: Rational(event.duration, 1000).to_f,
-        time: debug_time_to_s(event.time),
-        end: debug_time_to_s(event.end),
+        time: debug_event_time_to_s(event.time),
+        end: debug_event_time_to_s(event.end),
         args: debug_signature_to_s(args: args, config_proxy: config_proxy),
         payload: debug_payload_to_s(payload: payload, config_proxy: config_proxy),
       }

data/lib/debug_logging/util.rb

@@ -2,6 +2,20 @@ module DebugLogging
   module Util
     module_function
 
+    def debug_time(time_or_monotonic)
+      case time_or_monotonic
+      when Time, DateTime
+        time_or_monotonic
+      when Numeric
+        Time.at(time_or_monotonic)
+      when String
+        Time.parse(time_or_monotonic)
+      else
+        # Garbage in, Sweet Nourishing Gruel Out
+        Time.now
+      end
+    end
+
     # methods_to_log may be an array of a single method name, followed by config options and payload,
     #   or it could be an array of method names followed by config options and payload to be shared by the whole set.
     def extract_payload_and_config(method_names:, payload: nil, config: nil)
@@ -36,6 +50,8 @@ module DebugLogging
             # logged :meth1, :meth2, :meth3 without options is valid
             method_names
           end
+        else
+          raise ArgumentError, "unknown type for method_names: #{method_names.class}"
         end
       [method_names, payload, config_opts]
     end

data/lib/debug_logging/version.rb

@@ -1,5 +1,5 @@
 module DebugLogging
   module Version
-    VERSION = "4.0.0"
+    VERSION = "4.0.1"
   end
 end

data/lib/debug_logging.rb

@@ -233,6 +233,22 @@ module DebugLogging
       @debug_logging_configuration.colorized_chain_for_class = colorized_chain_for_class
     end
 
+    def debug_add_timestamp
+      @debug_logging_configuration.add_timestamp
+    end
+
+    def debug_add_timestamp=(add_timestamp)
+      @debug_logging_configuration.add_timestamp = add_timestamp
+    end
+
+    def debug_time_formatter_proc
+      @debug_logging_configuration.time_formatter_proc
+    end
+
+    def debug_time_formatter_proc=(time_formatter_proc)
+      @debug_logging_configuration.time_formatter_proc = time_formatter_proc
+    end
+
     def debug_add_invocation_id
       @debug_logging_configuration.add_invocation_id
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debug_logging
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Peter Boling
@@ -38,7 +38,7 @@ cert_chain:
   KuxrfYrN+9HvMdm+nZ6TypmKftHY3Gj+/uu+g8Icm/zrvTWAEE0mcJOkfrIoNPJb
   pF8dMA==
   -----END CERTIFICATE-----
-date: 2024-02-28 00:00:00.000000000 Z
+date: 2024-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -319,10 +319,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/pboling/debug_logging
-  source_code_uri: https://github.com/pboling/debug_logging/tree/v4.0.0
-  changelog_uri: https://github.com/pboling/debug_logging/blob/v4.0.0/CHANGELOG.md
+  source_code_uri: https://github.com/pboling/debug_logging/tree/v4.0.1
+  changelog_uri: https://github.com/pboling/debug_logging/blob/v4.0.1/CHANGELOG.md
   bug_tracker_uri: https://github.com/pboling/debug_logging/issues
-  documentation_uri: https://www.rubydoc.info/gems/debug_logging/4.0.0
+  documentation_uri: https://www.rubydoc.info/gems/debug_logging/4.0.1
   wiki_uri: https://github.com/pboling/debug_logging/wiki
   funding_uri: https://liberapay.com/pboling
   rubygems_mfa_required: 'true'