sidekiq_queue_status 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 32426fcdf33231d81705398d85a9202f7a172f6a
+  data.tar.gz: 30bd276ea5ece5a0abfbb330285527d407db13c0
+SHA512:
+  metadata.gz: d4fc67ee170af880100f568e93cbf84f5a2d29a28854495bcaad7ada6295db37f4115275d21ae5b9910d868ec351cd3faea3312b1bfd7b693cf45fa079ffb2a0
+  data.tar.gz: 2d3b2e1e5011dfa927a1d32d99df7f7ed4c7908a2ea7586a4a1e18911e44812d5b6ebc2ff294fa10257877b64dd39e1e0eca2ca275034ee767f57bbf3d85c136

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Matthijs Langenberg
+
+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,50 @@
+# Sidekiq Queue Status
+
+Rails Middleware to add `/queue-status` endpoint. Useful for pinging
+services such as Icinga or Nagios.
+
+Lists latency for each sidekiq queue. The latency is the number of
+seconds the oldest job (next in line) is waiting to be performed.
+
+Under normal circumstances returns a `200 OK` status code. When latency
+is higher than the 30s default threshold, a `503 Service Unavailable` is
+returned.
+
+Thresholds are configurable by setting `config.queue_tresholds` hash.
+Key is queue name, value is latency threshold in seconds.
+
+Response body is a JSON object, listing the latencies of all queues and
+an array of error messages explaining which queues triggered a threshold
+error.
+
+```json
+{
+  "latencies": {
+    "batch": 200,
+    "default": 1
+  },
+  "errors": ["Queue batch above threshold of 100"]
+}
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sidekiq_queue_status'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq_queue_status
+
+## Contributing
+
+1. Fork it ( http://github.com/nedap/sidekiq_queue_status/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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/sidekiq_queue_status/middleware.rb

@@ -0,0 +1,35 @@
+require 'sidekiq/api'
+
+module SidekiqQueueStatus
+  class Middleware
+    DEFAULT_TRESHOLD = 30
+    HEADERS = {
+      'Content-Type' => 'application/json',
+      'Cache-Control' => 'no-cache'
+    }
+
+    def initialize(app, configured_tresholds)
+      @app = app
+      @latency_treshold = Hash.new(DEFAULT_TRESHOLD).merge(configured_tresholds)
+    end
+
+    def call(env)
+      if env["PATH_INFO"] =~ %r{\A/queue-status\Z}
+        errors = []
+        queues.each do |name, latency|
+          max_latency = @latency_treshold[name]
+          errors << "Queue #{name} above threshold of #{max_latency}s" if latency > max_latency
+        end
+        body = { latencies: queues, errors: errors }.to_json
+        status = errors.any? ? 503 : 200
+        [status, HEADERS, [body]]
+      else
+        @app.call(env)
+      end
+    end
+
+    def queues
+      Sidekiq::Queue.all.map { |q| [q.name, q.latency.to_i] }.to_h
+    end
+  end
+end

data/lib/sidekiq_queue_status/railtie.rb

@@ -0,0 +1,10 @@
+require 'rails/railtie'
+
+module SidekiqQueueStatus
+  class Railtie < Rails::Railtie
+    config.queue_tresholds = {}
+    initializer "sidekiq_queue_status.configure_rails_initialization" do |app|
+      app.middleware.use SidekiqQueueStatus::Middleware, app.config.queue_tresholds
+    end
+  end
+end

data/lib/sidekiq_queue_status/version.rb

@@ -0,0 +1,3 @@
+module SidekiqQueueStatus
+  VERSION = "0.0.1"
+end

data/lib/sidekiq_queue_status.rb

@@ -0,0 +1,3 @@
+require 'sidekiq_queue_status/version'
+require 'sidekiq_queue_status/middleware'
+require 'sidekiq_queue_status/railtie'

data/sidekiq_queue_status.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq_queue_status/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq_queue_status"
+  spec.version       = SidekiqQueueStatus::VERSION
+  spec.authors       = ["Matthijs Langenberg"]
+  spec.email         = ["mlangenberg@gmail.com"]
+  spec.summary       = %q{Monitor Sidekiq queue status in Rails}
+  spec.description   = %q{
+                            This Gem adds a /queue-status endpoint to your Rails app.
+                            Useful for monitoring your Sidekiq queues with Icinga or Nagios.
+                            Normally returns a 200 OK, returns 503 Service Unavailable
+                            when stats such as queue latency are too high.
+                          }
+  spec.homepage      = "https://github.com/nedap/sidekiq_queue_status"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "railties", "> 3.0"
+  spec.add_dependency "sidekiq", "> 2.5"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_queue_status
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Matthijs Langenberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>'
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: "\n                            This Gem adds a /queue-status endpoint
+  to your Rails app.\n                            Useful for monitoring your Sidekiq
+  queues with Icinga or Nagios.\n                            Normally returns a 200
+  OK, returns 503 Service Unavailable\n                            when stats such
+  as queue latency are too high.\n                          "
+email:
+- mlangenberg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sidekiq_queue_status.rb
+- lib/sidekiq_queue_status/middleware.rb
+- lib/sidekiq_queue_status/railtie.rb
+- lib/sidekiq_queue_status/version.rb
+- sidekiq_queue_status.gemspec
+homepage: https://github.com/nedap/sidekiq_queue_status
+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: Monitor Sidekiq queue status in Rails
+test_files: []
+has_rdoc: