slack_log_device 4.2.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 31f35ecd773a685a25208243fbbcb1e2b805215f
-  data.tar.gz: 28b565110cf143e6feee787d7d6ef113466f71da
+SHA256:
+  metadata.gz: b7b2d241f21d1b8ba8cfffcc91a953e49cdcc8749c4e5a928c28122bfd182727
+  data.tar.gz: 94d57be944548bcfc9ec35cd4c7fb15b3ca9d9d9c7f008cce786305229cb91bc
 SHA512:
-  metadata.gz: 0d9adc9fd2299c95b90a454c7130081bd08f7b5908d5a620f5eaaee5ccac3c1b9ddb3ff7153c58c7ade3b01ee5319f3393a36830366d0514dea12c2187cee974
-  data.tar.gz: 7237cd552536ed52d1c784575d1550d639e85d81ca948d1a1a063ad142f4ac7d69aa8a81acd30d9f80eb777b20382cc7937208e6681095359823a1d58208c0cb
+  metadata.gz: 40db4fc21132cf83a3d8a3bdf302ce2caecf21533e3a2e9e453eae3a9b0437518c6d76cab9357d6ea7b264fa534b42524e37081100f4d2bbfab670dc2eb46a36
+  data.tar.gz: c4e2605ca62508a47a1d1136cc65cc39973e1f36cd6317f0ea4b0f577b59e4d332dbc19f0415b1d9b0a59704144a155c0d10b75c70359c150ffccd988ac37e0c

data/README.mdown

@@ -34,7 +34,10 @@ 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 `@`).
-- `flush_delay`: The delay in seconds to send buffered messages (1 by default).
+- `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
 default).
 - `timeout`: The timeout in seconds to send message to slack (5 by default).
@@ -63,16 +66,25 @@ logger.formatter = SlackLogDevice.formatter { |message| message.reverse }
 
 ### Metadata
 
+By default, formatter adds those metadata:
+
+- `PID`: The current process id.
+- `User`: The current user (`ENV['USER']`).
+- `Machine`: The machine name (`hostname`).
+
 You can also add custom metadata to message sent to slack, here is how to do
 it:
 
 ```ruby
 logger.formatter = SlackLogDevice.formatter(extra_metadata: {
-  'User' => -> (options) { ENV['USER'] },
-  'Machine' => `uname -a`,
+  'Exception class' => -> (options) { options[:exception].class.name },
+  'System' => `uname -a`,
 })
 ```
 
+As you can see, blocks (invoked with options contains `request` and
+`exception`) are supported.
+
 ### Backtrace
 
 Exception backtrace is automatically stripped to `10` lines. You can change

data/VERSION

@@ -1 +1 @@
-4.2.0
+5.0.0

data/lib/slack_log_device.rb

@@ -2,6 +2,7 @@ require 'active_support/core_ext/hash'
 require 'active_support/core_ext/string'
 require 'httparty'
 require 'logger'
+require 'socket'
 
 class SlackLogDevice
 

data/lib/slack_log_device/formatter.rb

@@ -7,9 +7,10 @@ class SlackLogDevice
     attr_reader :extra_metadata, :max_backtrace_lines
 
     def initialize(options = {}, &block)
-      options.assert_valid_keys(:extra_metadata, :max_backtrace_lines)
+      options.assert_valid_keys(:disable_default_metadata, :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
+      @disable_default_metadata = options[:disable_default_metadata].present?
       @message_converter = block_given? ? Proc.new(&block) : -> (message) { message }
     end
 
@@ -31,6 +32,10 @@ class SlackLogDevice
       truncate(text)
     end
 
+    def disable_default_metadata?
+      @disable_default_metadata.present?
+    end
+
     private
 
     def append_exception_backtrace(text, exception)
@@ -58,16 +63,22 @@ class SlackLogDevice
     end
 
     def default_metadata(request)
-      return {} if request.blank?
-      metadata = {
+      metadata = {}
+      return metadata if disable_default_metadata?
+      metadata.merge!({
         'Method' => request.method,
         'URL' => request.url,
         'Remote address' => request.remote_addr,
         'User-Agent' => request.user_agent,
-      }
+      }) if request.present?
+      metadata.merge!({
+        'User' => ENV['USER'],
+        'Machine' => Socket.gethostname,
+        'PID' => Process.pid,
+      })
       metadata.keys.each do |key|
         value = metadata[key]
-        metadata[key] = "`#{value.strip}`" if value.present?
+        metadata[key] = "`#{value.to_s.strip}`" if value.present?
       end
       metadata
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_log_device
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Alexis Toulotte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-09 00:00:00.000000000 Z
+date: 2018-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -144,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: LogDevice for Slack