sidekiq-alive-next 2.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 783e392caa595b779c30404aa7372fa6736acea3e05a6092980ed4b36ad42115
+  data.tar.gz: e87aa55b018053382fe89501d68900f77f03997ef245e6878e3f45bf9260e8bc
+SHA512:
+  metadata.gz: ce3325f94879b92c2847c0ddfc8e5a0cb1ea354d63344c2f897bd80b02e565556349fdb9ab71ab4a9328c66e0b747ded5adada03fd4c4362985e75ee040f9b0e
+  data.tar.gz: 73be9c7a97a513b46e14f8e76e7669aaf7757858e3155b13e4f602d678b2d91ee3a027bdc595319f0bc8faef17f8ce8463740507d808a12ab30a6fdaa1370853

data/.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    reviewers:
+      - "andrcuns"
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: "daily"
+    reviewers:
+      - andrcuns
+    labels:
+      - "ci"

data/.github/release.yml

@@ -0,0 +1,23 @@
+changelog:
+  categories:
+    - title: '🚀 New Features'
+      labels:
+        - 'feature'
+    - title: '🔬 Improvements'
+      labels: 
+        - 'enhancement'
+    - title: '🐞 Bug Fixes'
+      labels: 
+        - 'bug'
+    - title: '📦 Dependency updates'
+      labels: 
+        - 'dependencies'
+    - title: '📄 Documentation updates'
+      labels: 
+        - 'documentation'
+    - title: '🧰 Maintenance'
+      labels: 
+        - 'maintenance'
+    - title: '👷 CI'
+      labels: 
+        - 'ci'

data/.github/workflows/release.yml

@@ -0,0 +1,40 @@
+name: Release
+
+on: workflow_dispatch
+
+jobs:
+  release:
+    name: Ruby gem
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        name: Set up Ruby 3.1
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1.2
+          bundler-cache: true
+      -
+        name: Create tag and push to rubygems
+        run: |
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+          bundle exec rake release
+        env:
+          GEM_HOST_API_KEY: ${{ secrets.GEM_HOST_API_KEY }}
+
+  gh-release:
+    name: Github release
+    runs-on: ubuntu-latest
+    needs: release
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v3
+      -
+        uses: softprops/action-gh-release@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          generate_release_notes: true

data/.github/workflows/test.yml

@@ -0,0 +1,45 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ["3.1", "3.0", "2.7"]
+    # Service containers to run with `runner-job`
+    services:
+      # Label used to access the service container
+      redis:
+        # Docker Hub image
+        image: redis
+        # Set health checks to wait until redis has started
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          # Maps port 6379 on service container to the host
+          - 6379:6379
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec --color

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,4 @@
+--format documentation
+--color
+--require spec_helper
+--order random

data/.ruby-version

@@ -0,0 +1 @@
+3.0.4

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.0.4

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,8 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sidekiq_alive.gemspec
+gemspec
+
+gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    sidekiq-alive-next (2.2.0)
+      sidekiq (>= 5, < 7)
+      webrick (>= 1, < 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    connection_pool (2.3.0)
+    diff-lcs (1.5.0)
+    method_source (1.0.0)
+    mock_redis (0.34.0)
+      ruby2_keywords
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rake (13.0.6)
+    redis (4.8.0)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-sidekiq (3.1.0)
+      rspec-core (~> 3.0, >= 3.0.0)
+      sidekiq (>= 2.4.0)
+    rspec-support (3.11.1)
+    ruby2_keywords (0.0.5)
+    sidekiq (6.5.7)
+      connection_pool (>= 2.2.5)
+      rack (~> 2.0)
+      redis (>= 4.5.0, < 5)
+    webrick (1.7.0)
+
+PLATFORMS
+  aarch64-linux
+  arm64-darwin-21
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (> 1.16)
+  mock_redis
+  pry
+  rack-test
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rspec-sidekiq (~> 3.0)
+  sidekiq-alive-next!
+
+BUNDLED WITH
+   2.3.22

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,284 @@
+# SidekiqAlive
+
+**This is the fork of 'arturictus/sidekiq_alive' with a few minor fixes and tweaks, all credit goes to author of original repo**
+
+SidekiqAlive offers a solution to add liveness probe for a Sidekiq instance deployed in Kubernetes.
+This library can be used to check sidekiq health outside 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 worker is the responsible to storing this key. If Sidekiq stops processing workers
+this key gets expired by Redis an consequently the http server will return a 500 error.
+
+This worker is responsible to requeue itself for the next liveness probe.
+
+Each instance in kubernetes will be checked based on `ENV` variable `HOSTNAME` (kubernetes sets this for each replica/pod).
+
+On initialization SidekiqAlive will asign to Sidekiq::Worker a queue with the current host and add this queue to the current instance queues to process.
+
+example:
+
+```
+hostname: foo
+  Worker queue: sidekiq_alive-foo
+  instance queues:
+   - sidekiq_alive-foo
+   *- your queues
+
+hostname: bar
+  Worker queue: sidekiq_alive-bar
+  instance queues:
+   - sidekiq_alive-bar
+   *- your queues
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-alive-next'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-alive-next
+
+## Usage
+
+SidekiqAlive will start when running `sidekiq` command.
+
+Run `Sidekiq`
+
+```
+bundle exec sidekiq
+```
+
+```
+curl localhost:7433
+#=> Alive!
+```
+
+**how to disable?**
+You can disabled by setting `ENV` variable `DISABLE_SIDEKIQ_ALIVE`
+example:
+
+```
+DISABLE_SIDEKIQ_ALIVE=true bundle exec sidekiq
+```
+
+### Kubernetes setup
+
+Set `livenessProbe` in your Kubernetes deployment
+
+example with recommended setup:
+
+#### Sidekiq < 6
+
+```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.
+```
+
+#### Sidekiq >= 6
+
+Create file:
+
+_kube/sidekiq_quiet_
+
+```bash
+#!/bin/bash
+
+# Find Pid
+SIDEKIQ_PID=$(ps aux | grep sidekiq | grep busy | awk '{ print $2 }')
+# Send TSTP signal
+kill -SIGTSTP $SIDEKIQ_PID
+```
+
+Make it executable:
+
+```
+$ chmod +x kube/sidekiq_quiet
+```
+
+Execute it in your deployment preStop:
+
+```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: ['kube/sidekiq_quiet']
+  terminationGracePeriodSeconds: 60 # put your longest Job time here plus security time.
+```
+
+### Outside kubernetes
+
+It's just up to you how you want to use it.
+
+An example in local would be:
+
+```
+bundle exec sidekiq
+# let it initialize ...
+```
+
+```
+curl localhost:7433
+#=> Alive!
+```
+
+## Options
+
+```ruby
+SidekiqAlive.setup do |config|
+  # ==> Server host
+  # Host to bind the server.
+  # Can also be set with the environment variable SIDEKIQ_ALIVE_HOST.
+  # default: 0.0.0.0
+  #
+  #   config.host = 0.0.0.0
+
+  # ==> Server port
+  # Port to bind the server.
+  # Can also be set with the environment variable SIDEKIQ_ALIVE_PORT.
+  # default: 7433
+  #
+  #   config.port = 7433
+
+  # ==> Server path
+  # HTTP path to respond to.
+  # Can also be set with the environment variable SIDEKIQ_ALIVE_PATH.
+  # default: '/'
+  #
+  #   config.path = '/'
+
+  # ==> Custom Liveness Probe
+  # Extra check to decide if restart the pod or not for example connection to DB.
+  # `false`, `nil` or `raise` will not write the liveness probe
+  # default: proc { true }
+  #
+  #     config.custom_liveness_probe = proc { db_running? }
+
+  # ==> 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") }
+
+  # ==> Shutdown callback
+  # When sidekiq process is shutting down, you can perform some action, like cleaning up created queue
+  # default: proc {}
+  #
+  #    config.shutdown_callback = proc do
+  #      Sidekiq::Queue.all.find { |q| q.name == "#{queue_prefix}-#{SidekiqAlive.hostname}" }&.clear
+  #    end
+
+  # ==> Queue Prefix
+  # SidekiqAlive will run in a independent queue for each instance/replica
+  # This queue name will be generated with: "#{queue_prefix}-#{hostname}.
+  # You can customize the prefix here.
+  # default: :sidekiq-alive
+  #
+  #    config.queue_prefix = :other
+
+  # ==> Rack server
+  # Web server used to serve an HTTP response.
+  # Can also be set with the environment variable SIDEKIQ_ALIVE_SERVER.
+  # default: 'webrick'
+  #
+  #    config.server = 'puma'
+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`.
+
+Here is an example [rails app](https://github.com/arturictus/sidekiq_alive_example)
+
+## 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/docker-compose.yml

@@ -0,0 +1,6 @@
+version: '3.6'
+services:
+  redis:
+    image: redis
+    ports:
+      - 6379:6379

data/lib/sidekiq-alive-next.rb

@@ -0,0 +1,146 @@
+require 'sidekiq'
+require 'sidekiq/api'
+require 'singleton'
+require 'sidekiq_alive/version'
+require 'sidekiq_alive/config'
+
+module SidekiqAlive
+  def self.start
+    Sidekiq.configure_server do |sq_config|
+      sq_config.on(:startup) do
+        SidekiqAlive::Worker.sidekiq_options queue: current_queue
+        (sq_config.respond_to?(:[]) ? sq_config[:queues] : sq_config.options[:queues]).unshift(current_queue)
+
+        logger.info(startup_info)
+
+        register_current_instance
+        store_alive_key
+        SidekiqAlive::Worker.perform_async(hostname)
+        @server_pid = fork { SidekiqAlive::Server.run! }
+
+        logger.info(successful_startup_text)
+      end
+
+      sq_config.on(:quiet) do
+        unregister_current_instance
+        config.shutdown_callback.call
+      end
+
+      sq_config.on(:shutdown) do
+        Process.kill('TERM', @server_pid) unless @server_pid.nil?
+        Process.wait(@server_pid) unless @server_pid.nil?
+
+        unregister_current_instance
+        config.shutdown_callback.call
+      end
+    end
+  end
+
+  def self.current_queue
+    "#{config.queue_prefix}-#{hostname}"
+  end
+
+  def self.register_current_instance
+    register_instance(current_instance_register_key)
+  end
+
+  def self.unregister_current_instance
+    # Delete any pending jobs for this instance
+    logger.info(shutdown_info)
+    purge_pending_jobs
+    redis.del(current_instance_register_key)
+  end
+
+  def self.registered_instances
+    deep_scan("#{config.registered_instance_key}::*")
+  end
+
+  def self.deep_scan(keyword, keys = [], cursor = 0)
+    loop do
+      cursor, found_keys = SidekiqAlive.redis.scan(cursor, match: keyword, count: 1000)
+      keys += found_keys
+      break if cursor.to_i.zero?
+    end
+    keys
+  end
+
+  def self.purge_pending_jobs
+    # TODO:
+    # Sidekiq 6 allows better way to find scheduled jobs:
+    # https://github.com/mperham/sidekiq/wiki/API#scan
+    scheduled_set = Sidekiq::ScheduledSet.new
+    jobs = scheduled_set.select { |job| job.klass == 'SidekiqAlive::Worker' && job.queue == current_queue }
+    logger.info("[SidekiqAlive] Purging #{jobs.count} pending for #{hostname}")
+    jobs.each(&:delete)
+    logger.info("[SidekiqAlive] Removing queue #{current_queue}")
+    Sidekiq::Queue.new(current_queue).clear
+  end
+
+  def self.current_instance_register_key
+    "#{config.registered_instance_key}::#{hostname}"
+  end
+
+  def self.store_alive_key
+    redis.set(current_lifeness_key,
+              Time.now.to_i,
+              ex: config.time_to_live.to_i)
+  end
+
+  def self.redis
+    Sidekiq.redis { |r| r }
+  end
+
+  def self.alive?
+    redis.ttl(current_lifeness_key) != -2
+  end
+
+  # CONFIG ---------------------------------------
+
+  def self.setup
+    yield(config)
+  end
+
+  def self.logger
+    config.logger || Sidekiq.logger
+  end
+
+  def self.config
+    @config ||= SidekiqAlive::Config.instance
+  end
+
+  def self.current_lifeness_key
+    "#{config.liveness_key}::#{hostname}"
+  end
+
+  def self.hostname
+    ENV['HOSTNAME'] || 'HOSTNAME_NOT_SET'
+  end
+
+  def self.shutdown_info
+    'Shutting down sidekiq-alive!'
+  end
+
+  def self.startup_info
+    info = {
+      hostname: hostname,
+      port: config.port,
+      ttl: config.time_to_live,
+      queue: current_queue
+    }
+
+    "Starting sidekiq-alive: #{info}"
+  end
+
+  def self.successful_startup_text
+    "Successfully started sidekiq-alive, registered instances: #{registered_instances.join("\n\s\s- ")}"
+  end
+
+  def self.register_instance(instance_name)
+    redis.set(instance_name, Time.now.to_i, ex: config.registration_ttl.to_i)
+  end
+end
+
+require 'sidekiq_alive/worker'
+require 'sidekiq_alive/server'
+
+SidekiqAlive.start unless ENV.fetch('DISABLE_SIDEKIQ_ALIVE', '').casecmp('true').zero?

data/lib/sidekiq_alive/config.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module SidekiqAlive
+  class Config
+    include Singleton
+
+    attr_accessor :host,
+                  :port,
+                  :path,
+                  :liveness_key,
+                  :time_to_live,
+                  :callback,
+                  :registered_instance_key,
+                  :queue_prefix,
+                  :server,
+                  :custom_liveness_probe,
+                  :logger,
+                  :shutdown_callback
+
+    def initialize
+      set_defaults
+    end
+
+    def set_defaults
+      @host = ENV.fetch('SIDEKIQ_ALIVE_HOST', '0.0.0.0')
+      @port = ENV.fetch('SIDEKIQ_ALIVE_PORT', 7433)
+      @path = ENV.fetch('SIDEKIQ_ALIVE_PATH', '/')
+      @liveness_key = 'SIDEKIQ::LIVENESS_PROBE_TIMESTAMP'
+      @time_to_live = 10 * 60
+      @callback = proc {}
+      @registered_instance_key = 'SIDEKIQ_REGISTERED_INSTANCE'
+      @queue_prefix = :"sidekiq-alive"
+      @server = ENV.fetch('SIDEKIQ_ALIVE_SERVER', 'webrick')
+      @custom_liveness_probe = proc { true }
+      @shutdown_callback = proc {}
+    end
+
+    def registration_ttl
+      @registration_ttl || time_to_live + 60
+    end
+  end
+end

data/lib/sidekiq_alive/server.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'rack'
+
+module SidekiqAlive
+  class Server
+    class << self
+      def run!
+        handler =  Rack::Handler.get(server)
+
+        Signal.trap('TERM') { handler.shutdown }
+
+        handler.run(self, Port: port, Host: host, AccessLog: [], Logger: SidekiqAlive.logger)
+      end
+
+      def host
+        SidekiqAlive.config.host
+      end
+
+      def port
+        SidekiqAlive.config.port
+      end
+
+      def path
+        SidekiqAlive.config.path
+      end
+
+      def server
+        SidekiqAlive.config.server
+      end
+
+      def call(env)
+        if Rack::Request.new(env).path != path
+          [404, {}, ['Not found']]
+        elsif SidekiqAlive.alive?
+          [200, {}, ['Alive!']]
+        else
+          response = "Can't find the alive key"
+          SidekiqAlive.logger.error(response)
+          [404, {}, [response]]
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq_alive/version.rb

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

data/lib/sidekiq_alive/worker.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module SidekiqAlive
+  class Worker
+    include Sidekiq::Worker
+    sidekiq_options retry: false
+
+    def perform(_hostname = SidekiqAlive.hostname)
+      # Checks if custom liveness probe passes should fail or return false
+      return unless config.custom_liveness_probe.call
+
+      # Writes the liveness in Redis
+      write_living_probe
+      # schedules next living probe
+      self.class.perform_in(config.time_to_live / 2, current_hostname)
+    end
+
+    def hostname_registered?(hostname)
+      SidekiqAlive.registered_instances.any? do |ri|
+        /#{hostname}/ =~ ri
+      end
+    end
+
+    def write_living_probe
+      # Write liveness probe
+      SidekiqAlive.store_alive_key
+      # Increment ttl for current registered instance
+      SidekiqAlive.register_current_instance
+      # after callbacks
+      begin
+        config.callback.call
+      rescue StandardError
+        nil
+      end
+    end
+
+    def current_hostname
+      SidekiqAlive.hostname
+    end
+
+    def config
+      SidekiqAlive.config
+    end
+  end
+end

data/sidekiq_alive.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq_alive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sidekiq-alive-next'
+  spec.version       = SidekiqAlive::VERSION
+  spec.authors       = ['Andrejs Cunskis']
+  spec.email         = ['andrejs.cunskis@gmail.com']
+
+  spec.summary       = 'Liveness probe for sidekiq on Kubernetes deployments.'
+  spec.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.'
+  spec.homepage      = 'https://github.com/andrcuns/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 'mock_redis'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-sidekiq', '~> 3.0'
+  spec.add_dependency 'sidekiq', '>= 5', '< 7'
+  spec.add_dependency 'webrick', '>= 1', '< 2'
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-alive-next
+version: !ruby/object:Gem::Version
+  version: 2.2.0
+platform: ruby
+authors:
+- Andrejs Cunskis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-10-15 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: 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: rack-test
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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: rspec-sidekiq
+  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: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+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:
+- andrejs.cunskis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/dependabot.yml"
+- ".github/release.yml"
+- ".github/workflows/release.yml"
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".tool-versions"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- lib/sidekiq-alive-next.rb
+- lib/sidekiq_alive/config.rb
+- lib/sidekiq_alive/server.rb
+- lib/sidekiq_alive/version.rb
+- lib/sidekiq_alive/worker.rb
+- sidekiq_alive.gemspec
+homepage: https://github.com/andrcuns/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: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Liveness probe for sidekiq on Kubernetes deployments.
+test_files: []