nagios_check_resque 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea510ab463796225c4c28151edfcf363ffa1cf3b
+  data.tar.gz: fcabefd39deea0fc6ab465b257497fc86f45b2f9
+SHA512:
+  metadata.gz: 929d21db1b9987ee1b34df5f9d08bb64be6881ca47adc5cb467caf80bbe745372b03ab7b12236cdf52acb08bfd8adffa8c6ea13b0b1d02ba705cd43172f6990e
+  data.tar.gz: d5423867a518a023e70835bc4999737bf1d5c2e941d75458b1aaec371f9101b6a850846f8cca0bade454d09de15262afa03aed0a7704ad903b42c5c2cc0c80e0

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# CHANGELOG
+
+### Changes on `master`
+
+[Compare changes](https://github.com/codevise/nagios_check_resque/compare/v1.0.0...master)
+
+None so far.
+
+### Version 1.0.0
+
+2017-02-21
+
+Initial release.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tfischbach@codevise.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Codevise Solutions 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,110 @@
+# Nagios Check Resque
+
+[![Gem Version](https://badge.fury.io/rb/nagios_check_resque.svg)](http://badge.fury.io/rb/nagios_check_resque)
+
+Nagios plugins to check Resque queue sized and number of failed jobs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nagios_check_resque', require: false
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+The provides two executables. To check queue sizes, run:
+
+    $ bundle exec nagios_check_resque_queue_sizes --queues default,mailer -w 5 -c 8 -t 10
+
+The result is OK if all given queues contain at most 5 jobs.  If one
+of the queues contains more than 5 but not more than 8 jobs, the
+result is WARNING.  If one of the queues contains more than 8 jobs,
+the result is CRITICAL.  If the command takes more than 10 seconds to
+finish, the result is UNKNOWN.
+
+The number of jobs in each queue is printed as key value pairs in the
+performance data.
+
+To check the number of failed jobs, run:
+
+    $ bundle exec nagios_check_resque_failed_jobs -w 5 -c 8 -t 10
+
+The result is OK if there are at most 5 failed jobs.  If there are
+more than 5 failed jobs but not more than 8, the result is WARNING.
+If there are more than 8 failed jobs, the result is CRITICAL.  If the
+command takes more than 10 seconds to finish, the result is UNKNOWN.
+
+## Example Nagios Configuration
+
+You can define a custom Nagios command to invoke the executables via
+SSH. Line breaks have been inserted to improve readability, but have
+to be removed in the actual Nagios config.
+
+```
+define command {
+        command_name    check_by_ssh_resque_queue_sizes
+        command_line    $USER1$/check_by_ssh -l nagios -H $HOSTADDRESS$
+                          -C "BUNDLE_GEMFILE=/path/to/Gemfile
+                              /usr/local/bin/bundle exec nagios_check_resque_queue_sizes
+                              --queues $ARG2$
+                              -w $ARG1$ -c $ARG2$ -t 10"
+}
+
+define command {
+        command_name    check_by_ssh_resque_failed_jobs
+        command_line    $USER1$/check_by_ssh -l nagios -H $HOSTADDRESS$
+                          -C "BUNDLE_GEMFILE=/path/to/Gemfile
+                              /usr/local/bin/bundle exec nagios_check_resque_failed_jobs
+                              -w $ARG1$ -c $ARG2$ -t 10"
+}
+```
+
+They can then be used in host definitions:
+
+```
+define service {
+  use                           generic-service
+  host_name                     some-host
+  service_description           RESQUE_QUEUE_SIZES
+  check_command                 check_by_ssh_resque_queue_sizes!default!10!20
+}
+
+define service {
+  use                           generic-service
+  host_name                     some-host
+  service_description           RESQUE_FAILED_JOBS
+  check_command                 check_by_ssh_resque_failed_jobs!0!10
+}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install
+dependencies. 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/codevise/nagios_check_resque. This project is
+intended to be a safe, welcoming space for collaboration, and
+contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of
+conduct.
+
+## 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,2 @@
+require 'bundler/gem_tasks'
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nagios_check_resque"
+
+# 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(__FILE__)

data/bin/setup

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

data/exe/nagios_check_resque_failed_jobs

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'nagios_check_resque/failed_jobs_check'
+
+NagiosCheckResque::FailedJobsCheck.new.run

data/exe/nagios_check_resque_queue_sizes

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'nagios_check_resque/queue_size_check'
+
+NagiosCheckResque::QueueSizeCheck.new.run

data/lib/nagios_check_resque.rb

@@ -0,0 +1,5 @@
+require 'nagios_check_resque/version'
+
+module NagiosCheckResque
+  # Your code goes here...
+end

data/lib/nagios_check_resque/failed_jobs_check.rb

@@ -0,0 +1,29 @@
+require 'nagios_check'
+
+require 'resque'
+require 'resque/failure/redis'
+
+module NagiosCheckResque
+  # Warn if there are failed jobs
+  class FailedJobsCheck
+    include NagiosCheck
+
+    on '--redis-host HOST', default: 'redis://localhost:6379'
+
+    enable_warning
+    enable_critical
+    enable_timeout
+
+    def check
+      setup_resque
+      store_value(:failed, Resque::Failure::Redis.count)
+    end
+
+    private
+
+    def setup_resque
+      Resque.redis = Redis.new(host: options.redis_host)
+      Resque
+    end
+  end
+end

data/lib/nagios_check_resque/queue_size_check.rb

@@ -0,0 +1,42 @@
+require 'nagios_check'
+require 'resque'
+
+module NagiosCheckResque
+  # Prevent jobs from queuing up
+  class QueueSizeCheck
+    include NagiosCheck
+
+    on '--queues QUEUES', :mandatory
+    on '--redis-host HOST', default: 'redis://localhost:6379'
+
+    enable_warning
+    enable_critical
+    enable_timeout
+
+    def check
+      setup_resque
+
+      store_value(:max, queue_sizes.values.max)
+
+      queue_sizes.each do |name, size|
+        store_value(name, size)
+      end
+    end
+
+    private
+
+    def queue_sizes
+      @queue_sizes ||= queues.each_with_object({}) do |name, sizes|
+        sizes[name] = Resque.size(name)
+      end
+    end
+
+    def queues
+      options.queues.split(',')
+    end
+
+    def setup_resque
+      Resque.redis = Redis.new(host: options.redis_host)
+    end
+  end
+end

data/lib/nagios_check_resque/version.rb

@@ -0,0 +1,3 @@
+module NagiosCheckResque
+  VERSION = '1.0.0'.freeze
+end

data/nagios_check_resque.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nagios_check_resque/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nagios_check_resque'
+  spec.version       = NagiosCheckResque::VERSION
+  spec.authors       = ['Codevise Solutions Ltd']
+  spec.email         = ['info@codevise.de']
+
+  spec.summary       = 'Nagios plugin to check Resque queue sizes.'
+  spec.homepage      = 'http://github.com/codevise/nagios_check_resque'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'nagios_check', '~> 0.4.0'
+  spec.add_dependency 'resque', '~> 1.25'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: nagios_check_resque
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Codevise Solutions Ltd
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nagios_check
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+description: 
+email:
+- info@codevise.de
+executables:
+- nagios_check_resque_failed_jobs
+- nagios_check_resque_queue_sizes
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/nagios_check_resque_failed_jobs
+- exe/nagios_check_resque_queue_sizes
+- lib/nagios_check_resque.rb
+- lib/nagios_check_resque/failed_jobs_check.rb
+- lib/nagios_check_resque/queue_size_check.rb
+- lib/nagios_check_resque/version.rb
+- nagios_check_resque.gemspec
+homepage: http://github.com/codevise/nagios_check_resque
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Nagios plugin to check Resque queue sizes.
+test_files: []