resque-cloudwatch-monitor 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWFiOTU4M2EzMGZlMzg2YzdhNDgyNTc1NzBkOGQ2MTlhMjhlZGFlMg==
+  data.tar.gz: !binary |-
+    NTU3NTY0OWNjODUyNjNkNTllOTY2ZGE1MGFhZTZmYTIzMTY3MDk3MA==
+SHA512:
+  metadata.gz: !binary |-
+    ODIxYzNiNTM2OTVmYzAzMWJkOTljODBmODY1ZDc4YTdkNTkyYzkzNGI3MmZj
+    ZjMyOWU0Y2FhNjM5NWZkYzk5NDQ4YjE3NmU3ZDkwNzRjMGYwNWMwMjU5ZjA2
+    YTU5ODhlYzFjODQ5OTdjMWZmOWYzMTUxMjcyNTAwYmVjM2NkMjY=
+  data.tar.gz: !binary |-
+    OTA5NjZhMDcyYjAzYWY4MmI5NjQyMzgzNDNlMWRjOTgxZTc0YjU1MThiZGM1
+    NzU3OWQxMWQyYWE5ODhhYjgyNmMwZjRhM2ZjMjg2MWFmMzczMzcyMWRhNzMz
+    YzdiZGJiY2VjNzI5ZDUzYmFjMWE0OWY0OWZhNjkzNWI2NmY5OWM=

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Yotpo Ltd
+
+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,22 @@
+resque-cloudwatch-monitor
+============
+
+A [Resque][rq] plugin. Requires Resque ~> 1.25
+
+This gem provides Cloudwatch reports of failed Resque jobs
+
+  * Redis backed retry count/limit.
+
+
+Install & Quick Start
+---------------------
+
+To install:
+
+    $ gem install resque-cloudwatch-monitor
+
+If you're using [Bundler][bundler] to manage your dependencies, you should add `gem
+'resque-cloudwatch-monitor'` to your projects `Gemfile`.
+
+
+Use the plugin:

data/lib/resque-cloudwatch-monitor.rb

@@ -0,0 +1,5 @@
+require 'resque'
+
+require 'resque/plugins/cloudwatch-monitor/cloudwatch-monitor'
+require 'resque/plugins/cloudwatch-monitor/configuration'
+require 'resque/plugins/cloudwatch-monitor/version'

data/lib/resque/plugins/cloudwatch-monitor/cloudwatch-monitor.rb

@@ -0,0 +1,56 @@
+module Resque
+  module Plugins
+
+    module CloudwatchMonitor
+
+      #Cloudwatch Custom Metric Namespace
+      def namespace
+        Configuration.namespace
+      end
+
+      #Cloudwatch metric name
+      def metric_name
+        @queue || queue
+      end
+
+      #Array of dimensions for Cloudwatch
+      def dimensions(*args)
+        []
+      end
+
+      #Metric timestamp
+      def timestamp
+        Time.now.iso8601
+      end
+
+      #Cloudwatch metric unit type
+      def unit
+        'Count'
+      end
+
+      #Cloudwatch metric value
+      def value
+        1
+      end
+
+      #Job on failure hook. receives the job arguments and the exception
+      def on_failure(e, *args)
+
+        dimensions = dimensions(*args)
+
+        metric_data = {
+          metric_name: metric_name.to_s,
+          dimensions: dimensions,
+          timestamp: timestamp,
+          value: value,
+          unit: unit.to_s
+        }
+
+        #Send to metrics. One general of the queue and another one with dimensions if custom dimensions
+        metrics_to_send = dimensions.empty? ? [metric_data] : [metric_data, metric_data.merge(dimensions: [])]
+
+        Configuration.cloudwatch_client.put_metric_data(namespace: namespace, metric_data: metrics_to_send)
+      end
+    end
+  end
+end

data/lib/resque/plugins/cloudwatch-monitor/configuration.rb

@@ -0,0 +1,16 @@
+module Resque
+	module Plugins
+		module CloudwatchMonitor
+			module Configuration
+				class << self
+
+					attr_accessor :namespace, :cloudwatch_client
+
+					def configure
+						yield self
+					end
+				end
+			end
+		end
+	end
+end

data/lib/resque/plugins/cloudwatch-monitor/version.rb

@@ -0,0 +1,7 @@
+module Resque
+	module Plugins
+		module CloudwatchMonitor
+			VERSION = '0.0.1'
+		end
+	end
+end

data/resque-cloudwatch-monitor.gemspec

@@ -0,0 +1,23 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'resque/plugins/cloudwatch-monitor/version'
+Gem::Specification.new do |s|
+  s.name                = 'resque-cloudwatch-monitor'
+  s.version             = Resque::Plugins::CloudwatchMonitor::VERSION
+  s.date                = Time.now.strftime('%Y-%m-%d')
+  s.summary             = 'Send Resque Failures To AWS CloudWatch'
+  s.email               = 'avichay@yotpo.com'
+  s.homepage            = 'https://github.com/YotpoLtd/resque-cloudwatch-monitor'
+  s.description         = 'Allows reporting failures of resque jobs to Amazon CloudWatch'
+  s.has_rdoc            = false
+  s.require_paths       = ['lib']
+  s.authors             = ['Yotpo/avichay@yotpo']
+  s.files               = ['README.md', 'resque-cloudwatch-monitor.gemspec', 'LICENSE']
+  s.files               += Dir['**/*.rb']
+  s.license             = 'MIT'
+
+  s.add_dependency 'resque', '~> 1.25'
+  s.add_development_dependency 'rake', '~> 10.3'
+  s.add_development_dependency 'aws-sdk', '~> 1.11.1'
+  s.add_development_dependency 'rspec', '~> 3.3.0'
+  s.add_development_dependency 'timecop', '~> 0.7.4'
+end

data/spec/cloudwatch_monitor_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+describe Resque::Plugins::CloudwatchMonitor do
+
+  before(:all) do
+    Resque.redis.flushall
+    @worker = Resque::Worker.new('*')
+    @worker.register_worker
+
+    Timecop.freeze(Time.now)
+
+    @metric_data = {
+        metric_name: 'Failure',
+        dimensions: [],
+        timestamp: Time.now.iso8601,
+        value: 1,
+        unit: 'Count'
+    }
+
+  end
+
+  after(:all) do
+    Timecop.return
+  end
+
+  it 'failure in resque job sends metric to cloudwatch' do
+    expect(Resque::Plugins::CloudwatchMonitor::Configuration.cloudwatch_client).
+        to receive(:put_metric_data).
+        with(namespace: 'Resque Failures', metric_data: [@metric_data])
+
+    Resque.enqueue(FailureJobTest, :fail)
+    CloudWatchMonitorTest.perform_enqueued_job(@worker)
+  end
+
+  it 'failure in resque job sends custom dimensions' do
+    class FailureJobTest
+      def self.dimensions(*args)
+        [{name: 'Custom', value: args.first.to_s}]
+      end
+    end
+
+    # allow(FailureJobTest).to receive(:dimensions) {[{name: 'Custom', value: 'fail'}] }
+
+    expect(Resque::Plugins::CloudwatchMonitor::Configuration.cloudwatch_client).
+        to receive(:put_metric_data).
+        with(namespace: 'Resque Failures', metric_data: [@metric_data.merge(dimensions: [{name: 'Custom', value: 'fail'}]), @metric_data])
+
+    Resque.enqueue(FailureJobTest, :fail)
+    CloudWatchMonitorTest.perform_enqueued_job(@worker)
+  end
+
+  it 'successful job does not send a metric to cloudwatch' do
+    expect(Resque::Plugins::CloudwatchMonitor::Configuration.cloudwatch_client).
+        to receive(:put_metric_data).
+        exactly(0).times
+
+    Resque.enqueue(SuccessJobTest, :success)
+    CloudWatchMonitorTest.perform_enqueued_job(@worker)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+require 'aws'
+require 'timecop'
+require 'resque-cloudwatch-monitor'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end
+
+class CloudWatchMonitorTest
+  def self.perform_enqueued_job(worker)
+    job = worker.reserve
+    worker.perform(job)
+    worker.done_working
+  end
+end
+
+Resque::Plugins::CloudwatchMonitor::Configuration.configure do |config|
+  config.namespace = 'Resque Failures'
+  config.cloudwatch_client = AWS::CloudWatch::Client.new
+end
+
+class FailureJobTest
+  extend Resque::Plugins::CloudwatchMonitor
+  @queue = 'Failure'
+
+  def self.perform(*args)
+    raise Exception.new('Test Error')
+  end
+end
+
+class SuccessJobTest
+  extend Resque::Plugins::CloudwatchMonitor
+  @queue = 'Success'
+
+  def self.perform(*args)
+    1 + 1
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: resque-cloudwatch-monitor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yotpo/avichay@yotpo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.25'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.11.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.4
+description: Allows reporting failures of resque jobs to Amazon CloudWatch
+email: avichay@yotpo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/resque-cloudwatch-monitor.rb
+- lib/resque/plugins/cloudwatch-monitor/cloudwatch-monitor.rb
+- lib/resque/plugins/cloudwatch-monitor/configuration.rb
+- lib/resque/plugins/cloudwatch-monitor/version.rb
+- resque-cloudwatch-monitor.gemspec
+- spec/cloudwatch_monitor_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/YotpoLtd/resque-cloudwatch-monitor
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Send Resque Failures To AWS CloudWatch
+test_files: []