delayed-plugins-reporting 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 82b5554cc8efd43c1b3e7d3c5b2fbbcc20d81b7b
+  data.tar.gz: 2626a29c9cd6e91814011b3f11a56dd30fcb0636
+SHA512:
+  metadata.gz: 31bce618f7613ba8f8ed3b11169aff960d9e3b87575c301b018d433a2d7feec3ea86305c88c1f8f9d60be241fc5897d8878a9d7109cf92944675e1e959bb83ec
+  data.tar.gz: 08bd37d91f865fc6c29a42de2a0b8bb8aea68da3116a0c860c228741bd37ac5881ebfc3c4fed7b3fd47c5187a6ded3a8782f71feebd1afeeba5c620516331987

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*~
+.idea/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in delayed-plugins-reporting.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Yusuke KUOKA
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# Delayed::Plugins::Reporting
+
+A [Delayed::Job](https://github.com/collectiveidea/delayed_job) plugin to report lifecycle events like job invocations,
+failures, retries to log files or monitoring services like Datadog.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'delayed-plugins-reporting'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install delayed-plugins-reporting
+
+## Usage
+
+```ruby
+require 'delayed-plugins-reporting'
+require 'delayed-plugins-reporting-<reporting plugin of your choice>'
+
+# Configure the plugin like so:
+Delayed::Plugins::Reporting.options = {
+  reporter: {
+    class: Delayed::Plugins::Reporting::DatadogJobReporter,
+    prefix: 'crowdworks.delayed_job.lifecycle'
+  }
+}
+
+# Register the plugin like so:
+Delayed::Worker.plugins << Delayed::Plugins::Reporting
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/crowdworks/delayed-plugins-reporting/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/delayed-plugins-reporting.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'delayed-plugins-reporting/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "delayed-plugins-reporting"
+  spec.version       = Delayed::Plugins::Reporting::VERSION
+  spec.authors       = ["Yusuke KUOKA"]
+  spec.email         = ["yusuke.kuoka@crowdworks.co.jp"]
+  spec.summary       = %q{A Delayed::Job plugin to report lifecycle events to log files or monitoring services, etc.}
+  spec.homepage      = "https://github.com/crowdworks/delayed-plugins-reporting"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/delayed-plugins-reporting.rb

@@ -0,0 +1,29 @@
+require 'delayed_job'
+require 'delayed/plugin'
+
+class Delayed::Plugins::Reporting < ::Delayed::Plugin
+  require 'delayed-plugins-reporting/version'
+  require 'delayed-plugins-reporting/context'
+
+  callbacks do |lifecycle|
+    with_context do |context|
+      lifecycle.after(:failure) do |worker, job|
+        context.after_failure(worker, job)
+      end
+    end
+  end
+
+  class << self
+    def with_context
+      yield Context.create(**options)
+    end
+
+    def options=(options)
+      @options = options
+    end
+
+    def options
+      @options ||= {}
+    end
+  end
+end

data/lib/delayed-plugins-reporting/context.rb

@@ -0,0 +1,44 @@
+require 'delayed-plugins-reporting/job_listener'
+require 'delayed-plugins-reporting/pretty_json_job_formatter'
+
+class Delayed::Plugins::Reporting
+  class Context
+    attr_reader :listener
+
+    def initialize(listener:)
+      @listener = listener
+    end
+
+    def after_failure(worker, job)
+      max_attempts = worker.max_attempts(job)
+
+      if max_attempts > 1 && job.attempts == max_attempts
+        listener.max_attempts_exceeded(job)
+      end
+    end
+
+    class << self
+      def create(reporter: {}, formatter: {}, listener: {})
+        formatter_options = formatter.dup
+        listener_options = listener.dup
+        reporter_options = reporter.dup
+
+        formatter_class = formatter_options.delete(:class) || PrettyJsonJobFormatter
+        listener_class = listener_options.delete(:class) || JobListener
+        reporter_class = reporter_options.delete(:class) || NullReporter
+
+        new(
+          listener: listener_class.new(
+            reporter: reporter_class.new(
+              formatter: formatter_class.new(
+                **formatter_options
+              ),
+              **reporter_options
+            ),
+            **listener_options
+          )
+        )
+      end
+    end
+  end
+end

data/lib/delayed-plugins-reporting/job_listener.rb

@@ -0,0 +1,19 @@
+class Delayed::Plugins::Reporting
+  class JobListener
+    def initialize(reporter:)
+      @reporter = reporter
+    end
+
+    def max_attempts_exceeded(job)
+      report.error :max_attempts_exceeded, job: job, message: <<-EOS.gsub!(/^\s+/, '')
+        The job failed `max_attempts` times and was given up retrying.
+      EOS
+    end
+
+    private
+
+    def report
+      @reporter
+    end
+  end
+end

data/lib/delayed-plugins-reporting/null_reporter.rb

@@ -0,0 +1,11 @@
+require 'delayed-plugins-reporting'
+
+class Delayed::Plugins::Reporting
+  class NullReporter
+    def initialize(formatter:)
+    end
+
+    def error(simple_error_name, message:, job:)
+    end
+  end
+end

data/lib/delayed-plugins-reporting/pretty_json_job_formatter.rb

@@ -0,0 +1,31 @@
+class Delayed::Plugins::Reporting
+  class PrettyJsonJobFormatter
+    INCLUDED_ATTRIBUTE_NAMES = %i| priority attempts run_at locked_at queue created_at updated_at |
+    INCLUDED_METHOD_NAMES = %i| max_attempts |
+
+    attr_reader :included_attribute_names
+    attr_reader :included_method_names
+
+    def initialize(attributes: INCLUDED_ATTRIBUTE_NAMES, methods: INCLUDED_METHOD_NAMES)
+      @included_attribute_names = attributes
+      @included_method_names = methods
+    end
+
+    def format(job)
+      as_pretty_formatted_json(job)
+    end
+
+    private
+
+    def as_json(job)
+      job.as_json(
+        only: included_attribute_names,
+        methods: included_method_names
+      )
+    end
+
+    def as_pretty_formatted_json(job)
+      JSON.pretty_generate(as_json(job))
+    end
+  end
+end

data/lib/delayed-plugins-reporting/version.rb

@@ -0,0 +1,5 @@
+require 'delayed-plugins-reporting'
+
+class Delayed::Plugins::Reporting
+  VERSION = '0.9.0'
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: delayed-plugins-reporting
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Yusuke KUOKA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- yusuke.kuoka@crowdworks.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- delayed-plugins-reporting.gemspec
+- lib/delayed-plugins-reporting.rb
+- lib/delayed-plugins-reporting/context.rb
+- lib/delayed-plugins-reporting/job_listener.rb
+- lib/delayed-plugins-reporting/null_reporter.rb
+- lib/delayed-plugins-reporting/pretty_json_job_formatter.rb
+- lib/delayed-plugins-reporting/version.rb
+homepage: https://github.com/crowdworks/delayed-plugins-reporting
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Delayed::Job plugin to report lifecycle events to log files or monitoring
+  services, etc.
+test_files: []
+has_rdoc: