slack_log_device 5.0.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7b2d241f21d1b8ba8cfffcc91a953e49cdcc8749c4e5a928c28122bfd182727
-  data.tar.gz: 94d57be944548bcfc9ec35cd4c7fb15b3ca9d9d9c7f008cce786305229cb91bc
+  metadata.gz: 3aa26183c60229ce1a1102f4392082150a585cfc57f637e2241596ce4bb4f289
+  data.tar.gz: 862b27ad34b7c77c5c8fd4f3d04a0228420462f3ebd2cf77593af8c8e044f673
 SHA512:
-  metadata.gz: 40db4fc21132cf83a3d8a3bdf302ce2caecf21533e3a2e9e453eae3a9b0437518c6d76cab9357d6ea7b264fa534b42524e37081100f4d2bbfab670dc2eb46a36
-  data.tar.gz: c4e2605ca62508a47a1d1136cc65cc39973e1f36cd6317f0ea4b0f577b59e4d332dbc19f0415b1d9b0a59704144a155c0d10b75c70359c150ffccd988ac37e0c
+  metadata.gz: 0d6460466cd2b2e71b43a8db275105fd36d6d92e7dcac1b4a2f8935f27f6ea1eeeacdbafa9cb9827dd914f07369e499f924c79d60a9dca898813ec8461650b94
+  data.tar.gz: 95f9bf541bc5c76be65e876d6c7cb1dde41f66e381da3fcf6693e56e0100f9bb0d60fa07f64aa1940fce85efdd67b280f82fa465796c4cec21db68b3c1c4d815

data/README.mdown

@@ -34,8 +34,6 @@ by default).
 - `channel`: The channel to post message on (webhook configured channel by
 default). It can be a channel (if starting with `#`) or a specific user (if
 starting with a `@`).
