logstasher 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c6c820ae3e9564dbca07d91c80e75ded3a87bdbf11e0df7ff0b5561ce3a21c0
-  data.tar.gz: a5cc2935b0db9c9daad29921df6f9461379f9dd0cca76abf0a802f110e44be40
+  metadata.gz: d7bf19f1cccbb941b087f15328764d07da66e7006a0db9dd64c14f192d0fbb9b
+  data.tar.gz: dc5af64c9333ac0c42a67977519049d6f78233a7c50e3ce353120ff382f9c97b
 SHA512:
-  metadata.gz: 4e6b0ae61b5f545e29cd3dff4b3d28bdf3f092f8064978c389d444cb6dad35217b860ac8176034d5fef35d479c68efc818643f2779003e95062e8bbce66f194f
-  data.tar.gz: e942332d068bf347f588daa955b1d749d7f553b296e2d76bdd33e32555ec4b7e4c6d9ab0b8ef3da92fd363b00a94a71704ca2b50076248559da438ebbdb647c1
+  metadata.gz: 60064a14f73422c0a1be36a9052d8d73741287d370876592b610ac4f9b27e4fec42ab3173b8cfd9d65e75e8ae331558a1516aca17ede477e39a4b8d575f3ae67
+  data.tar.gz: 17323dff796913fd335fc6142f640c10a281e618ce08ce0836a33b26c669d1a669317a394ecc594e4a2e9d3b8c35bcb19b74200636118c6cf42ce2e12d62a9a4

data/lib/logstasher.rb

@@ -36,7 +36,9 @@ module LogStasher
         unsubscribe(:action_mailer, subscriber)
       when 'ActiveRecord::LogSubscriber'
         unsubscribe(:active_record, subscriber)
-      when 'ActiveJob::Logging::LogSubscriber'
+      when 'ActiveJob::LogSubscriber' # For Rails 6
+        unsubscribe(:active_job, subscriber)
+      when 'ActiveJob::Logging::LogSubscriber' # For Rails 5
         unsubscribe(:active_job, subscriber)
       end
     end

data/lib/logstasher/active_job/log_subscriber.rb

@@ -1,92 +1,98 @@
-begin
-  # `rescue nil` didn't work for some Ruby versions
-  require 'active_job/logging'
-rescue LoadError
+if ActiveJob::VERSION::MAJOR >= 6 && ActiveJob::VERSION::MINOR >= 1
+  require 'active_job/log_subscriber'
+else
+  require 'active_job/logging' 
 end
 
