is_my_sidekiq_ok 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e94d1eb329ad49eafdf8f5f6da9de711f72321bb9ecdb05baf51b0cfbebd488e
+  data.tar.gz: 6f7c7c5995bd098f8afb88740ad72afe7800042477187a97b91c9f355a93e9a4
+SHA512:
+  metadata.gz: 230193c7f8417fcc7e0f9702868f40484715db1e179d97af13460e05dc99a251fd04a5e183c8d9a4107d213a59d5c93e20647d91376268e0c6b8ef95b1ba6a5e
+  data.tar.gz: 510a547076e52b9c6a298faf57b2b2ffd23f88ed5b07af30aa9ea6cf25fa21c18ee93dcca82ae3d7b1265d5e18fea3dc0664ff654e01bf7ec2b83b8a61d8dec1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Sampo Kuokkanen
+
+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,60 @@
+# IsMySidekiqOk
+
+IsMySidekiqOk answers the question: is your Sidekiq ok? 
+Define limits, and then if Sidekiq is running within those limits, you get a :success 200 response, otherwise you get a 500 error response.
+Can be used with Rails > 5.2. 
+*You can customize the response code. 
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'is_my_sidekiq_ok'
+```
+
+Mount the engine to get the route (`routes.rb`):
+
+```ruby
+mount IsMySidekiqOk::Engine => '/is_my_sidekiq_ok'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install is_my_sidekiq_ok
+```
+
+And now just hit that endpoint! 
+
+Though you'll probably also want to configure the gem. 
+This gem has the following settings: 
+
+```ruby
+# success
+setting :status_symbol, :ok
+# failior
+setting :error_symbol, :internal_server_error
+# Sidekiq instances running, fail if below this
+setting :processes_size, 4
+# below values will cause check to fail if exceeded
+setting :default_queue_latency, 30
+setting :workers_size, 0
+setting :enqueued, 50
+
+# name and password for basic auth
+setting :name 
+setting :password
+```
+
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/is_my_sidekiq_ok/application_controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module IsMySidekiqOk
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/is_my_sidekiq_ok/sidekiq_ok_controller.rb

@@ -0,0 +1,29 @@
+require 'sidekiq/api'
+
+module IsMySidekiqOk
+  class SidekiqOkController < ApplicationController
+    if IsMySidekiqOk.config.name.present? &&
+       IsMySidekiqOk.config.password.present?
+      http_basic_authenticate_with name: IsMySidekiqOk.config.name,
+                                   password: IsMySidekiqOk.config.password
+    end
+
+    def index
+      if IsMySidekiqOk.ok?(sidekiq_stats)
+        head IsMySidekiqOk.config.status_symbol
+      else
+        head IsMySidekiqOk.config.error_symbol
+      end
+    end
+
+    def stats
+      render json: sidekiq_stats
+    end
+
+    private
+
+    def sidekiq_stats
+      ::Sidekiq::Stats.new.fetch_stats!
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+IsMySidekiqOk::Engine.routes.draw do
+  get '/', to: 'sidekiq_ok#index'
+  get '/stats', to: 'sidekiq_ok#stats'
+end

data/lib/is_my_sidekiq_ok.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'is_my_sidekiq_ok/version'
+require 'is_my_sidekiq_ok/engine'
+require 'dry-configurable'
+
+# IsMySidekiqOk checks whether Sidekiq is running and is working
+# within the parameters specified in the initializer.
+module IsMySidekiqOk
+  extend Dry::Configurable
+  extend self
+
+  setting :status_symbol, :ok
+  setting :error_symbol, :internal_server_error
+  setting :processes_size, 4
+  setting :default_queue_latency, 30
+  setting :workers_size, 0
+  setting :enqueued, 50
+
+  setting :name
+  setting :password
+
+  SETTINGS = %i[processes_size].freeze
+
+  # TODO refactor this
+  def ok?(stats)
+    return false if SETTINGS.any? { |setting| stats[setting] <= IsMySidekiqOk.config.send(setting) }
+
+    return false if stats[:default_queue_latency] >= IsMySidekiqOk.config.default_queue_latency
+
+    return false if stats[:enqueued] >= IsMySidekiqOk.config.enqueued
+
+    return false if stats[:workers_size] >= IsMySidekiqOk.config.enqueued
+
+    true
+  end
+end

data/lib/is_my_sidekiq_ok/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module IsMySidekiqOk
+  class Engine < ::Rails::Engine
+    isolate_namespace IsMySidekiqOk
+  end
+end

data/lib/is_my_sidekiq_ok/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module IsMySidekiqOk
+  VERSION = '0.1.0'
+end

data/lib/tasks/is_my_sidekiq_ok_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :is_my_sidekiq_ok do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: is_my_sidekiq_ok
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sampo Kuokkanen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: Define limits and see if Sidekiq is running within those.
+email:
+- sampo.kuokkanen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/is_my_sidekiq_ok/application_controller.rb
+- app/controllers/is_my_sidekiq_ok/sidekiq_ok_controller.rb
+- config/routes.rb
+- lib/is_my_sidekiq_ok.rb
+- lib/is_my_sidekiq_ok/engine.rb
+- lib/is_my_sidekiq_ok/version.rb
+- lib/tasks/is_my_sidekiq_ok_tasks.rake
+homepage: https://github.com/sampokuokkanen/is_my_sidekiq_ok
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sampokuokkanen/is_my_sidekiq_ok
+  source_code_uri: https://github.com/sampokuokkanen/is_my_sidekiq_ok
+  changelog_uri: https://github.com/sampokuokkanen/is_my_sidekiq_ok/blob/main/CHANGELOG.md
+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: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Is your Sidekiq ok? This gem tells you.
+test_files: []