sidekiq-health 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b81bb187af9420b1b278749905046150a361654f
+  data.tar.gz: 443e051e0878485318ff55fbe74407bfad37140f
+SHA512:
+  metadata.gz: b960ef54e38a0e2ca11672028d1cf6f1419c20caeac60b461890ad3e1d2155b62df48af8a68b25793dc2ff2dddad9ba61df603fbd0b20c6922fd435b2af99ad4
+  data.tar.gz: 112593760a8daeb7e2cd5bff5481acea4ff6692ce6050dd52df364237538716489b559a844a97ae803f8c71233949befd7cbb4cd20fec2a2b956fd56228aadb7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.7
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tom de Vries
+
+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,55 @@
+# Sidekiq::Health
+
+Sidekiq::Health prints the size of your Sidekiq Queues with either an `OK` or `WARNING` tag, the queue name and size. The current threshold is set to 50 meaning that when there are more than 49 jobs enqueued Sidekiq::Health will mark the queue as "too busy".
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-health'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-health
+
+## Requirements
+
+Sidekiq::Health expects you to have the default Sidekiq configuration file located in `config/sidekiq.yml`.
+
+NOTE: Only names queues are supported at this time.
+
+## Usage
+
+Sidekiq::Health is intended to be used within a Rails project. When added to your project's Gemfile a rake task will be added:
+
+    $ rake sidekiq::queue::status
+
+Which, depending on your `config/sidekiq.yml` and state of Sidekiq will result in:
+
+```
+WARNING: TOO MANY JOBS ENQUEUED. Queue: "mailers" Size: 75
+OK. Queue: "default" Size: 0
+```
+Match the "WARNING" with your favorite monitoring tool and escalate accordingly.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tomdev/sidekiq-health.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq/health"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sidekiq/health/queue_names.rb

@@ -0,0 +1,19 @@
+require 'yaml'
+
+module Sidekiq
+  module Health
+    class QueueNames
+      attr_reader :configuration
+
+      SIDEKIQ_CONFIGURATION_FILE_PATH = 'config/sidekiq.yml'
+
+      def initialize(configuration_file_path = SIDEKIQ_CONFIGURATION_FILE_PATH)
+        @configuration = YAML.load_file(configuration_file_path)
+      end
+
+      def get
+        configuration[:queues].map { |q| q.is_a?(Array) ? q[0] : q }
+      end
+    end
+  end
+end

data/lib/sidekiq/health/queue_status.rb

@@ -0,0 +1,53 @@
+require 'sidekiq/api'
+
+module Sidekiq
+  module Health
+    class QueueStatus
+      def print
+        output = ""
+
+        queue_names.each do |name|
+          output << "\n" unless output == ""
+          output << QueueHealthFormatter.new(name, queue_size(name)).to_s
+        end
+
+        output
+      end
+
+      private
+
+      def queue_size(name)
+        Sidekiq::Queue.new(name).size
+      end
+
+      def queue_names
+        Sidekiq::Health::QueueNames.new.get
+      end
+    end
+
+    class QueueHealthFormatter
+      QUEUE_SIZE_WARNING_THRESHOLD = 50
+
+      attr_reader :name, :size
+
+      def initialize(name, size)
+        @name = name
+        @size = size
+      end
+
+      def to_s
+        if size < QUEUE_SIZE_WARNING_THRESHOLD
+          "OK. #{queue_information}"
+        else
+          "WARNING: TOO MANY JOBS ENQUEUED. #{queue_information}"
+        end
+      end
+
+      private
+
+      def queue_information
+        "Queue: \"#{name}\" Size: #{size}"
+      end
+    end
+  end
+end

data/lib/sidekiq/health/railtie.rb

@@ -0,0 +1,11 @@
+require 'sidekiq/health'
+
+module Sidekiq
+  module Health
+    require 'rails'
+
+    class Railtie < ::Rails::Railtie
+      rake_tasks { load "sidekiq/tasks/sidekiq_health.rake" }
+    end
+  end
+end

data/lib/sidekiq/health/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Health
+    VERSION = "0.1.0"
+  end
+end

data/lib/sidekiq/health.rb

@@ -0,0 +1,15 @@
+require 'sidekiq/health/railtie' if defined?(Rails::Railtie)
+
+module Sidekiq
+  module Health
+    LIBRARY_PATH = File.join(File.dirname(__FILE__), 'health')
+    GEM_PATH = File.dirname(__FILE__)
+
+    %w{
+      queue_names
+      queue_status
+      version
+    }.each {|lib| require File.join(LIBRARY_PATH, lib) }
+  end
+end
+

data/lib/sidekiq/tasks/sidekiq_health.rake

@@ -0,0 +1,8 @@
+namespace :sidekiq do
+  namespace :queue do
+    desc "Output current queue size of all Sidekiq queues"
+    task :status => :environment do
+      puts Sidekiq::Health::QueueStatus.new.print
+    end
+  end
+end

data/sidekiq-health.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/health/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-health"
+  spec.version       = Sidekiq::Health::VERSION
+  spec.authors       = ["Tom de Vries"]
+  spec.email         = ["tom@hackerone.com"]
+
+  spec.summary       = %q{Monitor the size of your Sidekiq queues.}
+  spec.description   = %q{Sidekiq::Health adds a rake task that outputs the
+    current size our your Sidekiq queues.}
+  spec.homepage      = "https://github.com/tomdev/sidekiq-health"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "railties", "~> 4.0"
+  spec.add_development_dependency "sidekiq", "~> 3.0"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-health
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom de Vries
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |-
+  Sidekiq::Health adds a rake task that outputs the
+      current size our your Sidekiq queues.
+email:
+- tom@hackerone.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sidekiq/health.rb
+- lib/sidekiq/health/queue_names.rb
+- lib/sidekiq/health/queue_status.rb
+- lib/sidekiq/health/railtie.rb
+- lib/sidekiq/health/version.rb
+- lib/sidekiq/tasks/sidekiq_health.rake
+- sidekiq-health.gemspec
+homepage: https://github.com/tomdev/sidekiq-health
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5
+signing_key: 
+specification_version: 4
+summary: Monitor the size of your Sidekiq queues.
+test_files: []