-if defined?(::ActiveJob::Logging::LogSubscriber)
-  module LogStasher
-    module ActiveJob
-      class LogSubscriber < ::ActiveJob::Logging::LogSubscriber
-        def enqueue(event)
-          process_event(event, 'enqueue')
-        end
-
-        def enqueue_at(event)
-          process_event(event, 'enqueue_at')
-        end
-
-        def perform(event)
-          process_event(event, 'perform')
-
-          # Revert the request id back, in the event that the inline adapter is being used or a
-          # perform_now was used.
-          LogStasher.request_context[:request_id] = Thread.current[:old_request_id]
-          Thread.current[:old_request_id] = nil
-        end
-
-        def perform_start(event)
-          # Use the job_id as the request id, so that any custom logging done for a job
-          # shares a request id, and has the job id in each log line.
-          #
-          # It's not being set when the job is enqueued, so enqueuing a job will have it's default
-          # request_id. In a lot of cases, it will be because of a web request.
-          #
-          # Hang onto the old request id, so we can revert after the job is done being performed.
-          Thread.current[:old_request_id] = LogStasher.request_context[:request_id]
-          LogStasher.request_context[:request_id] = event.payload[:job].job_id
-
-          process_event(event, 'perform_start')
-        end
-
-        def logger
-          LogStasher.logger
-        end
-
-        private
-
-        def process_event(event, type)
-          data = extract_metadata(event)
-          data.merge! extract_exception(event)
-          data.merge! extract_scheduled_at(event) if type == 'enqueue_at'
-          data.merge! extract_duration(event) if type == 'perform'
-          data.merge! request_context
-
-          tags = ['job', type]
-          tags.push('exception') if data[:exception]
-          logger << LogStasher.build_logstash_event(data, tags).to_json + "\n"
-        end
-
-        def extract_metadata(event)
-          {
-            job_id: event.payload[:job].job_id,
-            queue_name: queue_name(event),
-            job_class: event.payload[:job].class.to_s,
-            job_args: args_info(event.payload[:job])
-          }
-        end
-
-        def extract_duration(event)
-          { duration: event.duration.to_f.round(2) }
-        end
-
-        def extract_exception(event)
-          event.payload.slice(:exception)
-        end
-
-        def extract_scheduled_at(event)
-          { scheduled_at: scheduled_at(event) }
-        end
-
-        def request_context
-          LogStasher.request_context
-        end
-
-        # The default args_info makes a string. We need objects to turn into JSON.
-        def args_info(job)
-          job.arguments.map { |arg| arg.try(:to_global_id).try(:to_s) || arg }
-        end
+module LogStasher
+  module ActiveJob
+
+    BASE_SUBSCRIBER = if defined?(::ActiveJob::LogSubscriber)
+      ::ActiveJob::LogSubscriber
+    else
+      ::ActiveJob::Logging::LogSubscriber
+    end
+
+    class LogSubscriber < BASE_SUBSCRIBER
+      def enqueue(event)
+        process_event(event, 'enqueue')
+      end
+
+      def enqueue_at(event)
+        process_event(event, 'enqueue_at')
+      end
+
+      def perform(event)
+        process_event(event, 'perform')
+
+        # Revert the request id back, in the event that the inline adapter is being used or a
+        # perform_now was used.
+        LogStasher.request_context[:request_id] = Thread.current[:old_request_id]
+        Thread.current[:old_request_id] = nil
+      end
+
+      def perform_start(event)
+        # Use the job_id as the request id, so that any custom logging done for a job
+        # shares a request id, and has the job id in each log line.
+        #
+        # It's not being set when the job is enqueued, so enqueuing a job will have it's default
+        # request_id. In a lot of cases, it will be because of a web request.
+        #
+        # Hang onto the old request id, so we can revert after the job is done being performed.
+        Thread.current[:old_request_id] = LogStasher.request_context[:request_id]
+        LogStasher.request_context[:request_id] = event.payload[:job].job_id
+
+        process_event(event, 'perform_start')
+      end
+
+      def logger
+        LogStasher.logger
+      end
+
+      private
+
+      def process_event(event, type)
+        data = extract_metadata(event)
+        data.merge! extract_exception(event)
+        data.merge! extract_scheduled_at(event) if type == 'enqueue_at'
+        data.merge! extract_duration(event) if type == 'perform'
+        data.merge! request_context
+
+        tags = ['job', type]
+        tags.push('exception') if data[:exception]
+        logger << LogStasher.build_logstash_event(data, tags).to_json + "\n"
+      end
+
+      def extract_metadata(event)
+        {
+          job_id: event.payload[:job].job_id,
+          queue_name: queue_name(event),
+          job_class: event.payload[:job].class.to_s,
+          job_args: args_info(event.payload[:job])
+        }
+      end
+
+      def extract_duration(event)
+        { duration: event.duration.to_f.round(2) }
+      end
+
+      def extract_exception(event)
+        event.payload.slice(:exception)
+      end
+
+      def extract_scheduled_at(event)
+        { scheduled_at: scheduled_at(event) }
+      end
+
+      def request_context
+        LogStasher.request_context
+      end
+
+      # The default args_info makes a string. We need objects to turn into JSON.
+      def args_info(job)
+        job.arguments.map { |arg| arg.try(:to_global_id).try(:to_s) || arg }
       end
     end
   end
 end
+

data/lib/logstasher/active_support/mailer_log_subscriber.rb

@@ -10,6 +10,11 @@ module LogStasher
         process_event(event, %w[mailer deliver])
       end
 
+      # This method will only be invoked on Rails 6.0 and prior.
+      # Starting in Rails 6.0 the receive method was deprecated in
+      # favor of ActionMailbox.  The receive method was removed
+      # from ActionMailer in Rails 6.1, and there doesn't appear to
+      # be corresponding instrumentation for ActionMailbox.
       def receive(event)
         process_event(event, %w[mailer receive])
       end

data/lib/logstasher/version.rb

@@ -1,3 +1,3 @@
 module LogStasher
-  VERSION = '2.0.2'.freeze
+  VERSION = '2.1.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logstasher
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Shadab Ahmed
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement