slack_log_device 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7da84e6d177382ef3698ba25b1cafddfd7e41e9d
-  data.tar.gz: 9643a365bff66ea7ea8219d38c73dcad7166185e
+  metadata.gz: 2b8c2c4a011a4ba09610beb398cfb992ed65a2f7
+  data.tar.gz: 9499a0f40302d799977eeca879cdc1746cb557b5
 SHA512:
-  metadata.gz: a25cdda1fa68d846b11405ade1d656b0b0d349db2faa3c798290643ae58e78cd878e81eec53cfb204ceececdfc2a31a75b1561d8394d1450cf29f05e0e552f32
-  data.tar.gz: 44c2fda8c1c618aee82cd46fc6a6bf48445826290048fd269817da57daa34ddbc54a9e4a954e99069f35c794f628a111e86b26a0a120b2b6cadd4eaf4c751aaa
+  metadata.gz: 517127197dfe3563a572c58c3b5ad7a628c8773fd29baada89188d6b0a37ebbe0ed80a6e9728881216801de9868dcc4746766fbcab54d9b442065a04c172f35e
+  data.tar.gz: b89dfd5dfca5b6fbcc1549a7527f7e5f763b228c6cf9db86221e93674043f0a078ed2a13323d44cfecf6405acc7fb4045343d5fa179fa0d3de1cdd13a338f47f

data/README.mdown

@@ -35,7 +35,8 @@ by default).
 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).
-- `max_buffer_size`: The max buffer size to flush messages (8192 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).
 - `username`: The username to post message as (nil by default).
 - `webhook_url`: The URL of the webhook (mandatory).
@@ -56,17 +57,39 @@ message, example:
 logger.formatter = SlackLogDevice.formatter { |message| message.reverse }
 ```
 
+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`,
+})
+```
+
+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).
+
+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).
+
 ## Rails configuration
 
 For a rails application, it is recommanded to use following configuration into
 `config/environments/production.rb` file:
 
 ```ruby
+SlackLogDevice.enable_rails_logging!
 config.logger = ActiveSupport::Logger.new(SlackLogDevice.new(webhook_url: 'https://hooks.slack.com/services/...', username: 'MyRailsApp'))
 config.logger.formatter = SlackLogDevice::FORMATTER
 config.log_level = :warn
 ```
 
+`SlackLogDevice.enable_rails_logging!` instruction put current request into
+thread in order to make it available by slack formatter.
+
 ## Executing test suite
 
 This project is fully tested with [Rspec 3](http://github.com/rspec/rspec).

data/VERSION

@@ -1 +1 @@
-3.0.0
+4.0.0

data/lib/slack_log_device.rb

@@ -7,19 +7,26 @@ 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'
+    ActionDispatch::DebugExceptions.prepend(SlackLogDevice::DebugExceptions)
+    Rails.application.config.middleware.insert_before(Rails::Rack::Logger, SlackLogDevice::SetRequestInThread)
+    true
+  end
+
   def self.formatter(options = {}, &block)
     Formatter.new(options, &block)
   end
 
   def initialize(options = {})
     options.assert_valid_keys(:auto_flush, :channel, :flush_delay, :max_buffer_size, :timeout, :username, :webhook_url)
-    @buffer = ''
+    @buffer = []
     @mutex = Mutex.new
-    @flush_thread
     self.auto_flush = options[:auto_flush]
     self.channel = options[:channel]
     self.flush_delay = options.key?(:flush_delay) ? options[:flush_delay] : 1
-    self.max_buffer_size = options.key?(:max_buffer_size) ? options[:max_buffer_size] : 1024 * 128
+    self.max_buffer_size = options.key?(:max_buffer_size) ? options[:max_buffer_size] : 10
     self.timeout = options.key?(:timeout) ? options[:timeout] : 5
     self.username = options[:username]
     self.webhook_url = options[:webhook_url]
@@ -44,25 +51,25 @@ class SlackLogDevice
   end
 
   def flush
-    return if @buffer.empty?
-    message = ''
-    @mutex.synchronize do
-      message = @buffer
-      @buffer = ''
-    end
-    data = { 'text' => message.to_s }
-    data['channel'] = channel if channel.present?
-    data['username'] = username if username.present?
-    begin
-      HTTParty.post(webhook_url, body: data.to_json, headers: { 'Content-Type' => 'application/json' }, timeout: timeout)
-    rescue Exception => e
-      STDERR.puts(e)
+    while !@buffer.empty? do
+      message = ''
+      @mutex.synchronize do
+        message = @buffer.pop
+      end
+      data = { 'text' => message.to_s }
+      data['channel'] = channel if channel.present?
+      data['username'] = username if username.present?
+      begin
+        HTTParty.post(webhook_url, body: data.to_json, headers: { 'Content-Type' => 'application/json' }, timeout: timeout)
+      rescue Exception => e
+        STDERR.puts(e)
+      end
     end
     nil
   end
 
   def flush?
-    auto_flush? || flush_delay.zero? || @buffer.bytesize > max_buffer_size || @buffer.include?('```')
+    auto_flush? || flush_delay.zero? || @buffer.size > max_buffer_size
   end
 
   def flush_delay=(value)
@@ -98,7 +105,6 @@ class SlackLogDevice
     message = message.to_s.try(:strip)
     return if message.blank?
     @mutex.synchronize do
-      @buffer << "\n" unless @buffer.empty?
       @buffer << message
     end
     @flush_thread.kill if @flush_thread
@@ -115,9 +121,4 @@ class SlackLogDevice
 
 end
 
-require 'slack_log_device/rails_exceptions_logging'
 require 'slack_log_device/formatter'
-
-if defined?(ActionDispatch::DebugExceptions)
-  ActionDispatch::DebugExceptions.prepend(SlackLogDevice::RailsExceptionsLogging)
-end

data/lib/slack_log_device/{rails_exceptions_logging.rb → debug_exceptions.rb}

@@ -1,6 +1,6 @@
 class SlackLogDevice
 
-  module RailsExceptionsLogging
+  module DebugExceptions
 
     def log_error(request, wrapper)
       logger = logger(request)

data/lib/slack_log_device/formatter.rb

@@ -72,7 +72,7 @@ class SlackLogDevice
       return nil if size_available < 11
       options = {}
       options[:exception] = message if message.is_a?(Exception)
-      request = options[:exception].present? ? options[:exception].instance_variable_get(:@__slack_log_device_request) : nil
+      request = Thread.current[:slack_log_device_request]
       options[:request] = request if request.present?
       text = default_metadata(request).merge(extra_metadata).map do |name, value|
         value = value.call(options) if value.respond_to?(:call)

data/lib/slack_log_device/set_request_in_thread.rb

@@ -0,0 +1,18 @@
+require 'action_dispatch/http/request'
+
+class SlackLogDevice
+
+  class SetRequestInThread
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      Thread.current[:slack_log_device_request] = ActionDispatch::Request.new(env)
+      @app.call(env)
+    end
+
+  end
+
+end

data/spec/slack_log_device/formatter_spec.rb

@@ -237,12 +237,20 @@ describe SlackLogDevice::Formatter do
 
     end
 
-    context 'with an exception with @__slack_log_device_request set' do
+    context 'with request set in current thread' do
 
-      let(:exception) { RuntimeError.new('BAM!').tap { |e| e.instance_variable_set(:@__slack_log_device_request, request) } }
+      let(:exception) { RuntimeError.new('BAM!') }
       let(:formatter) { SlackLogDevice::Formatter.new }
       let(:request) { double(remote_addr: '127.0.0.1', user_agent: 'Mozilla', method: 'GET', url: 'http://google.com') }
 
+      before :each do
+        Thread.current[:slack_log_device_request] = request
+      end
+
+      after :each do
+        Thread.current[:slack_log_device_request] = nil
+      end
+
       it 'logs metadata' do
         expect(formatter.call('DEBUG', Time.now, nil, exception)).to eq("*`DEBUG`*: A `RuntimeError` occurred: BAM!\n\n• *Method*: `GET`\n• *URL*: `http://google.com`\n• *Remote address*: `127.0.0.1`\n• *User-Agent*: `Mozilla`")
       end

data/spec/slack_log_device_spec.rb

@@ -146,7 +146,7 @@ describe SlackLogDevice do
     it 'flushes all message writen separated by a new line' do
       device.write('BAM!')
       device.write('BIM!')
-      expect(HTTParty).to receive(:post).with(options[:webhook_url], body: { 'text' => "BAM!\nBIM!", 'username' => options[:username] }.to_json, headers: { 'Content-Type' => 'application/json' }, timeout: 5)
+      expect(HTTParty).to receive(:post).twice
       device.flush
     end
 
@@ -160,7 +160,7 @@ describe SlackLogDevice do
       device.write('BIM!')
       expect {
         device.flush
-      }.to change { device.instance_variable_get(:@buffer) }.to('')
+      }.to change { device.instance_variable_get(:@buffer) }.to([])
       expect(HTTParty).not_to receive(:post)
       device.flush
     end
@@ -170,18 +170,11 @@ describe SlackLogDevice do
   describe '#flush?' do
 
     it 'is true if max_buffer_size is reached' do
-      options[:max_buffer_size] = 10
-      device.write('0123456789')
+      options[:max_buffer_size] = 2
+      device.write('hello')
+      device.write('world')
       expect {
-        device.instance_variable_get(:@buffer).send(:<<, 'a')
-      }.to change { device.flush? }.from(false).to(true)
-    end
-
-    it 'use byte size to compare max_buffer_size' do
-      options[:max_buffer_size] = 10
-      device.write('01234567é')
-      expect {
-        device.instance_variable_get(:@buffer).send(:<<, 'a')
+        device.instance_variable_get(:@buffer).send(:<<, 'foo')
       }.to change { device.flush? }.from(false).to(true)
     end
 
@@ -197,12 +190,6 @@ describe SlackLogDevice do
       }.to change { device.flush? }.from(false).to(true)
     end
 
-    it 'is true if it contains markdown code block' do
-      expect {
-        device.instance_variable_get(:@buffer).send(:<<, '```hello world```')
-      }.to change { device.flush? }.from(false).to(true)
-    end
-
   end
 
   describe '#flush_delay' do
@@ -279,8 +266,8 @@ describe SlackLogDevice do
 
   describe '#max_buffer_size' do
 
-    it 'is 128 kilobytes by default' do
-      expect(device.max_buffer_size).to eq(1024 * 128)
+    it 'is 10 by default' do
+      expect(device.max_buffer_size).to eq(10)
     end
 
     it 'can be specified' do
@@ -327,8 +314,8 @@ describe SlackLogDevice do
 
     it 'can be set' do
       expect {
-        device.max_buffer_size = 1024
-      }.to change { device.max_buffer_size }.from(1024 * 128).to(1024)
+        device.max_buffer_size = 42
+      }.to change { device.max_buffer_size }.from(10).to(42)
     end
 
   end
@@ -466,19 +453,19 @@ describe SlackLogDevice do
 
     it 'strips message' do
       device.write("     BAM  !\n")
-      expect(device.instance_variable_get(:@buffer)).to eq('BAM  !')
+      expect(device.instance_variable_get(:@buffer)).to eq(['BAM  !'])
     end
 
     it 'converts message to string' do
       device.write(42)
-      expect(device.instance_variable_get(:@buffer)).to eq('42')
+      expect(device.instance_variable_get(:@buffer)).to eq(['42'])
     end
 
-    it 'adds given string to existing buffer with a \n' do
+    it 'adds given string to existing buffer with a two \n' do
       device.write('BAM!')
       expect {
         device.write('BIM!')
-      }.to change { device.instance_variable_get(:@buffer) }.from('BAM!').to("BAM!\nBIM!")
+      }.to change { device.instance_variable_get(:@buffer) }.from(['BAM!']).to(['BAM!', 'BIM!'])
     end
 
     it 'does nothing if message is blank' do
@@ -491,7 +478,7 @@ describe SlackLogDevice do
     it 'does nothing if message is nil' do
       expect(HTTParty).not_to receive(:post)
       expect(device.write(nil)).to be_nil
-      expect(device.instance_variable_get(:@buffer)).to eq('')
+      expect(device.instance_variable_get(:@buffer)).to eq([])
     end
 
     it 'does not post HTTP message if auto flush is false' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_log_device
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Alexis Toulotte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-26 00:00:00.000000000 Z
+date: 2017-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -124,8 +124,9 @@ files:
 - Rakefile
 - VERSION
 - lib/slack_log_device.rb
+- lib/slack_log_device/debug_exceptions.rb
 - lib/slack_log_device/formatter.rb
-- lib/slack_log_device/rails_exceptions_logging.rb
+- lib/slack_log_device/set_request_in_thread.rb
 - slack_log_device.gemspec
 - spec/slack_log_device/formatter_spec.rb
 - spec/slack_log_device_spec.rb