sidekiq_alive 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a44c1e18d7a26b469ed2eb4a99d6c5d9feeca58
+  data.tar.gz: 870314a23499da71ff34ad9a5c5fa3124dc16b93
+SHA512:
+  metadata.gz: a434f4c9fbcb140ca1d070ac7b83aae54531c955b0ce4bfb673f705a4988adb91177bc5a6beb491be0985fcbce88024125869d230f7428727f954ec796b1d915
+  data.tar.gz: b35a6b390fc8d615d1f6bcd4ef97b07d8bac87968872358a451a806e26dd32dc5df53d3f2afc7308947a29dfd5478a6da4f60440a98e1974a35c8621297e37ad

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.1

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 arturictus@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_alive.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    sidekiq_alive (0.1.0)
+      sidekiq
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.0.5)
+    connection_pool (2.2.1)
+    diff-lcs (1.3)
+    mock_redis (0.18.0)
+    rack (1.6.8)
+    rack-protection (1.5.3)
+      rack
+    rake (10.5.0)
+    redis (3.3.5)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  mock_redis
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sidekiq_alive!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Artur Pañach
+
+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,141 @@
+# SidekiqAlive
+
+SidekiqAlive offers a solution to add liveness probe for a Sidekiq instance deployed in Kubernetes.
+
+__How?__
+
+A http server is started and on each requests validates that a liveness key is stored in Redis. If it is there means is working.
+
+A Sidekiq job is the responsable to storing this key. If Sidekiq stops processing jobs
+this key gets expired by Redis an consequently the http server will return a 500 error.
+
+This Job is responsible to requeue itself for the next liveness probe.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq_alive'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq_alive
+
+## Usage
+
+### start the server
+
+rails example:
+
+`config/initializers/sidekiq.rb`
+
+```ruby
+SidekiqAlive..start
+```
+
+### Run the job for first time
+
+It should only be run on the first time you deploy the app.
+It would reschedule itself.
+
+rails example:
+```
+$ bundle exec rails console
+
+#=> SidekiqAlive.perform_now
+```
+
+### Kubernetes setup
+
+Set `livenessProbe` in your Kubernetes deployment
+
+example with recommended setup:
+
+```yaml
+spec:
+  containers:
+    - name: my_app
+      image: my_app:latest
+      env:
+        - name: RAILS_ENV
+          value: production
+      command:
+        - bundle
+        - exec
+        - sidekiq
+      ports:
+        - containerPort: 7433
+      livenessProbe:
+        httpGet:
+          path: /
+          port: 7433
+        initialDelaySeconds: 80 # app specific. Time your sidekiq takes to start processing.
+        timeoutSeconds: 5 # can be much less
+      readinessProbe:
+        httpGet:
+          path: /
+          port: 7433
+        initialDelaySeconds: 80 # app specific
+        timeoutSeconds: 5 # can be much less
+      lifecycle:
+        preStop:
+          exec:
+            # SIGTERM triggers a quick exit; gracefully terminate instead
+            command: ["bundle", "exec", "sidekiqctl", "quiet"]
+  terminationGracePeriodSeconds: 60 # put your longest Job time here plus security time.
+```
+
+## Options
+
+```ruby
+SidekiqAlive.setup do |config|
+  # ==> Server port
+  # port to bind the server
+  # default: 7433
+  #
+  #   config.port = 7433
+
+  # ==> Liveness key
+  # Key to be stored in Redis as probe of liveness
+  # default: "SIDEKIQ::LIVENESS_PROBE_TIMESTAMP"
+  #
+  #   config.liveness_key = "SIDEKIQ::LIVENESS_PROBE_TIMESTAMP"
+
+  # ==> Time to live
+  # Time for the key to be kept by Redis.
+  # Here is where you can set de periodicity that the Sidekiq has to probe it is working
+  # Time unit: seconds
+  # default: 10 * 60 # 10 minutes
+  #
+  #   config.time_to_live = 10 * 60
+
+  # ==> Callback
+  # After the key is stored in redis you can perform anything.
+  # For example a webhook or email to notify the team
+  # default: proc {}
+  #
+  #    require 'net/http'
+  #    config.callback = proc { Net::HTTP.get("https://status.com/ping") }
+end
+```
+
+## 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/arturictus/sidekiq_alive. 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).

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_alive"
+
+# 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/lib/sidekiq_alive.rb

