capistrano-sidekiq 2.0.0 → 2.3.0

data/lib/generators/capistrano/sidekiq/systemd/templates/sidekiq.service.capistrano.erb

@@ -1,26 +1,68 @@
+# Source: https://github.com/mperham/sidekiq/blob/master/examples/systemd/sidekiq.service
+#
+# This file tells systemd how to run Sidekiq as a 24/7 long-running daemon.
+#
+# Customize this file based on your bundler location, app directory, etc.
+# Customize and copy this into /usr/lib/systemd/system (CentOS) or /lib/systemd/system (Ubuntu).
+# Then run:
+#   - systemctl enable <%= sidekiq_service_unit_name %>
+#   - systemctl {start,stop,restart} <%= sidekiq_service_unit_name %>
+#
+# This file corresponds to a single Sidekiq process.  Add multiple copies
+# to run multiple processes (sidekiq-1, sidekiq-2, etc).
+#
+# Use `journalctl -u <%= sidekiq_service_unit_name %> -rn 100` to view the last 100 lines of log output.
+#
 [Unit]
 Description=sidekiq for <%= "#{fetch(:application)} (#{fetch(:stage)})" %>
+# start us only once the network and logging subsystems are available,
+# consider adding redis-server.service if Redis is local and systemd-managed.
 After=syslog.target network.target
 
+# See these pages for lots of options:
+#
+#   https://www.freedesktop.org/software/systemd/man/systemd.service.html
+#   https://www.freedesktop.org/software/systemd/man/systemd.exec.html
+#
+# THOSE PAGES ARE CRITICAL FOR ANY LINUX DEVOPS WORK; read them multiple
+# times! systemd is a critical tool for all developers to know and understand.
+#
 [Service]
-Type=simple
+#
+#      !!!!  !!!!  !!!!
+#
+# As of v6.0.6, Sidekiq automatically supports systemd's `Type=notify` and watchdog service
+# monitoring. If you are using an earlier version of Sidekiq, change this to `Type=simple`
+# and remove the `WatchdogSec` line.
+#
+#      !!!!  !!!!  !!!!
+#
+Type=notify
+# If your Sidekiq process locks up, systemd's watchdog will restart it within seconds.
+WatchdogSec=10
+
 WorkingDirectory=<%= File.join(fetch(:deploy_to), 'current') %>
-ExecStart=<%= SSHKit.config.command_map[:bundle] %> exec sidekiq -e <%= fetch(:sidekiq_env) %>
-ExecReload=/bin/kill -TSTP $MAINPID
-ExecStop=/bin/kill -TERM $MAINPID
-<%="StandardOutput=append:#{fetch(:sidekiq_log)}" if fetch(:sidekiq_log) %>
-<%="StandardError=append:#{fetch(:sidekiq_error_log)}" if fetch(:sidekiq_error_log) %>
+ExecStart=<%= expanded_bundle_path %> exec sidekiq -e <%= fetch(:sidekiq_env) %> <%= sidekiq_config %> <%= sidekiq_concurrency %> <%= sidekiq_queues %>
+
+# Use `systemctl kill -s TSTP <%= sidekiq_service_unit_name %>` to quiet the Sidekiq process
 <%="User=#{sidekiq_user}" if sidekiq_user %>
-<%="EnvironmentFile=#{fetch(:sidekiq_service_unit_env_file)}" if fetch(:sidekiq_service_unit_env_file) %>
+UMask=0002
+
+<%="EnvironmentFile=#{File.join(fetch(:deploy_to), 'current')}/#{fetch(:sidekiq_service_unit_env_file)}" if fetch(:sidekiq_service_unit_env_file) %>
 
 <% fetch(:sidekiq_service_unit_env_vars, []).each do |environment_variable| %>
   <%="Environment=#{environment_variable}" %>
 <% end %>
 
+# if we crash, restart
 RestartSec=1
 Restart=on-failure
 
-SyslogIdentifier=sidekiq
+# output goes to /var/log/syslog (Ubuntu) or /var/log/messages (CentOS)
+<%="StandardOutput=append:#{fetch(:sidekiq_log)}" if fetch(:sidekiq_log) %>
+<%="StandardError=append:#{fetch(:sidekiq_error_log)}" if fetch(:sidekiq_error_log) %>
+
+SyslogIdentifier=<%= sidekiq_service_unit_name %>
 
 [Install]
 WantedBy=default.target

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-sidekiq
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Abdelkader Boudih
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-19 00:00:00.000000000 Z
+date: 2022-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -62,7 +62,6 @@ files:
 - ".gitignore"
 - ".tool-versions"
 - CHANGELOG.md
-- CONTRIBUTORS.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -70,19 +69,16 @@ files:
 - capistrano-sidekiq.gemspec
 - lib/capistrano-sidekiq.rb
 - lib/capistrano/sidekiq.rb
+- lib/capistrano/sidekiq/helpers.rb
 - lib/capistrano/sidekiq/monit.rb
 - lib/capistrano/sidekiq/systemd.rb
-- lib/capistrano/sidekiq/upstart.rb
 - lib/capistrano/sidekiq/version.rb
 - lib/capistrano/tasks/monit.rake
 - lib/capistrano/tasks/sidekiq.rake
 - lib/capistrano/tasks/systemd.rake
-- lib/capistrano/tasks/upstart.rake
 - lib/generators/capistrano/sidekiq/monit/template_generator.rb
 - lib/generators/capistrano/sidekiq/monit/templates/sidekiq_monit.conf.erb
 - lib/generators/capistrano/sidekiq/systemd/templates/sidekiq.service.capistrano.erb
-- lib/generators/capistrano/sidekiq/upstart/templates/sidekiq.conf.erb
-- lib/generators/capistrano/sidekiq/upstart/templates/workers.conf.erb
 homepage: https://github.com/seuros/capistrano-sidekiq
 licenses:
 - LGPL-3.0
@@ -102,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Sidekiq integration for Capistrano

data/CONTRIBUTORS.md

@@ -1,11 +0,0 @@
-## Contributors
-
-- [Jérémy Lecour] (https://github.com/jlecour)
-- [Fabien Penso] (https://github.com/penso)
-- [Alex Dunae] (https://github.com/alexdunae)
-- [andreygerasimchuk] (https://github.com/andreygerasimchuk)
-- [Saicheg] (https://github.com/Saicheg)
-- [Alex Yakubenko] (https://github.com/alexyakubenko)
-- [Robert Strobl] (https://github.com/rstrobl)
-- [Eurico Doirado] (https://github.com/okoriko)
-- [Huang Bin](https://github.com/hbin)

data/lib/capistrano/sidekiq/upstart.rb

@@ -1,11 +0,0 @@
-module Capistrano
-  class Sidekiq::Upstart < Capistrano::Plugin
-    def set_defaults
-      set_if_empty :sidekiq_service_unit_name, 'sidekiq'
-    end
-
-    def define_tasks
-      eval_rakefile File.expand_path('../../tasks/upstart.rake', __FILE__)
-    end
-  end
-end

data/lib/capistrano/tasks/upstart.rake

@@ -1,146 +0,0 @@
-git_plugin = self
-
-SUPPRESS_FAILURE = %w[|| echo NO_RUNNING_INSTANCE].freeze
-
-namespace :sidekiq do
-  desc 'Quiet sidekiq (stop fetching new tasks from Redis)'
-  task :quiet do
-    on roles fetch(:sidekiq_roles) do |role|
-      git_plugin.switch_user(role) do
-        sudo :service, fetch(:sidekiq_service_unit_name), :reload, *SUPPRESS_FAILURE
-      end
-    end
-  end
-
-  desc 'Stop sidekiq (graceful shutdown within timeout, put unfinished tasks back to Redis)'
-  task :stop do
-    on roles fetch(:sidekiq_roles) do |role|
-      git_plugin.switch_user(role) do
-        sudo :service, fetch(:sidekiq_service_unit_name), :stop, *SUPPRESS_FAILURE
-      end
-    end
-  end
-
-  desc 'Start sidekiq'
-  task :start do
-    on roles fetch(:sidekiq_roles) do |role|
-      git_plugin.switch_user(role) do
-        sudo :service, fetch(:sidekiq_service_unit_name), :start
-      end
-    end
-  end
-
-  desc 'Install upstart sidekiq service'
-  task :install do
-    on roles fetch(:sidekiq_roles) do |role|
-      git_plugin.switch_user(role) do
-        git_plugin.create_upstart_template
-      end
-    end
-  end
-
-  desc 'UnInstall upstart sidekiq service'
-  task :uninstall do
-    on roles fetch(:sidekiq_roles) do |role|
-      git_plugin.switch_user(role) do
-        execute :rm, '-f', File.join(fetch(:service_unit_path, fetch_upstart_unit_path), fetch(:sidekiq_service_unit_name))
-      end
-    end
-  end
-
-  desc 'Generate service_locally'
-  task :generate_service_locally do
-    run_locally do
-      File.write('sidekiq.conf', git_plugin.compiled_template)
-    end
-  end
-
-  def fetch_upstart_unit_path
-    if fetch(:sidekiq_service_unit_user) == :system
-      # if the path is not standard `set :service_unit_path`
-      "/etc/init"
-    else
-      home_dir = backend.capture :pwd
-      File.join(home_dir, '.config', 'upstart')
-    end
-  end
-
-  def compiled_template
-    search_paths = [
-      File.expand_path(
-        File.join(*%w[.. .. .. generators capistrano sidekiq upstart templates sidekiq.conf.erb]),
-        __FILE__
-      ),
-    ]
-    template_path = search_paths.detect { |path| File.file?(path) }
-    template = File.read(template_path)
-    ERB.new(template).result(binding)
-  end
-
-  def create_upstart_template
-    ctemplate = compiled_template
-    upstart_path = fetch(:service_unit_path, fetch_upstart_unit_path)
-
-    if fetch(:sidekiq_service_unit_user) != :system
-      backend.execute :mkdir, "-p", upstart_path
-    end
-    conf_filename = "#{fetch :sidekiq_service_unit_name}.conf"
-    backend.upload!(
-      StringIO.new(ctemplate),
-      "/tmp/#{conf_filename}"
-    )
-    if fetch(:sidekiq_service_unit_user) == :system
-      backend.execute :sudo, :mv, "/tmp/#{conf_filename}", "#{upstart_path}/#{conf_filename}"
-      backend.execute :sudo, :initctl,  'reload-configuration'
-    else
-      backend.execute :sudo, :mv, "/tmp/#{conf_filename}", "#{upstart_path}/#{conf_filename}"
-      #backend.execute :sudo, :initctl,  'reload-configuration' #TODO
-    end
-  end
-
-  def switch_user(role)
-    su_user = sidekiq_user(role)
-    if su_user == role.user
-      yield
-    else
-      as su_user do
-        yield
-      end
-    end
-  end
-
-  def sidekiq_user(role = nil)
-    if role.nil?
-      fetch(:sidekiq_user)
-    else
-      properties = role.properties
-      properties.fetch(:sidekiq_user) || # local property for sidekiq only
-        fetch(:sidekiq_user) ||
-        properties.fetch(:run_as) || # global property across multiple capistrano gems
-        role.user
-    end
-  end
-
-  def num_workers
-    fetch(:sidekiq_upstart_num_workers, nil)
-  end
-
-  def sidekiq_config
-    if fetch(:sidekiq_config)
-      "--config #{fetch(:sidekiq_config)}"
-    end
-  end
-
-  def sidekiq_concurrency
-    if fetch(:sidekiq_concurrency)
-      "--concurrency #{fetch(:sidekiq_concurrency)}"
-    end
-  end
-
-  def sidekiq_queues
-    Array(fetch(:sidekiq_queue)).map do |queue|
-      "--queue #{queue}"
-    end.join(' ')
-  end
-
-end

data/lib/generators/capistrano/sidekiq/upstart/templates/sidekiq.conf.erb

@@ -1,78 +0,0 @@
-# /etc/init/sidekiq.conf - Sidekiq config | https://github.com/mperham/sidekiq/blob/master/examples/upstart/sidekiq.conf
-
-# This example config should work with Ubuntu 12.04+.  It
-# allows you to manage multiple Sidekiq instances with
-# Upstart, Ubuntu's native service management tool.
-#
-# See workers.conf for how to manage all Sidekiq instances at once.
-#
-# Save this config as /etc/init/sidekiq.conf then manage sidekiq with:
-#   sudo start <%= fetch(:sidekiq_service_unit_name) %> index=0
-#   sudo stop <%= fetch(:sidekiq_service_unit_name) %> index=0
-#   sudo status <%= fetch(:sidekiq_service_unit_name) %> index=0
-#
-# Hack Upstart's reload command to 'quiet' Sidekiq:
-#
-#   sudo reload <%= fetch(:sidekiq_service_unit_name) %> index=0
-#
-# or use the service command:
-#   sudo service <%= fetch(:sidekiq_service_unit_name) %> {start,stop,restart,status}
-#
-
-description "Sidekiq for <%= "#{fetch(:application)} (#{fetch(:stage)})" %>"
-
-# This script is not meant to start on bootup, workers.conf
-# will start all sidekiq instances explicitly when it starts.
-#start on runlevel [2345]
-#stop on runlevel [06]
-<% if sidekiq_user %>
-
-# change to match your deployment user
-setuid <%= sidekiq_user %>
-setgid <%= sidekiq_user %>
-env HOME=/home/<%= sidekiq_user %>
-<% end %>
-
-# Greatly reduce Ruby memory fragmentation and heap usage
-# https://www.mikeperham.com/2018/04/25/taming-rails-memory-bloat/
-env MALLOC_ARENA_MAX=2
-
-respawn
-respawn limit 3 30
-
-# TERM is used when stopping sidekiq. Without declaring these as
-# normal exit codes, it just respawns.
-normal exit 0 TERM
-
-# Older versions of Upstart might not support the reload command and need
-# this commented out.
-reload signal TSTP
-
-# Upstart waits 5 seconds by default to kill a process. Increase timeout to
-# give sidekiq process enough time to exit.
-kill timeout 30
-<% if num_workers %>
-
-instance $index
-<% end %>
-script
-# this script runs in /bin/sh by default
-# respawn as bash so we can source in rbenv
-exec /bin/bash <<'EOT'
-  # Pick your poison :) Or none if you're using a system wide installed Ruby.
-  # rbenv
-  # source /home/apps/.bash_profile
-  # OR
-  # source /home/apps/.profile
-  # OR system:
-  # source /etc/profile.d/rbenv.sh
-  #
-  # rvm
-  # source /home/apps/.rvm/scripts/rvm
-
-  # Logs out to /var/log/upstart/<%= fetch(:sidekiq_service_unit_name) %>.log by default
-
-  cd <%= File.join(fetch(:deploy_to), 'current') %>
-  exec <%= SSHKit.config.command_map[:bundle] %> exec sidekiq -e <%= fetch(:sidekiq_env) %> <%= sidekiq_config %> <%= sidekiq_concurrency %> <%= sidekiq_queues %>
-EOT
-end script

data/lib/generators/capistrano/sidekiq/upstart/templates/workers.conf.erb

@@ -1,37 +0,0 @@
-# /etc/init/workers.conf - manage a set of Sidekiqs | https://github.com/mperham/sidekiq/blob/master/examples/upstart/workers.conf
-
-# This example config should work with Ubuntu 14.10 and below  It
-# allows you to manage multiple Sidekiq instances with
-# Upstart, Ubuntu's native service management tool.
-#
-# See sidekiq.conf for how to manage a single Sidekiq instance.
-#
-# Use "stop workers" to stop all Sidekiq instances.
-# Use "start workers" to start all instances.
-# Use "restart workers" to restart all instances.
-# Crazy, right?
-#
-
-description "manages the set of sidekiq processes"
-
-# This starts upon bootup and stops on shutdown
-start on runlevel [2345]
-stop on runlevel [06]
-
-# Set this to the number of Sidekiq processes you want
-# to run on this machine
-env NUM_WORKERS=2
-
-pre-start script
-  for i in `seq 1 ${NUM_WORKERS}`
-  do
-    start sidekiq index=$i
-  done
-end script
-
-post-stop script
-  for i in `seq 1 ${NUM_WORKERS}`
-  do
-    stop sidekiq index=$i
-  done
-end script