sidekiq-monitoring 0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fe841d0534ee44c3874a938fe210f0ebe2eb61ba
+  data.tar.gz: 8921f0909260f88dea2875ca2a46dd327c5c4c84
+SHA512:
+  metadata.gz: 800b10be6050093c91a90d081e4ac1b66de180c360f5b4310088a80f0b36cd5edc9342767b073c811e88e35b2787aaff80f70cf021990fc55a2fe2ef21fb5ab0
+  data.tar.gz: 86d7c72544cc46c118db18705a02456b9954ddcb7efac08ae77727f1a30afd575299e7d11b97f13f1cca346cd4677abef80e36532e155cfce6b899d8280fdd4b

data/README.md

@@ -0,0 +1,133 @@
+# Rails 3 and 4
+
+Add `sinatra` (and `sprockets` if you are on Rails 3.0) to your Gemfile
+
+```ruby
+# if you require 'sinatra' you get the DSL extended to Object
+gem 'sinatra', '>= 1.3.0', :require => nil
+```
+
+Add the following to your `config/routes.rb`:
+
+```ruby
+mount SidekiqMonitoring => '/checks'
+```
+
+# URL endpoint
+
+To know the state of your sidekiq queues, go to: `<your_website_url>/checks/sidekiq_queues`
+Please remember to mount the route before going to this URL
+
+# Define custom threshold
+
+Add the following to an initializer:
+
+```ruby
+SidekiqMonitoring.thresholds = {
+  'queue_name_1' => [warning, critical],
+  'queue_name_2' => [warning, critical],
+  'queue_name_3' => [warning, critical]
+}
+```
+
+Or if you want to override the default threshold in case of the queue name
+isn't specified in your thresholds:
+
+```ruby
+SidekiqMonitoring.thresholds = {
+  'default' => [warning, critical],
+  'queue_name' => [warning, critical],
+}
+```
+
+### Security
+
+In a production application you'll likely want to protect access to this information. You can use the constraints feature of routing (in the _config/routes.rb_ file) to accomplish this:
+
+#### Token
+
+Allow any user who have a valid token
+
+```ruby
+constraints lambda { |req| req.params[:access_token] == '235b0ddfa5867d81a3232fa6c997a382' } do
+  mount SidekiqMonitoring, :at => '/checks'
+end
+```
+
+#### Devise
+
+Allow any authenticated `User`
+
+```ruby
+# config/routes.rb
+authenticate :user do
+  mount SidekiqMonitoring => '/checks'
+end
+```
+
+Same as above but also ensures that `User#admin?` returns true
+
+```ruby
+# config/routes.rb
+authenticate :user, lambda { |u| u.admin? } do
+  mount SidekiqMonitoring => '/checks'
+end
+```
+
+#### Authlogic
+
+```ruby
+# lib/admin_constraint.rb
+class AdminConstraint
+  def matches?(request)
+    return false unless request.cookies['user_credentials'].present?
+    user = User.find_by_persistence_token(request.cookies['user_credentials'].split(':')[0])
+    user && user.admin?
+  end
+end
+
+# config/routes.rb
+require "admin_constraint"
+mount SidekiqMonitoring => '/checks', :constraints => AdminConstraint.new
+```
+
+#### Restful Authentication
+
+Checks a `User` model instance that responds to `admin?`
+
+```ruby
+# lib/admin_constraint.rb
+class AdminConstraint
+  def matches?(request)
+    return false unless request.session[:user_id]
+    user = User.find request.session[:user_id]
+    user && user.admin?
+  end
+end
+
+# config/routes.rb
+require 'admin_constraint'
+mount SidekiqMonitoring => '/checks', :constraints => AdminConstraint.new
+```
+
+#### Custom External Authentication
+
+```ruby
+class AuthConstraint
+  def self.admin?(request)
+    return false unless (cookie = request.cookies['auth'])
+
+    Rails.cache.fetch(cookie['user'], :expires_in => 1.minute) do
+      auth_data = JSON.parse(Base64.decode64(cookie['data']))
+      response = HTTParty.post(Auth.validate_url, :query => auth_data)
+
+      response.code == 200 && JSON.parse(response.body)['roles'].to_a.include?('Admin')
+    end
+  end
+end
+
+# config/routes.rb
+constraints lambda {|request| AuthConstraint.admin?(request) } do
+  mount SidekiqMonitoring => '/checks'
+end
+```

data/VERSION

@@ -0,0 +1 @@
+0.4

data/lib/sidekiq-monitoring.rb

@@ -0,0 +1,86 @@
+require 'sinatra/base'
+require 'multi_json'
+
+class SidekiqMonitoring < Sinatra::Base
+
+  cattr_accessor :thresholds
+
+  get '/sidekiq_queues' do
+    content_type :json
+    MultiJson.dump SidekiqMonitoring::Global.new(thresholds)
+  end
+
+  class Queue
+
+    ALERT_STATUS = {
+      'OK' => 0,
+      'WARNING' => 1,
+      'CRITICAL' => 2,
+      'UNKNOWN' => 3
+    }
+
+    DEFAULT_THRESHOLD = [ 1_000, 2_000 ]
+
+    attr_accessor :name, :size, :warning_threshold, :critical_threshold, :status
+
+    def as_json(options = {})
+      {
+        'name' => name,
+        'size' => size,
+        'warning_threshold' => warning_threshold,
+        'critical_threshold' => critical_threshold,
+        'status' => status
+      }
+    end
+
+    def initialize(name, size, thresholds = nil)
+      @name = name
+      @size = size
+      @warning_threshold, @critical_threshold = (thresholds.present? ? thresholds : DEFAULT_THRESHOLD)
+      @status = monitoring_status
+    end
+
+    def <=>(other)
+      ALERT_STATUS[status] <=> ALERT_STATUS[other.status]
+    end
+
+    def monitoring_status
+      return 'CRITICAL' if size >= critical_threshold
+      return 'WARNING' if size >= warning_threshold
+      'OK'
+    end
+
+  end
+
+  class Global
+
+    attr_accessor :thresholds
+
+    def as_json(options = {})
+      {
+        'global_status' => global_status,
+        'queues' => queues.as_json
+      }
+    end
+
+    def global_status
+      @global_status ||= queues.sort.last.try(:status) || 'UNKNOWN'
+    end
+
+    def initialize(thresholds = {})
+      @thresholds = thresholds
+    end
+
+    def queues
+      @queues ||= Sidekiq::Queue.all.collect{ |queue|
+        Queue.new(queue.name, queue.size, thresholds_from_queue(queue.name))
+      }
+    end
+
+    def thresholds_from_queue(queue_name)
+      thresholds.fetch(queue_name) { |threshold| threshold['default'] }
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-monitoring
+version: !ruby/object:Gem::Version
+  version: '0.4'
+platform: ruby
+authors:
+- Jérémy Carlier
+autorequire: 
+bindir: ''
+cert_chain: []
+date: 2014-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  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: rspec
+  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: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Give a state of sidekiq available queues
+email: jeremy.carlier@dimelo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- VERSION
+- lib/sidekiq-monitoring.rb
+homepage: http://github.com/dimelo/sidekiq-monitoring
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+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: Addons to provide a monitoring API for Sidekiq
+test_files: []