debug_logging 3.1.2 → 3.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb9df42efa08fe95b6c9270a4474132b2dbb55ed8d154d17c20dfde074781a8c
-  data.tar.gz: 459f277689fcb9b328b4c904730ae25bfe1c55fc87a5ab292157393f6b13c36b
+  metadata.gz: 12a45427d0ca5aea996bd2ddce9da4ae3f763afe2e5b0abefea2173f6765ff61
+  data.tar.gz: 1a9d1a08b5f49daaa6f01c10c48b3a5345794a46f9b62f25243f13e6ebacd694
 SHA512:
-  metadata.gz: 5af7096cfbadcea5695cc19bdce85e4d6ac8eecf02139378cb2dc0d734d99011bc49ff239fe1d816ce9570a883b75b4f6e0772fdfbf7feda147e7890c56d415a
-  data.tar.gz: f471d3858ad20c1d3347b4ce328254c01572da54fd0e566ccbf6b15827996c561cf86c5fcb23f14ad127d5a9449b045c63281768c082b2375d754e566f3d4561
+  metadata.gz: f55f81ffe673ec404dd49fc26db2778abf3311a3f7f148a85c5030369cb469b8570c8728db5526b838caf2e09b22e04ad314ab27c462b8b246905e00945b2d9a
+  data.tar.gz: c5bc397f5b50d19551d7db9b6d7fe9cafa034ff36cbac2551d9c2a52d0e9a9f70992d0efb49a46fabf6830f76818b15eaf6653be9fee38aad415af9d2f92510a

data/README.md

@@ -1,6 +1,7 @@
 # DebugLogging
 
 Unobtrusive, inheritable-overridable-configurable, drop-in debug logging, that won't leave a mess behind when it is time to remove it.
+Supports ActiveSupport::Notifications (thanks [@jgillson](https://github.com/jgillson)).  Optional ActiveRecord callback-style hooks that you can decorate your methods with. Hooks logic was taken from the [`slippy_method_hooks` gem](https://github.com/guckin/slippy_method_hooks), (thanks [@guckin](https://github.com/guckin)), and prefaced with `debug_` for this implementation. `DebugLogging::Finalize` is lightly modified from [this stackoverflow answer](https://stackoverflow.com/a/34559282).
 
 ## What do I mean by "unobtrusive"?
 
@@ -32,12 +33,16 @@ Unobtrusive, inheritable-overridable-configurable, drop-in debug logging, that w
 * *colorization by class/method*
 * *robust argument printer with customizable ellipsis*
 * *unique invocation identifiers*
-* *single line config, per class/instance/method config*
-* *separate logger, if needed*
+* *simple single line global config, or per class/instance/method config*
+* *separate loggers, if needed*
 * *log method calls, also when exit scope*
 * *Prevents heavy computation of strings with `logger.debug { 'log me' }` block format, since v1.0.12*
-* *ActiveSupport::Notifications integration for instrumenting/logging events on class and instance methods, since v3.1*
-* *Optional instance variable logging, sine v3.1*
+* *ActiveSupport::Notifications integration for instrumenting/logging events on class and instance methods, since v3.1.3*
+* *Optional instance, and class-instance, variable logging, since v3.1.3*
+* *ActiveRecord style callback-hooks (optional: `require 'debug_logging/hooks'` and `include DebugLogging::Hooks`), since v3.1.3*
+* *All configuration is inheritable to, and overridable by, child classes, since v3.1.3*
+* *[Class finalization hook](https://stackoverflow.com/a/34559282) (optional: `require 'debug_logging/finalize'` and `extend DebugLogging::Finalize`), since v3.1.3*
+* *Error handling hooks you can use to log problems when they happen, since v3.1.7*
 * **so many free ponies** 🎠🐴🎠🐴🎠🐴
 
 ## Next Level Magic
@@ -46,8 +51,10 @@ Herein you will find:
 
 * Classes inheriting from Module
 * Zero tolerance policy on monkey patching
+  * When the gem is loaded there are no monkey patches.
+  * Rather, your own classes/methods get "patched" and "hooked" as you configure them.
 * 100% clean, 0% obtrusive
-* 100% tested
+* ~100% tested
 * 100% Ruby 2.1+ compatible
   - use version `gem "debug_logging", "~> 1.0"` for Ruby < 2.3
   - use version `gem "debug_logging", "~> 2.0"` for Ruby 2.3
@@ -91,6 +98,7 @@ DebugLogging.configuration.log_level = :debug # at what level do the messages cr
 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
+DebugLogging.configuration.args_to_s_proc = nil # e.g. ->(record) { "record id: #{record.id}" }
 DebugLogging.configuration.args_max_length = 1_000
 DebugLogging.configuration.instance_benchmarks = false
 DebugLogging.configuration.class_benchmarks = false
@@ -100,6 +108,9 @@ DebugLogging.configuration.colorized_chain_for_class = false # e.g. ->(colorized
 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.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
+DebugLogging.configuration.payload_max_length = 1000
+DebugLogging.configuration.error_handler_proc = nil # e.g. ->(error, config, obj, method_name, args) { config.log { "#{error.class}: #{error.message} in #{method_name}\nargs: #{args.inspect}" } }
 ```
 
 If you prefer to use the block style:
@@ -111,6 +122,7 @@ DebugLogging.configure do |config|
   config.multiple_last_hashes = false # pass every hash argument to last_hash_to_s_proc?
   config.last_hash_to_s_proc = nil # e.g. ->(hash) { "keys: #{hash.keys}" }
   config.last_hash_max_length = 1_000
+  config.args_to_s_proc = nil # e.g. ->(record) { "record id: #{record.id}" }
   config.args_max_length = 1_000
   config.instance_benchmarks = false
   config.class_benchmarks = false
@@ -120,6 +132,9 @@ DebugLogging.configure do |config|
   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
+  config.add_payload = false # or a proc which will be called to print the payload
+  config.payload_max_length = 1000
+  config.error_handler_proc = nil # e.g. ->(error, config, obj, method_name, args) { config.log { "#{error.class}: #{error.message} in #{method_name}\nargs: #{args.inspect}" } }
 end
 ```
 
@@ -381,6 +396,10 @@ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+### License Exceptions
+
+* [`debug_logging/finalize`](https://stackoverflow.com/a/34559282) is licensed under https://creativecommons.org/licenses/by-sa/4.0/
+
 [semver]: http://semver.org/
 [pvc]: http://docs.rubygems.org/read/chapter/16#page74
 [railsbling]: http://www.railsbling.com

data/debug_logging.gemspec

@@ -7,7 +7,7 @@ require 'debug_logging/version'
 Gem::Specification.new do |spec|
   spec.name          = 'debug_logging'
   spec.version       = DebugLogging::VERSION
-  spec.authors       = ['Peter Boling']
+  spec.authors       = ['Peter Boling', 'guckin']
   spec.email         = ['peter.boling@gmail.com']
 
   spec.summary       = 'Drop-in debug logging useful when a call stack gets unruly'

data/lib/debug_logging.rb

@@ -4,9 +4,14 @@ require 'logger'
 require 'colorized_string'
 require 'digest'
 
+require 'debug_logging/constants'
 require 'debug_logging/version'
+require 'debug_logging/errors'
 require 'debug_logging/configuration'
+require 'debug_logging/util'
+require 'debug_logging/finalize'
 require 'debug_logging/argument_printer'
+require 'debug_logging/hooks'
 require 'debug_logging/instance_logger_modulizer'
 require 'debug_logging/instance_logger'
 require 'debug_logging/class_logger'
@@ -60,26 +65,17 @@ require 'debug_logging/class_logger'
 module DebugLogging
   def self.extended(base)
     base.send(:extend, ArgumentPrinter)
+    base.send(:extend, ApiClassMethods)
+    base.send(:extend, ConfigClassMethods)
     base.debug_config_reset(Configuration.new(**debug_logging_configuration.to_hash))
+    base.class_eval do
+      def base.inherited(subclass)
+        subclass.debug_config_reset(Configuration.new(**debug_config.to_hash))
+      end
+    end
   end
 
   #### API ####
-  # Not used by this gem internally, but provides an external interface for
-  #   classes to also use this logging tool directly,
-  #   with configured options like benchmarking, colors, or leg level.
-  def debug_log(message = nil, config_proxy = nil, &block)
-    # If a, instance-method-level, or class-method-level custom config is not
-    #   passed in, then fall back to the class' default config, which is a
-    #   potentially customized copy of the default config for the whole app.
-    config_proxy ||= debug_config
-    config_proxy.log(message, &block)
-  end
-
-  # There are times when the class will need access to the configuration object,
-  #   such as to override it per instance method
-  def debug_config
-    @debug_logging_configuration
-  end
 
   # For single statement global config in an initializer
   # e.g. DebugLogging.configuration.ellipsis = "..."
@@ -92,130 +88,187 @@ module DebugLogging
     yield(configuration)
   end
 
-  # For per-class config with a block
-  def debug_logging_configure
-    @debug_logging_configuration ||= Configuration.new
-    yield(@debug_logging_configuration)
+  module ApiClassMethods
+    # Not used by this gem internally, but provides an external interface for
+    #   classes to also use this logging tool directly,
+    #   with configured options like benchmarking, colors, or leg level.
+    def debug_log(message = nil, config_proxy = nil, &block)
+      # If a, instance-method-level, or class-method-level custom config is not
+      #   passed in, then fall back to the class' default config, which is a
+      #   potentially customized copy of the default config for the whole app.
+      config_proxy ||= debug_config
+      config_proxy.log(message, &block)
+    end
+
+    # There are times when the class will need access to the configuration object,
+    #   such as to override it per instance method
+    def debug_config
+      @debug_logging_configuration
+    end
   end
 
   #### CONFIG ####
   class << self
     attr_accessor :debug_logging_configuration
   end
-  def debug_config_reset(config = Configuration.new)
-    @debug_logging_configuration = config
-  end
 
-  def debug_enabled
-    @debug_logging_configuration.enabled
-  end
+  module ConfigClassMethods
+    include Constants
 
-  def debug_enabled=(value)
-    @debug_logging_configuration.enabled = value
-  end
+    # For per-class config with a block
+    def debug_logging_configure
+      @debug_logging_configuration ||= Configuration.new
+      yield(@debug_logging_configuration)
+    end
 
-  def debug_logger
-    @debug_logging_configuration.logger
-  end
+    def debug_config_reset(config = Configuration.new)
+      @debug_logging_configuration = config
+    end
 
-  def debug_logger=(logger)
-    @debug_logging_configuration.logger = logger
-  end
+    def debug_enabled
+      @debug_logging_configuration.enabled
+    end
 
-  def debug_log_level
-    @debug_logging_configuration.log_level
-  end
+    def debug_enabled=(value)
+      @debug_logging_configuration.enabled = value
+    end
 
-  def debug_log_level=(log_level)
-    @debug_logging_configuration.log_level = log_level
-  end
+    def debug_logger
+      @debug_logging_configuration.logger
+    end
 
-  def debug_multiple_last_hashes
-    @debug_logging_configuration.multiple_last_hashes
-  end
+    def debug_logger=(logger)
+      @debug_logging_configuration.logger = logger
+    end
 
-  def debug_multiple_last_hashes=(multiple_last_hashes)
-    @debug_logging_configuration.multiple_last_hashes = multiple_last_hashes
-  end
+    def debug_log_level
+      @debug_logging_configuration.log_level
+    end
 
-  def debug_last_hash_to_s_proc
-    @debug_logging_configuration.last_hash_to_s_proc
-  end
+    def debug_log_level=(log_level)
+      @debug_logging_configuration.log_level = log_level
+    end
 
-  def debug_last_hash_to_s_proc=(last_hash_to_s_proc)
-    @debug_logging_configuration.last_hash_to_s_proc = last_hash_to_s_proc
-  end
+    def debug_multiple_last_hashes
+      @debug_logging_configuration.multiple_last_hashes
+    end
 
-  def debug_last_hash_max_length
-    @debug_logging_configuration.last_hash_max_length
-  end
+    def debug_multiple_last_hashes=(multiple_last_hashes)
+      @debug_logging_configuration.multiple_last_hashes = multiple_last_hashes
+    end
 
-  def debug_last_hash_max_length=(last_hash_max_length)
-    @debug_logging_configuration.last_hash_max_length = last_hash_max_length
-  end
+    def debug_last_hash_to_s_proc
+      @debug_logging_configuration.last_hash_to_s_proc
+    end
 
-  def debug_args_max_length
-    @debug_logging_configuration.args_max_length
-  end
+    def debug_last_hash_to_s_proc=(last_hash_to_s_proc)
+      @debug_logging_configuration.last_hash_to_s_proc = last_hash_to_s_proc
+    end
 
-  def debug_args_max_length=(args_max_length)
-    @debug_logging_configuration.args_max_length = args_max_length
-  end
+    def debug_last_hash_max_length
+      @debug_logging_configuration.last_hash_max_length
+    end
 
-  def debug_instance_benchmarks
-    @debug_logging_configuration.instance_benchmarks
-  end
+    def debug_last_hash_max_length=(last_hash_max_length)
+      @debug_logging_configuration.last_hash_max_length = last_hash_max_length
+    end
 
-  def debug_instance_benchmarks=(instance_benchmarks)
-    @debug_logging_configuration.instance_benchmarks = instance_benchmarks
-  end
+    def debug_args_to_s_proc
+      @debug_logging_configuration.args_to_s_proc
+    end
 
-  def debug_class_benchmarks
-    @debug_logging_configuration.class_benchmarks
-  end
+    def debug_args_to_s_proc=(args_to_s_proc)
+      @debug_logging_configuration.args_to_s_proc = args_to_s_proc
+    end
 
-  def debug_class_benchmarks=(class_benchmarks)
-    @debug_logging_configuration.class_benchmarks = class_benchmarks
-  end
+    def debug_args_max_length
+      @debug_logging_configuration.args_max_length
+    end
 
-  def debug_colorized_chain_for_method
-    @debug_logging_configuration.colorized_chain_for_method
-  end
+    def debug_args_max_length=(args_max_length)
+      @debug_logging_configuration.args_max_length = args_max_length
+    end
 
-  def debug_colorized_chain_for_method=(colorized_chain_for_method)
-    @debug_logging_configuration.colorized_chain_for_method = colorized_chain_for_method
-  end
+    def debug_instance_benchmarks
+      @debug_logging_configuration.instance_benchmarks
+    end
 
-  def debug_colorized_chain_for_class
-    @debug_logging_configuration.colorized_chain_for_class
-  end
+    def debug_instance_benchmarks=(instance_benchmarks)
+      @debug_logging_configuration.instance_benchmarks = instance_benchmarks
+    end
 
-  def debug_colorized_chain_for_class=(colorized_chain_for_class)
-    @debug_logging_configuration.colorized_chain_for_class = colorized_chain_for_class
-  end
+    def debug_class_benchmarks
+      @debug_logging_configuration.class_benchmarks
+    end
 
-  def debug_add_invocation_id
-    @debug_logging_configuration.add_invocation_id
-  end
+    def debug_class_benchmarks=(class_benchmarks)
+      @debug_logging_configuration.class_benchmarks = class_benchmarks
+    end
 
-  def debug_add_invocation_id=(add_invocation_id)
-    @debug_logging_configuration.add_invocation_id = add_invocation_id
-  end
+    def debug_colorized_chain_for_method
+      @debug_logging_configuration.colorized_chain_for_method
+    end
 
-  def debug_mark_scope_exit
-    @debug_logging_configuration.mark_scope_exit
-  end
+    def debug_colorized_chain_for_method=(colorized_chain_for_method)
+      @debug_logging_configuration.colorized_chain_for_method = colorized_chain_for_method
+    end
 
-  def debug_mark_scope_exit=(mark_scope_exit)
-    @debug_logging_configuration.mark_scope_exit = mark_scope_exit
-  end
+    def debug_colorized_chain_for_class
+      @debug_logging_configuration.colorized_chain_for_class
+    end
 
-  def debug_ellipsis
-    @debug_logging_configuration.ellipsis
-  end
+    def debug_colorized_chain_for_class=(colorized_chain_for_class)
+      @debug_logging_configuration.colorized_chain_for_class = colorized_chain_for_class
+    end
+
+    def debug_add_invocation_id
+      @debug_logging_configuration.add_invocation_id
+    end
 
-  def debug_ellipsis=(ellipsis)
-    @debug_logging_configuration.ellipsis = ellipsis
+    def debug_add_invocation_id=(add_invocation_id)
+      @debug_logging_configuration.add_invocation_id = add_invocation_id
+    end
+
+    def debug_ellipsis
+      @debug_logging_configuration.ellipsis
+    end
+
+    def debug_ellipsis=(ellipsis)
+      @debug_logging_configuration.ellipsis = ellipsis
+    end
+
+    def debug_mark_scope_exit
+      @debug_logging_configuration.mark_scope_exit
+    end
+
+    def debug_mark_scope_exit=(mark_scope_exit)
+      @debug_logging_configuration.mark_scope_exit = mark_scope_exit
+    end
+
+    def debug_add_payload
+      @debug_logging_configuration.add_payload
+    end
+
+    def debug_add_payload=(add_payload)
+      @debug_logging_configuration.add_payload = add_payload
+    end
+
+    def debug_payload_max_length
+      @debug_logging_configuration.payload_max_length
+    end
+
+    def debug_payload_max_length=(payload_max_length)
+      @debug_logging_configuration.payload_max_length = payload_max_length
+    end
+
+    def debug_error_handler_proc
+      @debug_logging_configuration.error_handler_proc
+    end
+
+    def debug_error_handler_proc=(error_handler_proc)
+      @debug_logging_configuration.error_handler_proc = error_handler_proc
+    end
   end
+
   self.debug_logging_configuration = Configuration.new # setup defaults
 end

data/lib/debug_logging/argument_printer.rb

@@ -2,7 +2,7 @@
 
 module DebugLogging
   module ArgumentPrinter
-    def debug_benchmark_to_s(tms: nil)
+    def debug_benchmark_to_s(tms:)
       "completed in #{format('%f', tms.real)}s (#{format('%f', tms.total)}s CPU)"
     end
 
@@ -45,49 +45,90 @@ module DebugLogging
 
       add_args_ellipsis = false
       if config_proxy.debug_last_hash_to_s_proc && args[-1].is_a?(Hash)
-        add_last_hash_ellipsis = false
+        add_other_args_ellipsis = false
         if args.length > 1
           if config_proxy.debug_multiple_last_hashes
             last_hash_args, other_args = args.partition do |arg|
               arg.is_a?(Hash)
             end
-            other_args_string = other_args.map(&:inspect).join(', ')[0..(config_proxy.debug_args_max_length)]
+            other_args_string = if config_proxy.debug_args_to_s_proc
+                                  printed, add_other_args_ellipsis = debug_safe_proc(
+                                    proc_name:'args_to_s_proc',
+                                    proc: config_proxy.debug_args_to_s_proc,
+                                    args: other_args,
+                                    max_length: config_proxy.debug_args_max_length
+                                  )
+                                  printed
+                                else
+                                  other_args.map(&:inspect).join(', ').tap do |x|
+                                    add_other_args_ellipsis = x.length > config_proxy.debug_args_max_length
+                                  end[0..(config_proxy.debug_args_max_length)]
+                                end
+            other_args_string += config_proxy.debug_ellipsis if add_other_args_ellipsis
             # On the debug_multiple_last_hashes truthy branch we don't print the ellipsis after regular args
-            #   because it will go instead after the last hash (if needed)
+            #   because it will go instead after each of the last hashes (if needed)
             #   ...join(", ").tap {|x| _add_args_ellipsis = x.length > config_proxy.debug_args_max_length}
             last_hash_args_string = last_hash_args.map do |arg|
               arr = []
-              arr << config_proxy.debug_last_hash_to_s_proc.call(arg).to_s
-                                 .tap do |x|
-                add_last_hash_ellipsis = x.length > config_proxy.debug_last_hash_max_length
-              end
-              if add_last_hash_ellipsis
-                arr[-1] = arr[-1][0..(config_proxy.debug_last_hash_max_length)]
-                arr << config_proxy.debug_ellipsis
-              end
+              printed, add_last_hash_ellipsis = debug_safe_proc(
+                proc_name:'last_hash_to_s_proc',
+                proc: config_proxy.debug_last_hash_to_s_proc,
+                args: arg,
+                max_length: config_proxy.debug_last_hash_max_length
+              )
+              printed += config_proxy.debug_ellipsis if add_last_hash_ellipsis
+              arr << printed
               arr
             end.flatten.join(', ')
             printed_args += other_args_string if other_args_string
             printed_args += ', ' if !other_args_string.empty? && !last_hash_args_string.empty?
             printed_args += last_hash_args_string if last_hash_args_string && !last_hash_args_string.empty?
           else
-            printed_args += args[0..-2].map(&:inspect).join(', ').tap do |x|
-                              add_args_ellipsis = x.length > config_proxy.debug_args_max_length
-                            end [0..(config_proxy.debug_args_max_length)]
-            printed_args += config_proxy.debug_ellipsis if add_args_ellipsis
-            printed_args += ", #{config_proxy.debug_last_hash_to_s_proc.call(args[-1]).tap do |x|
-                                   add_last_hash_ellipsis = x.length > config_proxy.debug_last_hash_max_length
-                                 end [0..(config_proxy.debug_last_hash_max_length)]}"
+            other_args = args[0..-2]
+            other_args_string = if config_proxy.debug_args_to_s_proc
+                                  printed, add_other_args_ellipsis = debug_safe_proc(
+                                    proc_name:'args_to_s_proc',
+                                    proc: config_proxy.debug_args_to_s_proc,
+                                    args: other_args,
+                                    max_length: config_proxy.debug_args_max_length
+                                  )
+                                  printed
+                                else
+                                  other_args.map(&:inspect).join(', ').tap do |x|
+                                    add_other_args_ellipsis = x.length > config_proxy.debug_args_max_length
+                                  end[0..(config_proxy.debug_args_max_length)]
+                                end
+            other_args_string += config_proxy.debug_ellipsis if add_other_args_ellipsis
+            printed_args += other_args_string
+            printed, add_last_hash_ellipsis = debug_safe_proc(
+              proc_name:'last_hash_to_s_proc',
+              proc: config_proxy.debug_last_hash_to_s_proc,
+              args: args[-1],
+              max_length: config_proxy.debug_last_hash_max_length
+            )
+            printed_args += ", #{printed}"
             printed_args += config_proxy.debug_ellipsis if add_last_hash_ellipsis
           end
         else
-          printed_args += String(config_proxy.debug_last_hash_to_s_proc.call(args[0])).tap do |x|
-                            add_last_hash_ellipsis = x.length > config_proxy.debug_last_hash_max_length
-                          end [0..(config_proxy.debug_last_hash_max_length)]
+          printed, add_last_hash_ellipsis = debug_safe_proc(
+            proc_name:'last_hash_to_s_proc',
+            proc: config_proxy.debug_last_hash_to_s_proc,
+            args: args[0],
+            max_length: config_proxy.debug_last_hash_max_length
+          )
+          printed_args += printed
           printed_args += config_proxy.debug_ellipsis if add_last_hash_ellipsis
         end
       else
-        printed_args += if args.length == 1 && args[0].is_a?(Hash)
+        printed_args += if config_proxy.debug_args_to_s_proc
+                          printed, add_args_ellipsis = debug_safe_proc(
+                            proc_name:'args_to_s_proc',
+                            proc: config_proxy.debug_args_to_s_proc,
+                            args: args,
+                            max_length: config_proxy.debug_args_max_length
+                          )
+                          printed
+                        elsif args.length == 1 && args[0].is_a?(Hash)
                           # handle double splat
                           ("**#{args.map(&:inspect).join(', ').tap do |x|
                                   add_args_ellipsis = x.length > config_proxy.debug_args_max_length
@@ -95,13 +136,26 @@ module DebugLogging
                         else
                           args.map(&:inspect).join(', ').tap do |x|
                             add_args_ellipsis = x.length > config_proxy.debug_args_max_length
-                          end [0..(config_proxy.debug_args_max_length)]
+                          end[0..(config_proxy.debug_args_max_length)]
                         end
         printed_args += config_proxy.debug_ellipsis if add_args_ellipsis
       end
       "(#{printed_args})"
     end
 
+    def debug_safe_proc(proc_name:, proc:, args:, max_length:)
+      max_length ||= 1000 # can't be nil
+      begin
+        add_ellipsis = false
+        printed = String(proc.call(args)).tap do |x|
+          add_ellipsis = x.length > max_length
+        end[0..(max_length)]
+        return printed, add_ellipsis
+      rescue => e
+        return "#{e.class}: #{e.message}\nPlease check that your #{proc_name} is able to handle #{args}", false
+      end
+    end
+
     def debug_payload_to_s(payload: nil, config_proxy: nil)
       return '' unless payload && config_proxy
 
@@ -110,7 +164,16 @@ module DebugLogging
         when true
           payload.inspect
         else
-          config_proxy.debug_add_payload.call(**payload)
+          printed_payload = ""
+          printed, add_payload_ellipsis = debug_safe_proc(
+            proc_name: "add_payload",
+            proc: config_proxy.debug_add_payload,
+            args: payload,
+            max_length: config_proxy.payload_max_length
+          )
+          printed_payload += printed
+          printed_payload += config_proxy.debug_ellipsis if add_payload_ellipsis
+          printed_payload
         end
       else
         ''