sidekiq-heartbeat_monitor 1.0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a08a4ffbf513523621124605615a5a4ba96d93a
+  data.tar.gz: c6cae1bb4cf1b39ba73f430225ef72a83f62ccc9
+SHA512:
+  metadata.gz: 59567a1a5708c62811a3d7f55d81cba26aab7af8e3b35342ce7ea1834f3b59a2caf546afe7c984d44dba6e209018bbf737e8d4f6239b684be268bd4c44a65bc5
+  data.tar.gz: b964767137636d41e651e8d76f8c948163c32da3222c3efc7c83bb056e05c1f56c8581c55ba354112a45ea46dd1faeb33f1e83e75877d4ffade3734e08fd5c8e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/.idea
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+/*.gem

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+ - "2.1.0"
+ - "2.2.3"
+script: 'bundle exec rake'
+notifications:
+  email:
+    on_success: never

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at najibkaake@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activemodel_flags.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jay El-Kaake
+
+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,86 @@
+# Sidekiq Heartbeat Montior Gem
+
+This gem adds 2 things:
+1. A lightweight heartbeat task that runs every few minutes and alerts if it takes longer than a few seconds to start.
+2. A scheduler task that periodically checks the size of each sidekiq queue to ensure no queues are backed up.
+
+**Table of Contents**
+* [Installation](#installation)
+* [Configuration](#configuration)
+* [Other Things](#Other_Things)
+
+# Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'sidekiq-heartbeat_monitor'
+```
+And then execute:
+    $ bundle
+Or install it yourself as:
+    $ gem install sidekiq-heartbeat_monitor
+
+**Configuration is required - see the Configuration section below**
+
+### Requirements
+1. [Dont Repeat For Gem](https://www.github.com/jayelkaake/dont_repeat_for) - To allow you to only send notifications every so often.
+2. Redis
+3. (optional) [SlackNotifier](https://github.com/stevenosloan/slack-notifier) - If you're using slack notifications then this is needed.
+
+# Configuration
+### STEP 1. Create slack webhook
+To add a webhook to your slack account, go to: https://api.slack.com/incoming-webhooks
+Make note of the URL or add it to your environment and note the name.
+
+### STEP 2. Add Initializer
+
+To configure with a simple slack webhook notification URL, simply specify the notification URL in the "slack_notifier_url" attribute.
+
+##### 2. Option 1 - Simple notification
+```ruby
+# config/initializers/sidekiq/hearbeat_monitor.rb
+Sidekiq::HeartbeatMonitor.configure(slack_notifier_url: ENV['SLACK_WEBHOOK_URL'])
+```
+
+##### 2. Option 2 - Dont Repeat For
+```ruby
+# config/initializers/sidekiq/hearbeat_monitor.rb
+Sidekiq::HeartbeatMonitor.configure(
+    slack_notifier_url: ENV['SLACK_WEBHOOK_URL'],
+    dont_repeat_for: 15.minutes # Won't repeat the notifications for the same queue more than once every 15 minutes.
+)
+```
+
+##### 2. Option 2 - Custom Alert Method
+```ruby
+# config/initializers/sidekiq/hearbeat_monitor.rb
+Sidekiq::HeartbeatMonitor.configure(
+    on_backed_up: -> (msg, queue) { Rails.logger.log("Queue #{queue.name} is backed up!"); },
+    on_slowed_down: -> (msg, queue) { Rails.logger.log("Queue #{queue.name} is being slow!"); },
+)
+```
+
+**Note:** `on_backed_up` and `on_slowed_down` accept an array and will always add to existing callbacks (you can combine `slack_notiifer_url` with them)
+
+### STEP 3. Schedule recurring task
+If you're using sidekiq-cron, add this to your `config/scheduler.yml` file:
+```yml
+sidekiq_heartbeat_monitor:
+  cron: "*/15 * * * * *" # Heart beat runs every 15 seconds in this case
+  class: "Sidekiq::HeartbeatMonitor::Scheduler"
+  queue: scheduler
+```
+
+## Testing Your Config
+To test your config:
+1. Open your rails console.
+2. Run `Sidekiq::HeartbeatMontior.send_test!` and you should see notifications come up in your Slack (or however you have them configured). If there's something wrong it should show an error.
+
+
+# Other Things
+### Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/jayelkaake/sidekiq-heartbeat_monitor.
+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.
+
+### License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activemodel_flags"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/sidekiq/heartbeat_monitor.rb

@@ -0,0 +1,29 @@
+require "sidekiq"
+require 'sidekiq/heartbeat_monitor/version'
+require 'sidekiq/heartbeat_monitor/config'
+require 'sidekiq/heartbeat_monitor/scheduler'
+require 'sidekiq/heartbeat_monitor/worker'
+
+module Sidekiq
+  module HeartbeatMonitor
+    def self.configure(*args, &block)
+      Config.configure(*args, &block)
+    end
+
+    def self.send_backed_up_alert(*args, &block)
+      Config.send_backed_up_alert(*args, &block)
+    end
+
+    def self.send_slowed_down_alert(*args, &block)
+      Config.send_slowed_down_alert(*args, &block)
+    end
+
+    def self.send_test!
+      test_queue = Sidekiq::Queue.new('test')
+
+      send_backed_up_alert("Test backed up alert!", test_queue)
+      send_slowed_down_alert("Test slowed down alert!", test_queue)
+    end
+  end
+end
+

data/lib/sidekiq/heartbeat_monitor/config.rb

@@ -0,0 +1,65 @@
+module Sidekiq
+  module HeartbeatMonitor
+    class Config
+      class << self
+        def configure(max_queue_size: nil, on_backed_up: nil, on_slowed_down: nil, dont_repeat_for: nil, slack_notifier_url: nil)
+          @max_queue_size = max_queue_size unless max_queue_size.nil?
+
+          @dont_repeat_for = dont_repeat_for unless dont_repeat_for.nil?
+
+          @on_backed_up = (on_backed_up.is_a?(Enumerable) ? on_backed_up : [on_backed_up]) unless on_backed_up.nil?
+          @on_slowed_down = (on_slowed_down.is_a?(Enumerable) ? on_slowed_down : [on_slowed_down]) unless on_slowed_down.nil?
+
+          if slack_notifier_url.present?
+            @notifier = Slack::Notifier.new(slack_notifier_url)
+
+            slack_notifier_callback = [-> (msg, queue) { @notifier.ping(msg) }]
+
+            @on_backed_up = @on_backed_up.to_a + slack_notifier_callback
+            @on_slowed_down = @on_slowed_down.to_a + slack_notifier_callback
+          end
+        end
+
+        def send_test!
+          test_queue = Sidekiq::Queue.new('test')
+          send_backed_up_alert("Test backed up alert!", test_queue)
+          send_slowed_down_alert("Test slowed down alert!", test_queue)
+        end
+
+        def send_backed_up_alert(message, q)
+          if @on_backed_up.blank?
+            puts ("WARNING: No 'on_backed_up' callback defined for sidekiq-heartbeat_monitor but one of the queues are backed up: #{message}")
+            return
+          end
+
+          if @dont_repeat_for.nil?
+            @on_backed_up.to_a.each { |alert| alert.call(message, q) }
+          else
+            DontRepeatFor.new(@dont_repeat_for, "Sidekiq/HeartbeatMonitor/#{q.name}/send_backed_up_alert") do
+              @on_backed_up.to_a.each { |alert| alert.call(message, q) }
+            end
+          end
+        end
+
+        def send_slowed_down_alert(message, q)
+          if @on_slowed_down.blank?
+            puts ("WARNING: No 'on_slowed_down' callback defined for sidekiq-heartbeat_monitor but one of the queues are backed up: #{message}")
+            return
+          end
+
+          if @dont_repeat_for.nil?
+            @on_slowed_down.to_a.each { |alert| alert.call(message, q) }
+          else
+            DontRepeatFor.new(@dont_repeat_for, "Sidekiq/HeartbeatMonitor/#{q.name}/send_slowed_down_alert") do
+              @on_slowed_down.to_a.each { |alert| alert.call(message, q) }
+            end
+          end
+        end
+
+        def max_queue_size
+          @max_queue_size || ENV.fetch('SIDEKIQ_MONITOR_MAX_QUEUE_SIZE', 5000).to_i
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/heartbeat_monitor/scheduler.rb

@@ -0,0 +1,33 @@
+module Sidekiq
+  module HeartbeatMonitor
+    class Scheduler
+      include Sidekiq::Worker
+      sidekiq_options retry: 0
+
+      ##
+      # Checks to see if queues are backed up by 1000 or more jobs and also schedules the heartbeat job.
+      def perform
+        Sidekiq::Queue.all.each do |q|
+          check_queue_size(q, Sidekiq::HeartbeatMonitor::Config.max_queue_size)
+
+          Sidekiq::HeartbeatMonitor::Worker.perform_async(q.name, 15)
+        end
+      end
+
+      def check_queue_size(q, max_queue_size)
+        if q.size > max_queue_size
+          send_server_alert("⚠️ Queue #{q.name} has more than #{max_queue_size} jobs waiting to be processed. Current size is #{q.size}", q)
+        end
+      end
+
+      ##
+      # @param msg [String] Message to post
+      # @param queue_name [Sidekiq::Queue] Queue we're concerned with
+      def send_server_alert(msg, q)
+        Sidekiq::HeartbeatMonitor::Config.send_backed_up_alert(msg, q)
+
+        true
+      end
+    end
+  end
+end

data/lib/sidekiq/heartbeat_monitor/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+    module HeartbeatMonitor
+        VERSION = '1.0.0.0'
+    end
+end

data/lib/sidekiq/heartbeat_monitor/worker.rb

@@ -0,0 +1,39 @@
+module Sidekiq
+  module HeartbeatMonitor
+    class Worker
+
+      include Sidekiq::Worker
+      sidekiq_options retry: 0
+
+      ##
+      # Runs every x seconds and ensures that the time between jobs is consistent and
+      # @param queue_name [String] Name of the queue that this heartbeat is running on.
+      def perform(queue_name, secs_between_beats = 15)
+        current_run_at = Time.now.utc.to_i
+        last_run_at = $redis.get("Sidekiq/HeartbeatMonitor/Worker/#{queue_name}.last_run_at").to_i
+
+        if last_run_at > 0
+          time_since_last_run = current_run_at - last_run_at
+          if time_since_last_run > (5.minutes + secs_between_beats)
+            sec_backed_up = time_since_last_run - secs_between_beats
+
+            send_server_alert("⚠️ queue #{queue_name} took > #{sec_backed_up}s to reach job.", queue_name)
+          end
+        end
+
+        $redis.set("Sidekiq/HeartbeatMonitor/Worker/#{queue_name}.last_run_at", current_run_at, ex: 1.hour)
+      end
+
+      ##
+      # @param msg [String] Message to post
+      # @param queue_name [String] Queue we're concerned with
+      def send_server_alert(msg, queue_name)
+        Sidekiq::HeartbeatMonitor::Config.send_slowed_down_alert(msg, queue_name)
+
+        true
+      end
+
+
+    end
+  end
+end

data/sidekiq-heartbeat_monitor.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/heartbeat_monitor'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-heartbeat_monitor"
+  spec.version       = Sidekiq::HeartbeatMonitor::VERSION
+  spec.authors       = ["Jay El-Kaake"]
+  spec.email         = ["najibkaake@gmail.com"]
+
+  spec.summary       = %q{Makes it easy to monitor your sidekiq queues, especially with Slack.}
+  spec.description   = %q{Easily monitor your sidekiq queus with Slack or some other notification service.}
+  spec.homepage      = "https://www.github.com/jayelkaake/sidekiq-heartbeat_monitor"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  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 "dont_repeat_for", ">= 1.0.0"
+  spec.add_dependency "slack-notifier", ">= 2.0.0"
+  spec.add_dependency "sidekiq", ">= 4.2.1"
+
+  spec.add_development_dependency "rails", ">= 4.0.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "temping", "~> 3.3.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", '~> 3.4'
+  spec.add_development_dependency "sqlite3", '~> 1.3.11'
+
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-heartbeat_monitor
+version: !ruby/object:Gem::Version
+  version: 1.0.0.0
+platform: ruby
+authors:
+- Jay El-Kaake
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dont_repeat_for
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: temping
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !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: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.11
+description: Easily monitor your sidekiq queus with Slack or some other notification
+  service.
+email:
+- najibkaake@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sidekiq/heartbeat_monitor.rb
+- lib/sidekiq/heartbeat_monitor/config.rb
+- lib/sidekiq/heartbeat_monitor/scheduler.rb
+- lib/sidekiq/heartbeat_monitor/version.rb
+- lib/sidekiq/heartbeat_monitor/worker.rb
+- sidekiq-heartbeat_monitor.gemspec
+homepage: https://www.github.com/jayelkaake/sidekiq-heartbeat_monitor
+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: Makes it easy to monitor your sidekiq queues, especially with Slack.
+test_files: []