sensu-plugins-sidekiq-donotuse 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6239fe800e383290df13a793af86f75258ed135d
+  data.tar.gz: b7bdc502783b493553f212348a75db66151a7454
+SHA512:
+  metadata.gz: 8c9fede9d4874419194ec0ca3d66443f04c90870d4e45f9a9ac825a33416435211b5555a3f9697422fffafe193fd905a95cc3169b69190b0f6888866a728ea22
+  data.tar.gz: b2893ab4fee20b340c6ca48e9fdf4ea5de88fcdf33514684bbc2e3c06c88d2c892c9f018113e2f6f60fc0be664c8f7d92919bd3665857e18fa5b5e7b455e3a71

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+#Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
+
+## [Unreleased][unreleased]
+
+
+## [0.0.3] - 2015-11-04
+### Added
+- new script `check-sidekiq-dead-queue.rb`
+
+## [0.0.2] - 2015-07-14
+### Changed
+- updated sensu-plugin gem to 1.2.0
+
+## [0.0.1] - 2015-06-27
+### Added
+- initial release

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sensu-Plugins
+
+MIT License
+
+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,61 @@
+## Sensu-Plugins-sidekiq
+
+[![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-sidekiq.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-sidekiq)
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-sidekiq.svg)](http://badge.fury.io/rb/sensu-plugins-sidekiq)
+[![Code Climate](https://codeclimate.com/github/sensu-plugins/sensu-plugins-sidekiq/badges/gpa.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-sidekiq)
+[![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-sidekiq/badges/coverage.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-sidekiq)
+[![Dependency Status](https://gemnasium.com/sensu-plugins/sensu-plugins-sidekiq.svg)](https://gemnasium.com/sensu-plugins/sensu-plugins-sidekiq)
+[![Codeship Status for sensu-plugins/sensu-plugins-sidekiq](https://codeship.com/projects/807ab0e0-edcd-0132-0ba1-1efd3f886df2/status?branch=master)](https://codeship.com/projects/84126)
+
+## Functionality
+
+Check varius metrics and checks for Sidekiq.
+The following scripts:
+
+ * bin/check-sidekiq.rb
+ * bin/sidekiq-metrics.rb
+ 
+require [sidekiq-monitor-stats](https://github.com/harvesthq/sidekiq-monitor-stats)
+running on your application. Pass the `--url URL` option with the url to your monitor stats. Both scripts also accept a
+`--auth USER:PASSWORD` option in case the monitor stats url sits behind basic authorization.
+
+ * bin/check-sidekiq-dead-queue.rb
+uses the native sidekiq JSON dashboard under `<mount point>/dashboard/stats`
+[More info](https://github.com/mperham/sidekiq/wiki/Monitoring#using-the-built-in-dashboard)
+
+
+### check-sidekiq.rb
+
+Uses the maximum latency to figure out when to raise warnings. The latency is the time a job has been waiting in the queue (without
+being processed). It's generally a good metric to know when there's trouble with Sidekiq. There are some options you can pass to this
+script:
+
+* `--warn SECONDS`: Warn after job has been SECONDS seconds in a queue. The default is 120.
+* `--crit SECONDS`: Critical after job has been SECONDS seconds in a queue. The default is 300.
+
+### sidekiq-metrics.rb
+
+Generates total concurrency (`concurrency`), total busy (`busy`) and maximum latency (`latency`) metrics for your sidekiq. A graph of
+busy vs. concurrency is specially useful for capacity planning. The latency metric should let you know if something is wrong (or there
+are spikes that don't trigger a warning or a critical). Accepts an `--scheme SCHEME` option to know what scheme to append to the
+metrics (the default is `sidekiq`).
+
+
+### check-sidekiq-dead-queue.rb
+Checks the dead queue and raises a CRITICAL if it's not empty. Jobs in the dead queue have failed over 25 times. Some organisations might consider this an issue to address and could benefit from this check.
+
+
+## Files
+ * bin/check-sidekiq.rb
+ * bin/sidekiq-metrics.rb
+ * bin/check-sidekiq-dead-queue.rb
+
+## Usage
+
+## Installation
+
+[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
+
+## Notes
+
+Thanks to [xxxxxx]() for contributing.

data/bin/check-sidekiq-dead-queue.rb

@@ -0,0 +1,55 @@
+#! /usr/bin/env ruby
+# encoding: UTF-8
+
+require 'sensu-plugin/check/cli'
+require 'open-uri'
+require 'json'
+
+# DESCRIPTION:
+#   Check that the sidekiq dead queue size is 0 using the sidekiq
+#   stats JSON page under
+#   /sidekiq/dashboard/stats
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: open-uri
+#   gem: json
+#
+# LICENSE:
+#   by https://github.com/bennythejudge
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+class SidekiqCheck < Sensu::Plugin::Check::CLI
+  option :url,
+         short: '-u URL',
+         long: '--url URL',
+         description: 'Url to query',
+         required: true
+
+  option :auth,
+         short: '-a USER:PASSWORD',
+         long: '--auth USER:PASSWORD',
+         description: 'Basic auth credentials if you need them',
+         proc: proc { |auth| auth.split(':') }
+
+  def run
+    begin
+      stats = JSON.parse(
+        if config[:auth]
+          open(config[:url], http_basic_authentication: config[:auth]).read
+        else
+          open(config[:url]).read
+        end
+      )
+    rescue => error
+      unknown "Could not load Sidekiq stats from #{config[:url]}. Error: #{error}"
+    end
+    dead_queue_size = stats['sidekiq']['dead']
+    if !dead_queue_size.zero?
+      entry_or_entries =  dead_queue_size > 1 ? 'entries' : 'entry'
+      critical 'dead queue not empty (' + dead_queue_size.to_s + ' ' + entry_or_entries + ')'
+    else
+      ok 'sidekiq dead queue is empty'
+    end
+  end
+end

data/bin/check-sidekiq.rb

@@ -0,0 +1,87 @@
+#! /usr/bin/env ruby
+# encoding: UTF-8
+
+require 'sensu-plugin/check/cli'
+require 'open-uri'
+require 'json'
+
+#   check-sidekiq
+#
+# DESCRIPTION:
+#   Check sidekiq status from a sidekiq-monitor-stats enabled endpoint.
+#
+#     https://github.com/harvesthq/sidekiq-monitor-stats
+#
+#   Uses the maximum latency to check the status.
+#
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: open-uri
+#   gem: json
+#
+# LICENSE:
+#   Albert Llop albert@getharvest.com
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+class SidekiqCheck < Sensu::Plugin::Check::CLI
+  option :url,
+         short: '-u URL',
+         long: '--url URL',
+         description: 'Url to query',
+         required: true
+
+  option :auth,
+         short: '-a USER:PASSWORD',
+         long: '--auth USER:PASSWORD',
+         description: 'Basic auth credentials if you need them',
+         proc: proc { |auth| auth.split(':') }
+
+  option :warn,
+         short: '-w SECONDS',
+         long: '--warn SECONDS',
+         description: 'Warn after job has been SECONDS seconds in a queue',
+         proc: proc { |seconds| seconds.to_i },
+         default: 120
+
+  option :crit,
+         short: '-c SECONDS',
+         long: '--crit SECONDS',
+         description: 'Critical after job has been SECONDS seconds in a queue',
+         proc: proc { |seconds| seconds.to_i },
+         default: 300
+
+  def run
+    begin
+      stats = JSON.parse(
+        if config[:auth]
+          open(config[:url], http_basic_authentication: config[:auth]).read
+        else
+          open(config[:url]).read
+        end
+      )
+
+    rescue => error
+      unknown "Could not load Sidekiq stats from #{config[:url]}. Error: #{error}"
+    end
+
+    maximum_latency   = stats['queues'].map { |_name, data| data['latency'] }.max
+    total_concurrency = stats['processes'].map { |process| process['concurrency'] }.reduce(&:+) || 0
+
+    if total_concurrency.zero?
+      critical 'There are no Sidekiq workers'
+    end
+
+    if maximum_latency > config[:warn]
+      warning "A job has been in a queue longer than #{config[:warn]} seconds"
+    elsif maximum_latency > config[:crit]
+      critical "A job has been in a queue longer than #{config[:crit]} seconds"
+    end
+
+    ok "Maximum job latency #{maximum_latency}"
+  end
+end

data/bin/metrics-sidekiq.rb

@@ -0,0 +1,74 @@
+#! /usr/bin/env ruby
+# encoding: UTF-8
+
+require 'sensu-plugin/metric/cli'
+require 'open-uri'
+require 'json'
+
+#   sidekiq-metrics
+#
+# DESCRIPTION:
+#   Pull sidekiq metrics from a sidekiq-monitor-stats enabled endpoint.
+#
+#     https://github.com/harvesthq/sidekiq-monitor-stats
+#
+# OUTPUT:
+#   metric data
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: open-uri
+#   gem: json
+#
+# LICENSE:
+#   Albert Llop albert@getharvest.com
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+class SidekiqMetrics < Sensu::Plugin::Metric::CLI::Graphite
+  option :url,
+         short: '-u URL',
+         long: '--url URL',
+         description: 'Url to query',
+         required: true
+
+  option :auth,
+         short: '-a USER:PASSWORD',
+         long: '--auth USER:PASSWORD',
+         description: 'Basic auth credentials if you need them',
+         proc: proc { |auth| auth.split(':') }
+
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to metric',
+         short: '-s SCHEME',
+         long: '--scheme SCHEME',
+         default: 'sidekiq'
+
+  def run
+    begin
+      stats = JSON.parse(
+        if config[:auth]
+          open(config[:url], http_basic_authentication: config[:auth]).read
+        else
+          open(config[:url]).read
+        end
+      )
+
+    rescue => error
+      unknown "Could not load sidekiq stats from #{config[:url]}. Error: #{error}"
+    end
+
+    total_concurrency = stats['processes'].map { |process| process['concurrency'] }.reduce(&:+) || 0
+    total_busy        = stats['processes'].map { |process| process['busy'] }.reduce(&:+) || 0
+    maximum_latency   = stats['queues'].map { |_name, data| data['latency'] }.max
+
+    output "#{config[:scheme]}.concurrency", total_concurrency
+    output "#{config[:scheme]}.busy",        total_busy
+    output "#{config[:scheme]}.latency",     maximum_latency
+
+    ok
+  end
+end

data/lib/sensu-plugins-sidekiq.rb

@@ -0,0 +1 @@
+require 'sensu-plugins-sidekiq/version'

data/lib/sensu-plugins-sidekiq/version.rb

@@ -0,0 +1,10 @@
+module SensuPluginsSidekiq
+  # This defines the version of the gem
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 3
+
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-sidekiq-donotuse
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Sensu-Plugins and contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.32.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.32.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Sensu sidekiq plugins
+email: "<sensu-users@googlegroups.com>"
+executables:
+- check-sidekiq-dead-queue.rb
+- check-sidekiq.rb
+- metrics-sidekiq.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/check-sidekiq-dead-queue.rb
+- bin/check-sidekiq.rb
+- bin/metrics-sidekiq.rb
+- lib/sensu-plugins-sidekiq.rb
+- lib/sensu-plugins-sidekiq/version.rb
+homepage: https://github.com/sensu-plugins/sensu-plugins-sidekiq
+licenses:
+- MIT
+metadata:
+  maintainer: sensu-plugin
+  development_status: active
+  production_status: unstable - testing recommended
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: You can use the embedded Ruby by setting EMBEDDED_RUBY=true
+  in /etc/default/sensu
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for sidekiq
+test_files: []
+has_rdoc: