resque-analytics 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7de5a9dd7d1aec1589887da6071dc7b988f71c3a
+  data.tar.gz: 22e1b5663baa1e2eeac7c2e858291899a59e26bf
+SHA512:
+  metadata.gz: 87b121b68b72695be1cc095cfaa7d3a7b0854c5f793d42bab36f2e3453833c9101d7e11684dde7ec368bf1f2c210a0ab11f70e85bae348b0fdc9002c27bb1032
+  data.tar.gz: 6c81ccd7035efa82023b90befea4e927239b758bff7e4779298a9d3b4baecbfb83b02b1428419bbc31d607d23c1342b7c4fb28492488c9a45e62b24bdf3a254e

data/.document

@@ -0,0 +1,2 @@
+lib/**/*.rb
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,10 @@
+source 'http://rubygems.org'
+
+gem 'resque', "1.25.1"
+gem 'googlecharts', "1.6.8"
+
+group :development do
+  gem 'bundler'
+  gem 'jeweler'
+  gem 'byebug'
+end

data/Gemfile.lock

@@ -0,0 +1,83 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.6)
+    builder (3.2.2)
+    byebug (2.7.0)
+      columnize (~> 0.3)
+      debugger-linecache (~> 1.2)
+    columnize (0.3.6)
+    debugger-linecache (1.2.0)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.6)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    googlecharts (1.6.8)
+    hashie (3.0.0)
+    highline (1.6.21)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (1.0.0)
+    mini_portile (0.6.0)
+    mono_logger (1.1.0)
+    multi_json (1.10.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.2.1)
+      mini_portile (= 0.6.0)
+    oauth2 (0.9.4)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rack-protection (1.5.3)
+      rack
+    rake (10.3.2)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    redis (3.0.7)
+    redis-namespace (1.4.1)
+      redis (~> 3.0.4)
+    resque (1.25.1)
+      mono_logger (~> 1.0)
+      multi_json (~> 1.0)
+      redis-namespace (~> 1.2)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    sinatra (1.4.5)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    thread_safe (0.3.4)
+    tilt (1.4.1)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  byebug
+  googlecharts (= 1.6.8)
+  jeweler
+  resque (= 1.25.1)

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Nir Tzur
+
+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.rdoc

