sidekiq-job_alert 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b008677b7de2fe56a8471741f5d56216eb704361
+  data.tar.gz: b8f7854c0fa2bedcc30ffb20d5b93083651cad3f
+SHA512:
+  metadata.gz: 4342e1c0a67c41764ae1f254d41350a0852c9d4dca82e8eafb50142ba2179157eddbd4a7c56f0514cc5ba486956ecb914c8edc90a9548a951d2166ecc424eea0
+  data.tar.gz: 3b9ca6f183b6498748b6947e864a49d51d4e5477bef37dffbe5d87350e65d0ae466a02e3382c0171251f46a5d8a7c96553a291416df9cc628275d966a3cf83c9

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at cst.feng@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sidekiq-job_alert.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    sidekiq-job_alert (0.1.0)
+      sidekiq (~> 4.2.1)
+      slack-notifier (~> 2.3.2)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.5)
+    connection_pool (2.2.2)
+    diff-lcs (1.3)
+    rack (2.0.7)
+    rack-protection (2.0.7)
+      rack
+    rake (10.4.2)
+    redis (3.3.5)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    sidekiq (4.2.10)
+      concurrent-ruby (~> 1.0)
+      connection_pool (~> 2.2, >= 2.2.0)
+      rack-protection (>= 1.5.0)
+      redis (~> 3.2, >= 3.2.1)
+    slack-notifier (2.3.2)
+    thor (0.20.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sidekiq-job_alert!
+
+BUNDLED WITH
+   1.16.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 feng.zhang
+
+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,66 @@
+# Sidekiq::JobAlert
+
+Sidekiq-job_alert is a gem to send alert to slack to warn you when there are too many waiting jobs or dead jobs 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-job_alert'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-job_alert
+
+## Usage
+1. copy `sidekiq_job_alert.yml` to your local and config it
+
+```yaml
+:webhook_url: "YOUR SLACK INCOMING WEBHOOK"
+:username: "Sidekiq_JobAlert"
+:channel: "YOUR CHANNEL"
+:link_names: 'false'
+:sidekiq_url: "http://localhost:3000/sidekiq/" # Replace with your sidekiq url
+:alert_dead_jobs:
+  :message: "%<job_counter>d dead jobs.\n"
+:alert_total_waiting_jobs:
+  :message: "Totally %<job_counter>d waiting jobs.\n"
+  :all:
+    :limit: 0 # Only send alert when total waiting jobs over limit
+:alert_each_waiting_job:
+  :message: "%<job_counter>d waiting jobs in %<queue_name>s.\n"
+  :queue_1:
+    :limit: 0 # Only send alert when queue_1's jobs over limit
+  :queue_2:
+    :limit: 0 # Only send alert when queue_2's jobs over limit
+```
+
+2. run
+
+```ruby
+bundle exec sidekiq_job_alert alert --config ./sidekiq_job_alert.yml
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sidekiq-job_alert. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sidekiq::JobAlert project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sidekiq-job_alert/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq/job_alert"
+
+# 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(__FILE__)

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/exe/sidekiq_job_alert

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "sidekiq/job_alert"
+
+Sidekiq::JobAlert::CLI.start(ARGV)

data/lib/sidekiq/job_alert.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'sidekiq/job_alert/notifier'
+require "sidekiq/job_alert/version"
+require 'sidekiq/job_alert/cli'
+
+module Sidekiq
+  module JobAlert
+  end
+end

data/lib/sidekiq/job_alert/cli.rb

@@ -0,0 +1,14 @@
+require 'thor'
+require 'sidekiq/job_alert'
+
+module Sidekiq
+  module JobAlert
+    class CLI < Thor
+      desc "alert config", "Send sidekiq queue alert to slack"
+      option :config
+      def alert
+        Sidekiq::JobAlert::Notifier.new(options[:config]).call
+      end
+    end
+  end
+end

data/lib/sidekiq/job_alert/notifier.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'slack-notifier'
+require 'sidekiq/job_alert/queue'
+
+module Sidekiq
+  module JobAlert
+    class Notifier
+      def initialize(config)
+        @slack_config ||= YAML::load_file(config)
+        @message = ''
+      end
+
+      def call
+        @message += make_dead_job_message
+        @message += make_job_message('alert_total_waiting_jobs', 'all')
+        keys = @slack_config[:alert_each_waiting_job].keys
+        keys.delete(:message)
+        keys.each do |key|
+          @message += make_job_message('alert_each_waiting_job', key)
+        end
+
+        return if @message.empty?
+
+        @message += @slack_config[:sidekiq_url]
+        slack_notifier.ping(@message)
+      end
+
+      private
+
+      def make_dead_job_message
+        cnt = Sidekiq::JobAlert::Queue.dead_job_cnt
+        cnt.positive? ? make_message('alert_dead_jobs', cnt) : ''
+      end
+
+      def make_job_message(type, queue_name)
+        cnt = Sidekiq::JobAlert::Queue.queue_job_cnt(queue_name)
+        limit = @slack_config[type.to_sym][queue_name.to_sym][:limit].to_i
+        cnt > limit ? make_message(type, cnt, queue_name.to_s) : ''
+      end
+
+      def make_message(type, job_counter, queue_name = nil)
+        format(
+          @slack_config[type.to_sym][:message],
+          job_counter: job_counter,
+          queue_name: queue_name
+        )
+      end
+
+      def slack_notifier
+        Slack::Notifier.new(
+          @slack_config[:webhook_url],
+          username: @slack_config[:username],
+          channel: @slack_config[:channel]
+        )
+      end
+    end
+  end
+end

data/lib/sidekiq/job_alert/queue.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'sidekiq/api'
+
+module Sidekiq
+  module JobAlert
+    class Queue
+      class << self
+        def all_job_cnt
+          return 0 if Sidekiq::Queue.all == []
+
+          Sidekiq::Queue.all.sum(&:size)
+        end
+
+        def dead_job_cnt
+          Sidekiq::DeadSet.new.size
+        end
+
+        def queue_job_cnt(queue_name)
+          Sidekiq::Queue.new(queue_name).size
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/job_alert/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module JobAlert
+    VERSION = "0.1.0"
+  end
+end

data/sidekiq-job_alert.gemspec

@@ -0,0 +1,32 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sidekiq/job_alert/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq-job_alert"
+  spec.version       = Sidekiq::JobAlert::VERSION
+  spec.authors       = ["feng.zhang"]
+  spec.email         = ["cst.feng@gmail.com"]
+
+  spec.summary       = %q{Send alert to Slack if too many waiting jobs or dead jobs}
+  spec.description   = %q{Send alert to Slack if too many waiting jobs or dead jobs}
+  spec.homepage      = "https://github.com/arthurbryant/sidekiq-job_alert"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "sidekiq", "~> 4.2.1"
+  spec.add_dependency "slack-notifier", "~> 2.3.2"
+  spec.add_dependency "thor"
+end

data/sidekiq_job_alert.yml

@@ -0,0 +1,18 @@
+:webhook_url: "YOUR SLACK INCOMING WEBHOOK"
+:username: "Sidekiq_JobAlert"
+:channel: "YOUR CHANNEL"
+:link_names: 'false'
+:sidekiq_url: "http://localhost:3000/sidekiq/" # Replace with your sidekiq url
+:alert_dead_jobs:
+  :message: "%<job_counter>d dead jobs.\n"
+:alert_total_waiting_jobs:
+  :message: "Totally %<job_counter>d waiting jobs.\n"
+  :all:
+    :limit: 0 # Only send alert when total waiting jobs over limit
+:alert_each_waiting_job:
+  :message: "%<job_counter>d waiting jobs in %<queue_name>s.\n"
+  :queue_1:
+    :limit: 0 # Only send alert when queue_1's jobs over limit
+  :queue_2:
+    :limit: 0 # Only send alert when queue_2's jobs over limit
+

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-job_alert
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- feng.zhang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  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'
+description: Send alert to Slack if too many waiting jobs or dead jobs
+email:
+- cst.feng@gmail.com
+executables:
+- sidekiq_job_alert
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/sidekiq_job_alert
+- lib/sidekiq/job_alert.rb
+- lib/sidekiq/job_alert/cli.rb
+- lib/sidekiq/job_alert/notifier.rb
+- lib/sidekiq/job_alert/queue.rb
+- lib/sidekiq/job_alert/version.rb
+- sidekiq-job_alert.gemspec
+- sidekiq_job_alert.yml
+homepage: https://github.com/arthurbryant/sidekiq-job_alert
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Send alert to Slack if too many waiting jobs or dead jobs
+test_files: []