-- `disable_default_metadata`: `true` to disable default metadata (User,
-  Machine and PID). This is `false` (enabled) by default.
 - `flush_delay`: The delay in seconds to send buffered messages (1 by
   default).
 - `max_buffer_size`: The max messages count to flush them (10 messages by
@@ -72,6 +70,9 @@ By default, formatter adds those metadata:
 - `User`: The current user (`ENV['USER']`).
 - `Machine`: The machine name (`hostname`).
 
+To disable default metadata (User, Machine and PID), set
+`disable_default_metadata` formatter option to `true`.
+
 You can also add custom metadata to message sent to slack, here is how to do
 it:
 
@@ -107,6 +108,21 @@ If you need more, use `:extra_metadata` option. Note that blocks specified
 with `:extra_metadata` option are invoked with options that may contains
 `:request` option (if present).
 
+### Icon emojis
+
+By default, there is a different icon emoji for each logging severity level.
+But, it can be configured:
+
+```ruby
+logger.formatter = SlackLogDevice.formatter(max_backtrace_lines: 50, icon_emojis: { fatal: ':metal:', warn: ':skull:' })
+```
+
+Or for all severity levels:
+
+```ruby
+logger.formatter = SlackLogDevice.formatter(max_backtrace_lines: 50, icon_emoji: ':metal:')
+```
+
 ## Rails configuration
 
 For a rails application, it is recommanded to use following configuration into

data/VERSION

@@ -1 +1 @@
-5.0.0
+5.1.0

data/lib/slack_log_device.rb

@@ -54,13 +54,15 @@ class SlackLogDevice
 
   def flush
     while !@buffer.empty? do
-      message = ''
+      message = nil
       @mutex.synchronize do
         message = @buffer.pop
       end
-      next if message.blank?
-      data = { 'text' => message.to_s }
+      text = message.to_s.strip
+      next if text.empty?
+      data = { 'text' => text }
       data['channel'] = channel if channel.present?
+      data['icon_emoji'] = message.icon_emoji if message.respond_to?(:icon_emoji) && message.icon_emoji.present?
       data['username'] = username if username.present?
       begin
         HTTParty.post(webhook_url, body: data.to_json, headers: { 'Content-Type' => 'application/json' }, timeout: timeout)
@@ -105,7 +107,6 @@ class SlackLogDevice
   end
 
   def write(message)
-    message = message.to_s.try(:strip)
     return if message.blank?
     @mutex.synchronize do
       @buffer << message

data/lib/slack_log_device/formatter.rb

@@ -2,15 +2,28 @@ class SlackLogDevice
 
   class Formatter
 
+    DEFAULT_ICON_EMOJIS = {
+      'DEBUG' => ':bug:',
+      'INFO' => ':information_source:',
+      'WARN' => ':warning:',
+      'ERROR' => ':x:',
+      'FATAL' => ':fire:',
+      'UNKNOWN' => ':interrobang:',
+    }.freeze
     MAX_MESSAGE_LENGTH = 4000
 
     attr_reader :extra_metadata, :max_backtrace_lines
 
     def initialize(options = {}, &block)
-      options.assert_valid_keys(:disable_default_metadata, :extra_metadata, :max_backtrace_lines)
+      options.assert_valid_keys(:disable_default_metadata, :extra_metadata, :icon_emoji, :icon_emojis, :max_backtrace_lines)
+      self.disable_default_metadata = options[:disable_default_metadata]
       self.extra_metadata = options.key?(:extra_metadata) ? options[:extra_metadata] : {}
       self.max_backtrace_lines = options.key?(:max_backtrace_lines) ? options[:max_backtrace_lines] : 10
-      @disable_default_metadata = options[:disable_default_metadata].present?
+
+      @icon_emojis = DEFAULT_ICON_EMOJIS.dup
+      self.icon_emojis = options[:icon_emojis] if options.key?(:icon_emojis)
+      self.icon_emoji = options[:icon_emoji] if options.key?(:icon_emoji)
+
       @message_converter = block_given? ? Proc.new(&block) : -> (message) { message }
     end
 
@@ -29,11 +42,47 @@ class SlackLogDevice
         text << " #{convert_message(message)}".rstrip
         text = append_metadata(text, message)
       end
-      truncate(text)
+      Message.new(truncate(text), icon_emoji: icon_emoji(severity))
+    end
+
+    def disable_default_metadata=(value)
+      @disable_default_metadata = value.present?
     end
 
     def disable_default_metadata?
-      @disable_default_metadata.present?
+      @disable_default_metadata
+    end
+
+    def extra_metadata=(value)
+      @extra_metadata = (value.presence || {})
+    end
+
+    def icon_emoji(severity)
+      @icon_emojis[parse_severity(severity)]
+    end
+
+    def icon_emoji=(value)
+      value = value.to_s.strip.presence
+      @icon_emojis.keys.each do |severity|
+        @icon_emojis[severity] = value
+      end
+    end
+
+    def icon_emojis
+      @icon_emojis.freeze
+    end
+
+    def icon_emojis=(values = {})
+      values.each do |severity, emoji|
+        @icon_emojis[parse_severity(severity)] = emoji.to_s.strip.presence
+      end
+      @icon_emojis
+    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
 
     private
@@ -83,10 +132,6 @@ class SlackLogDevice
       metadata
     end
 
-    def extra_metadata=(value)
-      @extra_metadata = value.presence || {}
-    end
-
     def format_backtrace(exception, size_available)
       return nil if max_backtrace_lines == 0 || size_available < 7
       backtrace = (exception.backtrace || []).select(&:present?).compact
@@ -114,10 +159,10 @@ 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
+    def parse_severity(value)
+      severity = value.to_s.strip.upcase
+      return severity if DEFAULT_ICON_EMOJIS.key?(severity)
+      raise("Invalid log severity: #{value.inspect}")
     end
 
     def truncate(message, max_length = MAX_MESSAGE_LENGTH)
@@ -130,3 +175,5 @@ class SlackLogDevice
   end
 
 end
+
+require "#{__dir__}/formatter/message"

data/lib/slack_log_device/formatter/message.rb

@@ -0,0 +1,22 @@
+class SlackLogDevice
+
+  class Formatter
+
+    class Message < String
+
+      attr_reader :icon_emoji
+
+      def initialize(text, icon_emoji: nil)
+        super(text)
+        self.icon_emoji = icon_emoji
+      end
+
+      def icon_emoji=(value)
+        @icon_emoji = value.presence.try(&:strip)
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_log_device
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Alexis Toulotte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-29 00:00:00.000000000 Z
+date: 2018-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -122,6 +122,7 @@ files:
 - lib/slack_log_device.rb
 - lib/slack_log_device/debug_exceptions.rb
 - lib/slack_log_device/formatter.rb
+- lib/slack_log_device/formatter/message.rb
 - lib/slack_log_device/set_request_in_thread.rb
 - slack_log_device.gemspec
 homepage: https://github.com/alexistoulotte/slack_log_device