@@ -0,0 +1,68 @@
+require "sidekiq_alive/version"
+require 'sidekiq'
+
+module SidekiqAlive
+  def self.start
+    Sidekiq.configure_server do |config|
+      config.on(:startup) do
+        SidekiqAlive::Server.start
+      end
+    end
+  end
+
+  def self.store_alive_key
+    redis.set(liveness_key,
+              Time.now.to_i,
+              { ex: time_to_live.to_i })
+  end
+
+  def self.redis
+    Sidekiq.redis { |r| r }
+  end
+
+  def self.alive?
+    redis.ttl(liveness_key) == -2 ? false : true
+  end
+
+  # CONFIG ---------------------------------------
+
+  def self.setup
+    yield(self)
+  end
+
+  def self.port=(port)
+    @port = port
+  end
+
+  def self.port
+    @port || 7433
+  end
+
+  def self.liveness_key=(key)
+    @liveness_key = key
+  end
+
+  def self.liveness_key
+    @liveness_key || "SIDEKIQ::LIVENESS_PROBE_TIMESTAMP"
+  end
+
+  def self.time_to_live=(time)
+    @time_to_live = time
+  end
+
+  def self.time_to_live
+    @time_to_live || 10 * 60
+  end
+
+  def self.callback=(block)
+    @after_storing_key = block
+  end
+
+  def self.callback
+    @after_storing_key || proc {} # do nothing
+  end
+
+end
+
+require 'sidekiq_alive/server'
+require 'sidekiq_alive/worker'

data/lib/sidekiq_alive/server.rb

@@ -0,0 +1,46 @@
+module SidekiqAlive
+  module Server
+    def self.start
+      require 'socket'
+      Sidekiq::Logging.logger.info "Starting liveness server on #{config.port}"
+      store_alive_key # initial livenessProbe to avoid to kill the instance before it triggers the first liveness
+
+      # Start Server
+      Thread.start do
+        server = TCPServer.new('0.0.0.0', config.port)
+        loop do
+          Thread.start(server.accept) do |socket|
+            request = socket.gets # Read the first line of the request (the Request-Line)
+            if config.alive?
+              status = "200 OK"
+              response = "Alive!\n"
+            else
+              status = "500 ERROR"
+              response = "Looks like sidekiq is not working\n"
+              Sidekiq::Logging.logger.error response
+            end
+            socket.print "HTTP/1.1 #{status}\r\n" +
+                             "Content-Type: text/plain\r\n" +
+                             "Content-Length: #{response.bytesize}\r\n" +
+                             "Connection: close\r\n"
+            socket.print "\r\n" # blank line separates the header from the body, as required by the protocol
+            socket.print response
+            socket.close
+          end
+        end
+      end
+    end
+
+    def self.config
+      SidekiqAlive
+    end
+
+    def self.store_alive_key
+      Sidekiq::Logging.logger.info "Writing Startup alive key in redis: #{config.liveness_key}"
+      # TODO run worker unless one already enqueued
+      config.store_alive_key
+    end
+
+
+  end
+end

data/lib/sidekiq_alive/version.rb

@@ -0,0 +1,3 @@
+module SidekiqAlive
+  VERSION = "0.1.0"
+end

data/lib/sidekiq_alive/worker.rb

@@ -0,0 +1,18 @@
+module SidekiqAlive
+  class Worker
+    include Sidekiq::Worker
+    sidekiq_options retry: false
+
+    def perform
+      write_living_probe
+      self.class.perform_in(SidekiqAlive.time_to_live / 2)
+    end
+
+    def write_living_probe
+      # Write liveness probe
+      SidekiqAlive.store_alive_key
+      # after callbacks
+      SidekiqAlive.callback.call()
+    end
+  end
+end

data/sidekiq_alive.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sidekiq_alive/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sidekiq_alive"
+  spec.version       = SidekiqAlive::VERSION
+  spec.authors       = ["Artur Pañach"]
+  spec.email         = ["arturictus@gmail.com"]
+
+  spec.summary       = %q{Liveness probe for sidekiq on Kubernetes deployments.}
+  spec.description   = %q{SidekiqAlive offers a solution to add liveness probe of a Sidekiq instance.
+
+  How?
+
+  A http server is started and on each requests validates that a liveness key is stored in Redis. If it is there means is working.
+
+  A Sidekiq job is the responsable to storing this key. If Sidekiq stops processing jobs
+  this key gets expired by Redis an consequently the http server will return a 500 error.
+
+  This Job is responsible to requeue itself for the next liveness probe.}
+  spec.homepage      = "https://github.com/arturictus/sidekiq_alive"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "mock_redis"
+  spec.add_dependency "sidekiq"
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq_alive
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Artur Pañach
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-08 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: mock_redis
+  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: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  SidekiqAlive offers a solution to add liveness probe of a Sidekiq instance.
+
+    How?
+
+    A http server is started and on each requests validates that a liveness key is stored in Redis. If it is there means is working.
+
+    A Sidekiq job is the responsable to storing this key. If Sidekiq stops processing jobs
+    this key gets expired by Redis an consequently the http server will return a 500 error.
+
+    This Job is responsible to requeue itself for the next liveness probe.
+email:
+- arturictus@gmail.com
+executables: []
+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
+- lib/sidekiq_alive.rb
+- lib/sidekiq_alive/server.rb
+- lib/sidekiq_alive/version.rb
+- lib/sidekiq_alive/worker.rb
+- sidekiq_alive.gemspec
+homepage: https://github.com/arturictus/sidekiq_alive
+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: Liveness probe for sidekiq on Kubernetes deployments.
+test_files: []