@@ -0,0 +1,56 @@
+= resque-analytics
+
+Resque jobs analytics and  key performance indicators over time
+
+This gem keeps statistics per worker for the last 90 days, to be later shown as over time graphs.
+For each worker, the gem keeps the following key performance indicators:
+* Number of times it executed successfuly per day
+* Number of times is failed per day
+* Total run time per day
+
+== Installation
+
+Requires resque '~> 1.25.1', and googlecharts '~> 1.6.8'
+
+
+Add the following to your gemfile:
+
+  gem 'resque-analytics', require: 'resque-analytics/server'
+
+== Usage
+
+Extend Resque workers with:
+
+  class Worker
+    extend Resque::Plugins::Analytics
+
+    @queue = :queue
+    def self.perform(*args)
+      # ..
+    end
+  end
+
+On the Resque screens, you will find a new tab called "Analytics".
+
+== TODO
+
+* Add tests
+* Add queued time to total run time analytics
+
+== Contributing to resque-analytics
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Contributers
+
+* {nirtzur}[https://github.com/nirtzur]
+
+== Copyright
+
+Copyright (c) 2014 Nir Tzur. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "resque-analytics"
+  gem.homepage = "http://github.com/nirtzur/resque-analytics"
+  gem.license = "MIT"
+  gem.summary = %Q{Resque Job Analytics}
+  gem.description = %Q{Shows Resque jobs key performance indciators over time}
+  gem.email = "nir.tzur@samanage.com"
+  gem.authors = ["Nir Tzur"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "resque-analytics #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/lib/resque/plugins/analytics.rb

@@ -0,0 +1,38 @@
+require 'resque'
+
+module Resque
+  module Plugins
+    module Analytics
+
+      FAILED = "failed"
+      PERFORMED = "performed"
+      TOTAL_TIME = "total_time"
+      # WAIT_TIME = "wait_time"
+
+      def key(kpi)
+        date = Time.now.strftime("%y_%m_%d")
+        "analytics:#{kpi}:#{self.name}:#{date}"
+      end
+
+      def around_perform_analytics(*args)
+        start = Time.now
+        yield
+        total_time = Time.now - start
+
+        Resque.redis.lpush(key(TOTAL_TIME), total_time)
+        Resque.redis.expire(key(TOTAL_TIME), 90 * 24 * 60)
+      end
+
+      def after_perform_analytics(*args)
+        Resque.redis.incr(key(PERFORMED))
+        Resque.redis.expire(key(PERFORMED), 90 * 24 * 60)
+      end
+
+      def on_failure_analytics(e,*args)
+        Resque.redis.incr(key(FAILED))
+        Resque.redis.expire(key(FAILED), 90 * 24 * 60)
+      end
+
+    end
+  end
+end

data/lib/resque-analytics/server/views/analytics.erb

@@ -0,0 +1,37 @@
+<h1>Resque Analytics</h1>
+
+<p class="intro">
+  Various KPIs related to Resque jobs
+</p>
+
+<% @data.keys.each do |job| %>
+  <h2><%= job %></h2>
+  <% performed = chart_data(@data, job, Resque::Plugins::Analytics::PERFORMED) %>
+  <% failed = chart_data(@data, job, Resque::Plugins::Analytics::FAILED) %>
+  <%= Gchart.bar(
+    data: [performed, failed],
+    title: "Number of jobs",
+    format: "image_tag",
+    size: "1000x300",
+    axis_with_labels: ['x,y'],
+    bar_width_and_spacing: '6',
+    axis_range: [[-90,0,-5], [0, performed.max + failed.max ]],
+    legend: [Resque::Plugins::Analytics::PERFORMED, Resque::Plugins::Analytics::FAILED],
+    legend_position: 'top',
+    bar_colors: ['000000', '0088FF']
+  ) %>
+
+  <% run_time = chart_data(@data, job, Resque::Plugins::Analytics::TOTAL_TIME) %>
+  <%= Gchart.bar(
+    data: [run_time],
+    title: "Run time",
+    format: "image_tag",
+    size: "1000x300",
+    axis_with_labels: ['x,y'],
+    bar_width_and_spacing: '6',
+    axis_range: [[-90,0,-5], [0, run_time.max ]],
+    legend: [Resque::Plugins::Analytics::TOTAL_TIME],
+    legend_position: 'top'
+  ) %>
+
+<% end %>

data/lib/resque-analytics/server.rb

@@ -0,0 +1,58 @@
+require 'resque/server'
+require 'resque/plugins/analytics'
+
+module Resque
+  module Plugins
+    module Analytics
+      module Server
+        VIEW_PATH = File.join(File.dirname(__FILE__), 'server', 'views')
+
+        module Helpers
+          def counters_for(job, kpi)
+            kpi_keys = Resque.redis.keys("analytics:#{kpi}:#{job}:*").sort { |a,b| a <=> b }
+            kpi_keys.inject({}) { |res, key| res[key.split(':').last] = key_value(key); res}
+          end
+
+          def measured_jobs
+            Resque.redis.keys("analytics*").map { |key| key.split(':')[2] }.uniq
+          end
+
+          def key_value(key)
+            if Resque.redis.type(key) == "string"
+              Resque.redis.get(key)
+            else
+              Resque.redis.lrange(key, 0, -1).map(&:to_f).sum
+            end
+          end
+
+          def legend_keys
+            @legend_keys ||= (-90..0).map { |number| number.days.from_now.strftime("%y_%m_%d")}
+          end
+
+          def chart_data(data, job, kpi)
+            legend_keys.map { |key| @data[job][kpi][key].to_i || 0 }
+          end
+        end
+
+        class << self
+          def registered(app)
+            app.get '/analytics' do
+              @data = measured_jobs.inject({}) { |res, job|
+                res[job] = {}
+                [PERFORMED, FAILED, TOTAL_TIME].each { |kpi| res[job][kpi] = counters_for(job, kpi) }
+                res
+              }
+              erb(File.read(File.join(VIEW_PATH, 'analytics.erb')))
+            end
+
+            app.tabs << "Analytics"
+
+            app.helpers(Helpers)
+          end
+        end
+      end
+    end
+  end
+end
+
+Resque::Server.register Resque::Plugins::Analytics::Server

data/lib/resque-analytics.rb

@@ -0,0 +1 @@
+require 'resque/plugins/analytics'

data/resque-analytics.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: resque-analytics 0.5.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "resque-analytics"
+  s.version = "0.5.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Nir Tzur"]
+  s.date = "2014-06-08"
+  s.description = "Shows Resque jobs key performance indciators over time"
+  s.email = "nir.tzur@samanage.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "Rakefile",
+    "VERSION",
+    "lib/resque-analytics.rb",
+    "lib/resque-analytics/server.rb",
+    "lib/resque-analytics/server/views/analytics.erb",
+    "lib/resque/plugins/analytics.rb",
+    "resque-analytics.gemspec"
+  ]
+  s.homepage = "http://github.com/nirtzur/resque-analytics"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "Resque Job Analytics"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<resque>, ["= 1.25.1"])
+      s.add_runtime_dependency(%q<googlecharts>, ["= 1.6.8"])
+      s.add_development_dependency(%q<bundler>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<byebug>, [">= 0"])
+    else
+      s.add_dependency(%q<resque>, ["= 1.25.1"])
+      s.add_dependency(%q<googlecharts>, ["= 1.6.8"])
+      s.add_dependency(%q<bundler>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<byebug>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<resque>, ["= 1.25.1"])
+    s.add_dependency(%q<googlecharts>, ["= 1.6.8"])
+    s.add_dependency(%q<bundler>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<byebug>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: resque-analytics
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Nir Tzur
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-08 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.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+- !ruby/object:Gem::Dependency
+  name: googlecharts
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Shows Resque jobs key performance indciators over time
+email: nir.tzur@samanage.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Rakefile
+- VERSION
+- lib/resque-analytics.rb
+- lib/resque-analytics/server.rb
+- lib/resque-analytics/server/views/analytics.erb
+- lib/resque/plugins/analytics.rb
+- resque-analytics.gemspec
+- README.rdoc
+homepage: http://github.com/nirtzur/resque-analytics
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Resque Job Analytics
+test_files: []