sensu-plugins-sidekiq 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a375ef3a76158ce27ac3d734fee8ae44f4dcaa9
+  data.tar.gz: 8026eced0fa9fe0e884d89f8f85b490bc19d2abc
+SHA512:
+  metadata.gz: 1183cd2ba7acb60c719d113b08d577be1e6c4d4dddc75d98194c8d743c016ab667658cd898becbffccbf54a97d17bb297efbd6321e458ef93ad37179fdc3793d
+  data.tar.gz: b206c4264959a8918e4c710dad48408a4a4aace0a14548cae3bb42234331ce99aeba98cbc1812816fd734d7f0a2c1b922ca6ca17672414761a514ab60bbaa05a

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+#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.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,42 @@
+## 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. Requires [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.
+
+### 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`).
+
+## Files
+ * bin/check-sidekiq.rb
+ * bin/sidekiq-metris.rb
+
+## Usage
+
+## Installation
+
+[Installation and Setup](https://github.com/sensu-plugins/documentation/blob/master/user_docs/installation_instructions.md)
+
+## Notes

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 = 1
+
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

metadata

@@ -0,0 +1,234 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-sidekiq
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sensu-Plugins and contributors
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDgDCCAmigAwIBAgIBATANBgkqhkiG9w0BAQUFADBDMRIwEAYDVQQDDAltYXR0
+  am9uZXMxGDAWBgoJkiaJk/IsZAEZFgh5aWVsZGJvdDETMBEGCgmSJomT8ixkARkW
+  A2NvbTAeFw0xNTAxMjgyMTAyNTFaFw0xNjAxMjgyMTAyNTFaMEMxEjAQBgNVBAMM
+  CW1hdHRqb25lczEYMBYGCgmSJomT8ixkARkWCHlpZWxkYm90MRMwEQYKCZImiZPy
+  LGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAyTSzVYnO
+  CLgyrIyT1mBQakArQyW8xhi6MlDqyzXHJGeERT790U6EgoBVeS4XoK0ptFZNR8Tf
+  zko0w+Nv47TarSCgkPOaxY+mxWnAVR10dOmfeLr7huiMyps+YD56/EF2FqQ3jf/+
+  qohENfKD91qy1ieEy+Fn7Pf74ltbNKUdkb9a9eFXQ0DQ4ip5vik7DzjQkUTj4lca
+  k6ArwnmHX4YDhZoYtrQJ8jVktN0/+NtA40M5qkCYHNe5tUW25b/tKVYuioxG6b2Z
+  oIzaZxRLxf6HVAWpCVRT/F5+/yjigkX4u++eYacfLGleXQzoK7BL65vHGMJygWEE
+  0TKGqFOrl/L0AQIDAQABo38wfTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNV
+  HQ4EFgQUEf6a8Td7MrSZc8ImbLFZAENPbz0wIQYDVR0RBBowGIEWbWF0dGpvbmVz
+  QHlpZWxkYm90LmNvbTAhBgNVHRIEGjAYgRZtYXR0am9uZXNAeWllbGRib3QuY29t
+  MA0GCSqGSIb3DQEBBQUAA4IBAQBbzXAYA3BVGw8DZ0YYoY1VHPNEcH5qPIApmHO8
+  rvSmuUT0yMEi7u00H/5uHRFf4LleGT/+sTdyXKsNPGT9kdRuQEgwi+vf7Zfvd8aX
+  UF/+4VkEYf/8rV8Ere6u2QaWPgApdMV6JjKr1fAwCTd8AuGXNaWItiPPMseSQzLJ
+  JKP4hVvbc1d+oS925B1lcBiqn2aYvElbyNAVmQPywNNqkWmvtlqj9ZVJfV5HQLdu
+  8sHuVruarogxxKPBzlL2is4EUb6oN/RdpGx2l4254+nyR+abg//Ed27Ym0PkB4lk
+  HP0m8WSjZmFr109pE/sVsM5jtOCvogyujQOjNVGN4gz1wwPr
+  -----END CERTIFICATE-----
+date: 2015-06-27 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.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.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.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.30'
+- !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:
+- metrics-sidekiq.rb
+- check-sidekiq.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- 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.6
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for sidekiq
+test_files: []

metadata.gz.sig

@@ -0,0 +1,3 @@
+
+A7[��
XD�	�2$I7�)��D�������-ߥ
���|C��J�Ys��JB,�
+��M��z��6�Yi$���G�U�i�0)p[(w�*^b�M��p����B��3$��fU����6q�!�zc+C��+娰	FȂm#��|W?�P�O�P�R���7�xN�-}h�*�D�eĿ��ʋL����"���aT�7�&�����-V�V0��x�fl��.xh�L�� ڷ5���B2��;M