eventboss 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2235f89e3779ac82843097dc2b527b3ca2dd10425fe362097d3c90217111ea1
-  data.tar.gz: 4606f78b6bdff27c6fe997d71167f7296562aa75ce63c73c725e9eb199d477ae
+  metadata.gz: 1d49008b553f3a7cbe490be82579774a46d7b7bf6df9f9d11c0541035e1434eb
+  data.tar.gz: ddca3e4e49ff3e0897d73b92e1c23d21d1887963b1e3530aaa97c9a2d6202c2b
 SHA512:
-  metadata.gz: 78dea8a722f457449f18c06b89be6126fcd40a57b2765a884166fc2eff721fe59a2517d9404cce2019018d6ddf500c67598f9cd4edefdf1113743ebb3065fbff
-  data.tar.gz: a234ee1da7eaab890ac9ce3e25a0289a45664d393f3a8be25b48c6e5c89b1a91bbe5ba955e9e8f519a701d47e060b683a74af0ebc94ecf24d311eb0c0ab34310
+  metadata.gz: 92804d146a379b5302d87e6e6e43b4cab29dcb10d7441aed309743e18c67da9ad73d3f254169e055605c5541b4780a4086d1b01d08ad710976bbded71cbaa265
+  data.tar.gz: 706ef8d1113b7fd8061696361a7352ada6d805532820b12f58be177ce6113be2d629ab0baee03322c5548565c62a818e2882c1f647590370064c42c5d0fc1598

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    eventboss (1.1.2)
+    eventboss (1.1.3)
       aws-sdk-sns (>= 1.1.0)
       aws-sdk-sqs (>= 1.3.0)
       dotenv (~> 2.1, >= 2.1.1)
@@ -10,8 +10,8 @@ GEM
   remote: https://rubygems.org/
   specs:
     aws-eventstream (1.0.3)
-    aws-partitions (1.210.0)
-    aws-sdk-core (3.66.0)
+    aws-partitions (1.211.0)
+    aws-sdk-core (3.67.0)
       aws-eventstream (~> 1.0, >= 1.0.2)
       aws-partitions (~> 1.0)
       aws-sigv4 (~> 1.1)

data/README.md

@@ -85,6 +85,7 @@ Eventboss.configure do |config|
   config.concurrency = 10
   # when using custom clients like localstack
   config.sns_client = client # Custom SNS Client can be used, i.e. to use local mock, see: https://github.com/phstc/shoryuken/wiki/Using-a-local-mock-SQS-server
+  config.logger = MyLogger.new
   config.sqs_client = Aws::SQS::Client.new(endpoint: 'http://localstack:4576', region: 'us-east-1', credentials: Aws::Credentials.new('fake', 'fake'))
 end
 ```

data/bin/eventboss

@@ -17,10 +17,7 @@ OptionParser.new do |parser|
 end.parse!
 
 begin
-  logger = Eventboss::Logger
-
   require 'rails'
-  logger.debug('Loading rails...')
   if ::Rails::VERSION::MAJOR < 4
     require File.expand_path('config/environment.rb')
   else
@@ -28,6 +25,8 @@ begin
     require File.expand_path('config/environment.rb')
   end
 
+  logger = Eventboss.logger
+  logger.debug('Loaded rails...')
   # Due to a changes introduced in Rails 6 regarding autoloading
   # we need to determine how to perform eager_load
   # @see https://weblog.rubyonrails.org/2019/2/22/zeitwerk-integration-in-rails-6-beta-2/
@@ -37,6 +36,7 @@ begin
     ::Rails.application.eager_load!
   end
 rescue LoadError
+  logger = Eventboss.logger
   logger.debug('Seems like not a Rails app')
 
   if options[:require].nil?

data/lib/eventboss/configuration.rb

@@ -4,6 +4,7 @@ module Eventboss
                 :error_handlers,
                 :concurrency,
                 :log_level,
+                :logger,
                 :sns_client,
                 :sqs_client,
                 :eventboss_region,
@@ -35,6 +36,12 @@ module Eventboss
       defined_or_default('log_level') { :info }
     end
 
+    def logger
+      defined_or_default('logger') do
+        ::Logger.new(STDOUT, level: Eventboss.configuration.log_level)
+      end
+    end
+
     def sns_client
       defined_or_default('sns_client') { Eventboss::SnsClient.new(self) }
     end

data/lib/eventboss/error_handlers/logger.rb

@@ -5,7 +5,9 @@ module Eventboss
         notice = {}.merge!(context)
         notice[:jid] = notice[:processor].jid if notice[:processor]
         notice[:processor] = notice[:processor].class.to_s if notice[:processor]
-        Eventboss::Logger.error("Failure processing request #{exception.message}", notice)
+        Eventboss.logger.error(notice) do
+          "Failure processing request #{exception.message}"
+        end
       end
     end
   end

data/lib/eventboss/instrumentation.rb

@@ -9,7 +9,7 @@ module Eventboss
     # :nodoc:
     module NewRelic
       def self.install(queue_listeners)
-        Eventboss::Logger.logger.info('Loaded NewRelic instrumentation')
+        Eventboss.logger.info('Loaded NewRelic instrumentation')
         queue_listeners.each_value do |listener_class|
           listener_class.include(::NewRelic::Agent::Instrumentation::ControllerInstrumentation)
           listener_class.add_transaction_tracer(:receive, category: 'OtherTransaction/EventbossJob')

data/lib/eventboss/launcher.rb

@@ -22,14 +22,14 @@ module Eventboss
     end
 
     def start
-      logger.info("Starting #{@workers.size} workers, #{@pollers.size} pollers", 'launcher')
+      logger.info('launcher') { "Starting #{@workers.size} workers, #{@pollers.size} pollers" }
 
       @pollers.each(&:start)
       @workers.each(&:start)
     end
 
     def stop
-      logger.info('Gracefully shutdown', 'launcher')
+      logger.info('launcher') { 'Gracefully shutdown' }
 
       @bus.clear
       @pollers.each(&:terminate)
@@ -42,7 +42,7 @@ module Eventboss
     def hard_shutdown
       return if @pollers.empty? && @workers.empty?
 
-      logger.info("Killing remaining #{@pollers.size} pollers, #{@workers.size} workers", 'launcher')
+      logger.info('launcher') { "Killing remaining #{@pollers.size} pollers, #{@workers.size} workers" }
       @pollers.each(&:kill)
       @workers.each(&:kill)
     end
@@ -52,7 +52,7 @@ module Eventboss
         @workers.delete(worker)
         @workers << new_worker(worker.id).tap(&:start) if restart
       end
-      logger.debug("Worker #{worker.id} stopped, restart: #{restart}", 'launcher')
+      logger.debug('launcher') { "Worker #{worker.id} stopped, restart: #{restart}" }
     end
 
     def poller_stopped(poller, restart: false)
@@ -60,7 +60,7 @@ module Eventboss
         @pollers.delete(poller)
         @pollers << new_poller(poller.queue, poller.listener).tap(&:start) if restart
       end
-      logger.debug("Poller #{poller.id} stopped, restart: #{restart}", 'launcher')
+      logger.debug('launcher') { "Poller #{poller.id} stopped, restart: #{restart}" }
     end
 
     private
@@ -82,7 +82,7 @@ module Eventboss
       while @pollers.any? || @workers.any?
         break if (attempts += 1) > shutdown_attempts
         sleep shutdown_delay
-        logger.info("Waiting for #{@pollers.size} pollers, #{@workers.size} workers", 'launcher')
+        logger.info('launcher') { "Waiting for #{@pollers.size} pollers, #{@workers.size} workers" }
       end
     end
 

data/lib/eventboss/logging.rb

@@ -2,7 +2,7 @@ module Eventboss
   # Logging include logging helpers
   module Logging
     def logger
-      Eventboss::Logger
+      Eventboss.logger
     end
   end
 end

data/lib/eventboss/long_poller.rb

@@ -43,7 +43,7 @@ module Eventboss
 
     def fetch_and_dispatch
       fetch_messages.each do |message|
-        logger.debug("enqueueing message #{message.message_id}", id)
+        logger.debug(id) { "enqueueing message #{message.message_id}" }
         @bus << UnitOfWork.new(queue, listener, message)
       end
     end
@@ -64,7 +64,7 @@ module Eventboss
     private
 
     def fetch_messages
-      logger.debug('fetching messages', id)
+      logger.debug(id) { 'fetching messages' }
       @client.receive_message(
         queue_url: queue.url,
         max_number_of_messages: 10,

data/lib/eventboss/runner.rb

@@ -40,7 +40,7 @@ module Eventboss
       def handle_signals(self_read, launcher)
         while readable_io = IO.select([self_read])
           signal = readable_io.first[0].gets.strip
-          logger.info("Received #{ signal } signal, gracefully shutdowning...", 'runner')
+          logger.info('runner') { "Received #{ signal } signal, gracefully shutdowning..." }
 
           launcher.stop
           exit 0

data/lib/eventboss/scripts.rb

@@ -1 +1 @@
-load 'tasks/eventboss.rake'
+load 'tasks/eventboss.rake' if defined?(Rake::Task)

data/lib/eventboss/sns_client.rb

@@ -46,7 +46,7 @@ module Eventboss
 
     class Mock
       def publish(_)
-        Eventboss::Logger.info('Eventboss is not configured. Skipping message publishing!')
+        Eventboss.logger.info('Eventboss is not configured. Skipping message publishing!')
         return
       end
     end

data/lib/eventboss/unit_of_work.rb

@@ -10,13 +10,14 @@ module Eventboss
       @queue = queue
       @listener = listener
       @message = message
+      @logger = logger
     end
 
     def run(client)
-      logger.debug('Started', @message.message_id)
+      logger.debug(@message.message_id) { 'Started' }
       processor = @listener.new
       processor.receive(JSON.parse(@message.body))
-      logger.info('Finished', @message.message_id)
+      logger.debug(@message.message_id) { 'Finished' }
     rescue StandardError => exception
       handle_exception(exception, processor: processor, message_id: @message.message_id)
     else
@@ -27,7 +28,7 @@ module Eventboss
       client.delete_message(
         queue_url: @queue.url, receipt_handle: @message.receipt_handle
       )
-      logger.debug('Deleting', @message.message_id)
+      logger.debug(@message.message_id) { 'Deleting' }
     end
   end
 end

data/lib/eventboss/version.rb

@@ -1,3 +1,3 @@
 module Eventboss
-  VERSION = "1.1.2"
+  VERSION = "1.1.3"
 end

data/lib/eventboss.rb

@@ -19,7 +19,6 @@ require 'eventboss/fetcher'
 require 'eventboss/publisher'
 require 'eventboss/sender'
 require 'eventboss/runner'
-require 'eventboss/logger'
 require 'eventboss/extensions'
 
 # For Rails use railtie, for plain Ruby apps use custom scripts loader
@@ -67,5 +66,9 @@ module Eventboss
     def configuration
       @_configuration ||= Configuration.new
     end
+
+    def logger
+      Thread.current[:ah_eventboss_logger] ||= configuration.logger
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eventboss
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - AirHelp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-11 00:00:00.000000000 Z
+date: 2019-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sqs
@@ -130,7 +130,6 @@ files:
 - lib/eventboss/instrumentation.rb
 - lib/eventboss/launcher.rb
 - lib/eventboss/listener.rb
-- lib/eventboss/logger.rb
 - lib/eventboss/logging.rb
 - lib/eventboss/long_poller.rb
 - lib/eventboss/publisher.rb

data/lib/eventboss/logger.rb

@@ -1,34 +0,0 @@
-module Eventboss
-  class Logger
-    class << self
-      def logger
-        Thread.current[:ah_eventboss_logger] ||= ::Logger.new(
-          STDOUT,
-          level: Eventboss.configuration.log_level
-        )
-      end
-
-      def info(msg, tag = nil)
-        return unless logger
-        logger.info(tagged(msg, tag))
-      end
-
-      def debug(msg, tag = nil)
-        return unless logger
-        logger.debug(tagged(msg, tag))
-      end
-
-      def error(msg, tag = nil)
-        return unless logger
-        logger.error(tagged(msg, tag))
-      end
-
-      private
-
-      def tagged(msg, tag)
-        return msg if tag.nil?
-        msg.prepend("[#{tag}] ")
-      end
-    end
-  end
-end