delayed_job_logging 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd96e6eb81feec7de389c48b805710256f0fa86f
-  data.tar.gz: 38641973c4e317119d6c86ccf71292bb1f8f882f
+  metadata.gz: f0d96ad61314b458b123b4c5869ad089eadf5371
+  data.tar.gz: 6b24ebb7de1477c9110f04b9bce91fb91f63a83d
 SHA512:
-  metadata.gz: fa732da503ecc9dd3379cd7fdbb1454cfadfb9de7017ed4df404407e2e25a928c4cab56c3c99c4589a46a27c2048ab98f991477e8349fae3d63e46e5ad18673e
-  data.tar.gz: e84427a5dd244a0b113be246bb39b06d39ce8296d4ecc4e4033134070d14e7be04c182b0639259630d81e1450f7fda055896c30209ff123529f24722812e7881
+  metadata.gz: 5eb3838c99b633f14e61b4b44d7b7252f3c258a55d71a6fd25308c54ff0271afe17c3515fa1ee4e02276a16cf89ded0c14ada1479f2d98fe1a8b6927c7f314f3
+  data.tar.gz: c175c2550ac759cd169fee9b9ae602603992a429f6cd5b4086f33a64f12eda0e7262eabc9fed36925486e90b6df3bf68fc165a6d89a8f06209d90e0f22fdeaec

data/lib/delayed_job_logging.rb

@@ -0,0 +1,81 @@
+require "delayed_job_logging/version"
+
+# Delayed Job Workers including this will log when a job was enqueued, started,
+# succeeded or failed to the Rails logs.
+# It's important to call `super` if they implement these callback methods:
+# `enqueue`, `before`, `success` or `error`
+module DelayedJobLogging
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger || Delayed::Job.logger || fail("No logger available!")
+    end
+  end
+
+  def enqueue(job)
+    LogMessage.new(job).log("enqueued")
+  end
+
+  def before(job)
+    LogMessage.new(job).log("started")
+  end
+
+  def success(job)
+    LogMessage.new(job).log("succeeded")
+  end
+
+  def error(job, exception)
+    LogMessage.new(job).log("failed", exception: exception)
+  end
+
+  class LogMessage
+    attr_reader :job
+    private :job
+
+    def initialize(job)
+      @job = job
+    end
+
+    def log(status, exception: nil)
+      DelayedJobLogging.logger.info(
+        ActiveSupport::JSON.encode(
+          message_for(status, exception: exception)
+        )
+      )
+    end
+
+    # The method constructs a hash. Imnsho all alternatives would be inferior to this.
+    # rubocop:disable Metrics/MethodLength
+    private def message_for(status, exception:)
+      {
+        job_attempts: job.attempts,
+        job_exception: format_exception(exception),
+        job_id: job.id,
+        job_worker_name: worker.class.name,
+        job_arguments: job_arguments,
+        job_priority: job.priority,
+        job_queue: job.queue,
+        job_run_at: (job.run_at || Time.now).iso8601,
+        job_status: status
+      }
+    end # rubocop:enable Metrics/MethodLength
+
+    private def job_arguments
+      worker.instance_variables.inject({}) do |vars, var|
+        vars.merge(var => worker.instance_variable_get(var))
+      end
+    end
+
+    private def worker
+      @_worker ||= YAML.load(job.handler)
+    end
+
+    private def format_exception(exception)
+      return unless exception
+
+      "#{exception.class}: #{exception.message}\n" +
+        exception.backtrace.join("\n")
+    end
+  end
+end

data/lib/delayed_job_logging/version.rb

@@ -0,0 +1,3 @@
+module DelayedJobLogging
+  VERSION = "0.1.1"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: delayed_job_logging
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Johannes Barre
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-28 00:00:00.000000000 Z
+date: 2015-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: delayed_job
@@ -128,7 +128,9 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- lib/delayed_job_logging.rb
+- lib/delayed_job_logging/version.rb
 homepage: https://github.com/Savedo/delayed_job_logging
 licenses:
 - MIT