slack_log_device 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a08add8ca43ec8b2845e209f84db5451c80b05f3
-  data.tar.gz: 7d9b8604965d71003b13035b4760c38314c58420
+  metadata.gz: 31f35ecd773a685a25208243fbbcb1e2b805215f
+  data.tar.gz: 28b565110cf143e6feee787d7d6ef113466f71da
 SHA512:
-  metadata.gz: 05903e2015b349a16066c6f9aa4f5413f09d53573931f51b9b6efa5ed6108be2816ced145a668246223e6a5a7cd314fc5a04d178d40aee24dbf8aab06dcfcce5
-  data.tar.gz: 49374c1e5993469d1a1c2e7f80a0ec2d8bfb5b443babb7b2e6768ddf36152e8618a759cfc73b15c75eaeb99cdded92aa95ce3383791a546390658304f3f2c66d
+  metadata.gz: 0d9adc9fd2299c95b90a454c7130081bd08f7b5908d5a620f5eaaee5ccac3c1b9ddb3ff7153c58c7ade3b01ee5319f3393a36830366d0514dea12c2187cee974
+  data.tar.gz: 7237cd552536ed52d1c784575d1550d639e85d81ca948d1a1a063ad142f4ac7d69aa8a81acd30d9f80eb777b20382cc7937208e6681095359823a1d58208c0cb

data/README.mdown

@@ -43,6 +43,8 @@ default).
 
 ## Formatter
 
+### Usage
+
 `slack_log_device` provides a log formatter to have a pretty output for slack.
 It can be configured like this:
 
@@ -50,6 +52,8 @@ It can be configured like this:
 logger.formatter = SlackLogDevice.formatter
 ```
 
+### Converting message
+
 `SlackLogDevice.formatter` method also accepts block to transform logged
 message, example:
 
@@ -57,6 +61,8 @@ message, example:
 logger.formatter = SlackLogDevice.formatter { |message| message.reverse }
 ```
 
+### Metadata
+
 You can also add custom metadata to message sent to slack, here is how to do
 it:
 
@@ -67,6 +73,20 @@ logger.formatter = SlackLogDevice.formatter(extra_metadata: {
 })
 ```
 
+### Backtrace
+
+Exception backtrace is automatically stripped to `10` lines. You can change
+this behavior via `:max_backtrace_lines`:
+
+```ruby
+logger.formatter = SlackLogDevice.formatter(max_backtrace_lines: 50)
+```
+
+- A value of `0` will not print backtrace.
+- A value of `-1` will not strip backtrace.
+
+### Rails metadata
+
 If you use [Ruby on Rails](http://rubyonrails.org/), you will get some
 metadata like current HTTP method, URL, remote address and User-Agent (see
 Rails configuration section).

data/VERSION

@@ -1 +1 @@
-4.1.0
+4.2.0

data/lib/slack_log_device.rb

@@ -8,8 +8,8 @@ class SlackLogDevice
   attr_reader :channel, :flush_delay, :max_buffer_size, :timeout, :username, :webhook_url
 
   def self.enable_rails_logging!
-    require 'slack_log_device/debug_exceptions'
-    require 'slack_log_device/set_request_in_thread'
+    require "#{__dir__}/slack_log_device/debug_exceptions"
+    require "#{__dir__}/slack_log_device/set_request_in_thread"
     ActionDispatch::DebugExceptions.prepend(SlackLogDevice::DebugExceptions)
     Rails.application.config.middleware.insert_before(Rails::Rack::Logger, SlackLogDevice::SetRequestInThread)
     true
@@ -123,4 +123,4 @@ class SlackLogDevice
 
 end
 
-require 'slack_log_device/formatter'
+require "#{__dir__}/slack_log_device/formatter"

data/lib/slack_log_device/formatter.rb

@@ -4,11 +4,12 @@ class SlackLogDevice
 
     MAX_MESSAGE_LENGTH = 4000
 
-    attr_reader :extra_metadata
+    attr_reader :extra_metadata, :max_backtrace_lines
 
     def initialize(options = {}, &block)
-      options.assert_valid_keys(:extra_metadata)
-      @extra_metadata = options.key?(:extra_metadata) ? options[:extra_metadata] : {}
+      options.assert_valid_keys(:extra_metadata, :max_backtrace_lines)
+      self.extra_metadata = options.key?(:extra_metadata) ? options[:extra_metadata] : {}
+      self.max_backtrace_lines = options.key?(:max_backtrace_lines) ? options[:max_backtrace_lines] : 10
       @message_converter = block_given? ? Proc.new(&block) : -> (message) { message }
     end
 
@@ -71,10 +72,21 @@ class SlackLogDevice
       metadata
     end
 
+    def extra_metadata=(value)
+      @extra_metadata = value.presence || {}
+    end
+
     def format_backtrace(exception, size_available)
-      backtrace = exception.backtrace.try(:join, "\n")
-      return nil if backtrace.blank? || size_available < 7
-      "```#{truncate(backtrace, size_available - 6)}```"
+      return nil if max_backtrace_lines == 0 || size_available < 7
+      backtrace = (exception.backtrace || []).select(&:present?).compact
+      return nil if backtrace.empty?
+      if max_backtrace_lines < 0
+        text = backtrace.join("\n")
+      else
+        text = backtrace[0, max_backtrace_lines].join("\n")
+        text << "\n..." if backtrace.size > max_backtrace_lines
+      end
+      "```#{truncate(text, size_available - 6)}```"
     end
 
     def format_metadata(message, size_available)
@@ -91,6 +103,12 @@ class SlackLogDevice
       truncate(text, size_available)
     end
 
+    def max_backtrace_lines=(value)
+      length = Integer(value) rescue nil
+      raise ArgumentError.new("Invalid max backtrace lines: #{value.inspect}") if length.nil? || length < -1
+      @max_backtrace_lines = length
+    end
+
     def truncate(message, max_length = MAX_MESSAGE_LENGTH)
       message = message.strip
       return message if message.size <= max_length

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_log_device
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Alexis Toulotte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2017-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport