sidekiq-process-health-check 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b2ab7bc6b5a45bba9a808f418dfb80da5cdf933a
+  data.tar.gz: 0fe587a50f012a909e7939736ce2316ddfe1be53
+SHA512:
+  metadata.gz: 9fe37bacd7d3f45dcf6ffbc69b96afeb418cac0fbbf2a8acf9096fc08a37d90de443af61876118af6f128023450ef8160c13046974c7796ae8f768386ad32ef7
+  data.tar.gz: a704b4793ffbdaa0295186382719b12b79f46b039765682e1cb5457533d784a00e68471e9cc1093ea60fec5d5617482e59679dc54a8e5b57af6c66ed9305fe78

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+task :default => :spec
+RSpec::Core::RakeTask.new

data/app/controllers/concerns/sidekiq/process_health/check/application_controller.rb

@@ -0,0 +1,11 @@
+module Sidekiq
+  module ProcessHealth
+    module Check
+      class ApplicationController < ActionController::Base
+        # Prevent CSRF attacks by raising an exception.
+        # For APIs, you may want to use :null_session instead.
+        protect_from_forgery with: :exception
+      end
+    end
+  end
+end

data/app/controllers/concerns/sidekiq/process_health/check/controller.rb

@@ -0,0 +1,35 @@
+module Sidekiq
+  module ProcessHealth
+    module Check
+      module Controller
+        extend ActiveSupport::Concern
+        include Sidekiq::ProcessHealth::Check
+
+        def show
+          render plain: [process_status, queue_status]
+        end
+
+        private
+          def process_status
+            process_size = number_of_active_processes
+            process_size_details = t('process_size', process_size: process_size, max_process_size: Sidekiq::ProcessHealth::Check.configuration.expected_number_of_processes)
+            if process_size == Sidekiq::ProcessHealth::Check.configuration.expected_number_of_processes
+              t('ok', message: process_size_details)
+            else
+              t('warning.unexpected_number_of_processes', message: process_size_details)
+            end
+          end
+
+          def queue_status
+            queue_size = number_of_enqueued_jobs
+            queue_size_details = t('queue_size', queue_size: queue_size, job_threshold: Sidekiq::ProcessHealth::Check.configuration.job_threshold)
+            if queue_size < Sidekiq::ProcessHealth::Check.configuration.job_threshold
+              t('ok', message: queue_size_details)
+            else
+              t('warning.too_many_jobs_enqueued', message: queue_size_details)
+            end
+          end
+      end
+    end
+  end
+end

data/app/controllers/concerns/sidekiq/process_health/check/mountable_controller.rb

@@ -0,0 +1,10 @@
+module Sidekiq
+  module ProcessHealth
+    module Check
+      class MountableController < ApplicationController
+        respond_to :json
+        include Sidekiq::ProcessHealth::Check::Controller
+      end
+    end
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,7 @@
+en:
+  process_size: "Process size: %{process_size} / %{max_process_size}"
+  queue_size: "Queue size: %{queue_size} / %{job_threshold}"
+  ok: "OK. %{message}"
+  warning:
+    too_many_jobs_enqueued: "WARNING. Too many jobs enqueued. %{message}"
+    unexpected_number_of_processes: "WARNING. Unexpected number of processes. %{message}"

data/config/routes.rb

@@ -0,0 +1,4 @@
+Sidekiq::ProcessHealth::Check::Engine.routes.draw do
+  get '/health/sidekiq', to: 'mountable#show'
+  root to: 'mountable#show'
+end

data/lib/sidekiq/process_health/check.rb

@@ -0,0 +1,43 @@
+require 'sidekiq/process_health/check/version'
+require 'sidekiq/process_health/check/engine'
+require 'sidekiq/process_health/check/configuration'
+require 'sidekiq/api'
+
+module Sidekiq
+  module ProcessHealth
+    module Check
+
+      class << self
+        attr_writer :configuration
+
+        def configuration
+          @configuration ||= Configuration.new
+        end
+
+        def reset
+          @configuration = Configuration.new
+        end
+
+        def configure
+          yield(configuration)
+        end
+      end
+
+      def number_of_active_processes
+        retrieve_active_processes.size
+      end
+
+      def number_of_enqueued_jobs
+        Sidekiq::Queue.new.size
+      end
+
+      def retrieve_active_processes
+        processes = []
+        Sidekiq::ProcessSet.new.each do |process|
+          processes << process
+        end
+        processes
+      end
+    end
+  end
+end

data/lib/sidekiq/process_health/check/configuration.rb

@@ -0,0 +1,18 @@
+module Sidekiq
+  module ProcessHealth
+    module Check
+      class Configuration
+        DEFAULT_EXPECTED_PROCESS_NUMBER = 1
+
+        DEFAULT_JOB_THRESHOLD = 50
+
+        attr_accessor :expected_number_of_processes, :job_threshold
+
+        def initialize
+          @expected_number_of_processes = DEFAULT_EXPECTED_PROCESS_NUMBER
+          @job_threshold = DEFAULT_JOB_THRESHOLD
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/process_health/check/engine.rb

@@ -0,0 +1,10 @@
+module Sidekiq
+  module ProcessHealth
+    module Check
+      class Engine < ::Rails::Engine
+        isolate_namespace Sidekiq::ProcessHealth::Check
+        require 'responders'
+      end
+    end
+  end
+end

data/lib/sidekiq/process_health/check/version.rb

@@ -0,0 +1,7 @@
+module Sidekiq
+  module ProcessHealth
+    module Check
+      VERSION = '0.0.6'.freeze
+    end
+  end
+end

metadata

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-process-health-check
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- isuPatches
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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'
+- !ruby/object:Gem::Dependency
+  name: capybara-webkit
+  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'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: launchy
+  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'
+- !ruby/object:Gem::Dependency
+  name: listen
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: A gem that when configured and used properly will provide a page displaying
+  if the sidekiq processes are within expected operating parameters
+email:
+- isuPatches@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- app/controllers/concerns/sidekiq/process_health/check/application_controller.rb
+- app/controllers/concerns/sidekiq/process_health/check/controller.rb
+- app/controllers/concerns/sidekiq/process_health/check/mountable_controller.rb
+- config/locales/en.yml
+- config/routes.rb
+- lib/sidekiq/process_health/check.rb
+- lib/sidekiq/process_health/check/configuration.rb
+- lib/sidekiq/process_health/check/engine.rb
+- lib/sidekiq/process_health/check/version.rb
+homepage: https://github.com/isuPatches/sidekiq-process-health-check
+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.10
+signing_key: 
+specification_version: 4
+summary: A gem that when configured and used properly will provide a page displaying
+  if the sidekiq processes are within expected operating parameters
+test_files: []