sensu-plugins-sidekiq-latency 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c97151db3884ed62711b8cc25926f18c8c7c4361
+  data.tar.gz: 96a95c4d0e436860355ca2f2228f7cfbaeebbf14
+SHA512:
+  metadata.gz: 97dee28288e91bff47d1f2b55086280d8cdb065e3d82288b02cc29807292bd9db5edaa3ba684141384b75c580dd5c39e5e437dccdcda75cf6901a4211457f9ab
+  data.tar.gz: 2fae930576d68f937cda30db4e846019d584a461bf02c6e2ab2cbcb60f255f145d147990280df7184067d1a787b96d72e5ad450861db6abe05e8961f72d3c611

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.3.0
+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 sensu-plugin-sidekiq-latency.gemspec
+gemspec

data/README.md

@@ -0,0 +1,31 @@
+# sensu-plugins-sidekiq-latency
+
+This is a Sensu plugin that allows monitoring and alerting if the latency of
+a Sidekiq queue exceeds a threshold value. It talks directly to Redis, so that
+it doesn't need to authenticate to the Sidekiq web interface.
+
+# Installation
+
+Or install it yourself as:
+
+    $ gem install sensu-plugins-sidekiq-latency
+
+# Functionality
+
+## check-sidekiq-latency.rb
+Checks the latency for a particular sidekiq queue, and warns if it exceeds thresholds.
+
+- `--url` or `-u` - **required** URL of the Redis instance that Sidekiq is using.
+- `--queue` or `-q` - **required** name of the sidekiq queue to monitor.
+- `--warn` or `-w` - threshold (in seconds) for a warning to be issued.
+- `--crit` or `-c` - threshold (in seconds) for a critical alert to be sent.
+
+## 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/chartmogul/sensu-plugin-sidekiq-latency. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

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/check-sidekiq-latency.rb

@@ -0,0 +1,79 @@
+#! /usr/bin/env ruby
+# encoding: UTF-8
+
+require 'sensu-plugin/check/cli'
+require 'sidekiq/api'
+require 'open-uri'
+require 'json'
+
+#   check-sidekiq-latency
+#
+# DESCRIPTION:
+#   Checks a particular sidekiq queue for maximum latency
+#
+#     https://github.com/chartmogul/sensu-plugin-sidekiq-latency
+#
+#   Returns warning/critical if latency exceeds certain thresholds
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sidekiq
+#   gem: sensu-plugin
+#   gem: open-uri
+#   gem: json
+#
+# LICENSE:
+#   Jason Langenauer <jason@chartmogul.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+class SidekiqLatencyCheck < Sensu::Plugin::Check::CLI
+  option :redis_url,
+         short: '-u URL',
+         long: '--url URL',
+         description: 'Redis URL to query',
+         required: true
+
+   option :queue,
+          short: '-q QUEUE',
+          long: '--queue QUEUE',
+          description: 'Queue with latency to check',
+          required: true
+
+   option :warn,
+          short: '-w SECONDS',
+          long: '--warn SECONDS',
+          description: 'Warn after any job has been SECONDS seconds in the queue',
+          proc: proc { |seconds| seconds.to_i },
+          default: 120
+
+   option :crit,
+          short: '-c SECONDS',
+          long: '--crit SECONDS',
+          description: 'Critical after any job has been SECONDS seconds in the queue',
+          proc: proc { |seconds| seconds.to_i },
+          default: 300
+
+   def run
+     begin
+       Sidekiq.configure_client do |sidekiq_config|
+        sidekiq_config.redis = { url: config[:url] }
+       end
+
+       latency = Sidekiq::Queue.new(config[:queue]).latency.to_i
+
+       if latency > config[:warn]
+         warning "The latency of Sidekiq queue '#{config[:queue]}' is more than #{config[:warn]} seconds"
+       elsif latency > config[:crit]
+         critical "The latency of Sidekiq queue '#{config[:queue]}' is more than #{config[:crit]} seconds"
+       end
+
+       ok "Maximum latency for Sidekiq queue '#{config[:queue]}' is less than #{config[:warn]} seconds"
+
+     rescue => error
+        unknown "Could not load Sidekiq stats from #{config[:url]}. Error: #{error}"
+     end
+   end
+end

data/lib/latency.rb

@@ -0,0 +1 @@
+require "sensu-plugin-sidekiq-latency/version"

data/lib/sensu-plugin-sidekiq-latency/version.rb

@@ -0,0 +1,3 @@
+module SensuPluginSidekiqLatency
+  VERSION = "0.1.1"
+end

data/sensu-plugins-sidekiq-latency.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sensu-plugin-sidekiq-latency/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sensu-plugins-sidekiq-latency'
+  spec.version       = SensuPluginSidekiqLatency::VERSION
+  spec.authors       = ['Jason Langenauer']
+  spec.email         = ['jason@chartmogul.com']
+
+  spec.summary       = %q{Sensu Plugin to alert on Sidekiq latency of a particular queue}
+  spec.description   = %q{Sensu Plugin to alert on Sidekiq latency of a particular queue}
+  spec.homepage      = 'https://github.com/chartmogul/sensu-plugin-sidekiq-latency'
+
+  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_dependency 'sensu-plugin', '~> 1.2'
+  spec.add_dependency 'sidekiq', '>= 3.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-sidekiq-latency
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jason Langenauer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Sensu Plugin to alert on Sidekiq latency of a particular queue
+email:
+- jason@chartmogul.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/check-sidekiq-latency.rb
+- lib/latency.rb
+- lib/sensu-plugin-sidekiq-latency/version.rb
+- sensu-plugins-sidekiq-latency.gemspec
+homepage: https://github.com/chartmogul/sensu-plugin-sidekiq-latency
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Sensu Plugin to alert on Sidekiq latency of a particular queue
+test_files: []
+has_rdoc: