negroku 2.7.1 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1d9ecc22e781dfa34d98eda35a0152c45f6560d
-  data.tar.gz: d1c714e5c32e0731b4e217f2455e6684914f1405
+  metadata.gz: c0754344fcb7eade9c733cf98caa26c6e8fb8b4d
+  data.tar.gz: 921c0b28575cc07474c1a20a93c0b9a51c74d726
 SHA512:
-  metadata.gz: 0639ddb5da43a59ca1b85174a14b47464cb7832ba904b053b7a150246cc6b836d323c754429b32241a4eb7eacc42db050be47b5af909e55e772c98ecca0fa1ce
-  data.tar.gz: eb4f53de5848c4a18fed608894791df5ef85b3c796b5c9897286b667bfd9c5586ae5702aa2c03b3eea6d1fa16c0d16bd0e2e8e9451cc6b9346f4c03dbf36d284
+  metadata.gz: 832d8bb854c6f7df31038f23c1dd7e2ffdc3877acd40c90cc03ec2fcbf7b83d58585f9d21fdd8af31f82487ce64f0cc16320f1375aa48a2dde15706d82d60133
+  data.tar.gz: 71282695a9647abc0b938bb25e4c7a581542a97546cb4a93b92a60922f3bbd102bc80126b123b76758e214fe2bcdb5905ccfc4949b1cf34aa21f0ccf2fc2e036

data/CHANGELOG.md

@@ -4,7 +4,15 @@ Reverse Chronological Order:
 
 ## Unreleased
 
-https://github.com/platanus/negroku/compare/v2.7.1...HEAD
+https://github.com/platanus/negroku/compare/v2.8.0...HEAD
+
+## `2.8.0`
+
+https://github.com/platanus/negroku/compare/v2.7.1...2.8.0
+
+FEAT:
+- Adds some settings to process monitoring.
+  You can config timeouts and grace times.
 
 ## `2.7.1`
 

data/docs/TASKS.md

@@ -1,11 +1,58 @@
 # Tasks
 
+* [Eye](#eye)
 * [Rails](#rails)
     * [Remote Console](#remote-console)
 * [Whenever](#whenever)
     * [Config](#config)
 * [Logs](#logs)
 
+### Eye
+
+Negroku support process monitoring via the [Eye gem](https://github.com/kostya/eye). Currently adds monitoring to
+
+- unicorn
+- puma
+- thinking_sphinx
+- delayed_job
+
+Each monitor can be further customized using variables.
+
+```ruby
+set: eye_<process>_<setting>, <value>
+```
+
+The main setting that can be customized are timeouts and grace times.
+
+```ruby
+# delayed job timeouts
+set: eye_delayed_job_start_timeout, 20.seconds
+set: eye_delayed_job_stop_timeout, 1.minute
+set: eye_delayed_job_restart_timeout, 1.minute
+
+# For puma
+set: eye_puma_start_grace, 45.seconds
+set: eye_puma_stop_grace, 30.seconds
+set: eye_puma_restart_grace, 2.minutes
+```
+
+#### Monitor custom processes
+
+If you have other processes in your applicacion you can monitor them
+using the `watch_process` method in your `deploy.rb` file
+
+You'll need to setup the **start_command**, **stop_command** and **pid location**.
+
+```ruby
+watch_process(:other_process, template: :process,
+                              start_command: "process start",
+                              stop_command: "process stop",
+                              start_timeout: 50.seconds,
+                              restart_grace: 1.minutes,
+                              pid_file: "path/to/pid"
+             )
+```
+
 ### Rails
 
 ##### Remote Console

data/lib/negroku/capistrano/tasks/env.rake

@@ -5,4 +5,6 @@ namespace :env do
   desc 'Env variables changed'
   task :changed do
   end
+
+  after 'env:changed', 'eye:hard_restart'
 end

data/lib/negroku/capistrano/tasks/eye/delayed_job.rake

@@ -1,42 +1,38 @@
 #########
 ## Adds support to monitor delayed_job processes through eye
 #########
-def delayed_job_args
-  args = []
-  args << "--queues=#{fetch(:delayed_job_queues).join(',')}" unless fetch(:delayed_job_queues).nil?
-  args << "--prefix=#{fetch(:delayed_job_prefix)}" unless fetch(:delayed_job_prefix).nil?
-  args << fetch(:delayed_job_pools, {}).map {|k,v| "--pool=#{k}:#{v}"}.join(' ') unless fetch(:delayed_job_pools).nil?
-  args.join(' ')
-end
 
-def delayed_job_bin
-  "#{fetch(:delayed_job_bin_path)}/delayed_job"
-end
+# Watch the delayed_job processes using the build in template
+namespace :delayed_job do
+  # Remove the multi process arg
+  def delayed_job_single_args
+    delayed_job_args.gsub(/-n\s\d\s*/, "")
+  end
 
-def delayed_job_start_command
-  "#{fetch(:rbenv_prefix)} bundle exec #{delayed_job_bin} #{delayed_job_args} -i \#{i} start"
-end
+  def delayed_job_start_command
+    "#{fetch(:rbenv_prefix)} bundle exec #{delayed_job_bin} #{delayed_job_single_args} -i \#{i} start"
+  end
 
-def delayed_job_stop_command
-  "#{fetch(:rbenv_prefix)} bundle exec #{delayed_job_bin} -i \#{i} stop"
-end
+  def delayed_job_stop_command
+    "#{fetch(:rbenv_prefix)} bundle exec #{delayed_job_bin} #{delayed_job_single_args} -i \#{i} stop"
+  end
 
-# Watch the delayed_job processes using the build in template
-namespace :eye do
   task :watch_process do
-
-    watch_process(:delayed_job, {
-      start_command: delayed_job_start_command,
-      stop_command: delayed_job_stop_command
-    })
-
+    watch_process(:delayed_job, start_command: delayed_job_start_command,
+                                stop_command: delayed_job_stop_command,
+                                start_timeout: fetch(:eye_delayed_job_start_timeout, 60),
+                                stop_timeout: fetch(:eye_delayed_job_stop_timeout, 30),
+                                restart_timeout: fetch(:eye_delayed_job_restart_timeout, 30),
+                                start_grace: fetch(:eye_delayed_job_start_grace, 100),
+                                stop_grace: fetch(:eye_delayed_job_stop_grace, 30),
+                                restart_grace: fetch(:eye_delayed_job_restart_grace, 30),
+                                workers: fetch(:delayed_job_workers, 1)
+                 )
   end
-end
 
-# Override start, restart and stop delayed_job tasks to so they call
-# the eye equivalents
-namespace :delayed_job do
-  ['start','restart','stop'].each do |cmd|
+  # Override start, restart and stop delayed_job tasks to so they call
+  # the eye equivalents
+  ['start', 'restart', 'stop'].each do |cmd|
     if Rake::Task.task_defined?("delayed_job:#{cmd}")
       Rake::Task["delayed_job:#{cmd}"].clear_actions
       # Reload or restart delayed_job after the application is published

data/lib/negroku/capistrano/tasks/eye/puma.rake

@@ -3,18 +3,19 @@
 #########
 
 # Watch the puma processes using the build in template
-namespace :eye do
+namespace :puma do
   task :watch_process do
-
-    watch_process(:puma);
-
+    watch_process(:puma, start_timeout: fetch(:eye_puma_start_timeout, 60),
+                         stop_timeout: fetch(:eye_puma_stop_timeout, 30),
+                         restart_timeout: fetch(:eye_puma_restart_timeout, 30),
+                         start_grace: fetch(:eye_puma_start_grace, 100),
+                         stop_grace: fetch(:eye_puma_stop_grace, 30),
+                         restart_grace: fetch(:eye_puma_restart_grace, 30))
   end
-end
 
-# Override start, restart and stop puma tasks to so they call
-# the eye equivalents
-namespace :puma do
-  ['start','restart','stop'].each do |cmd|
+  # Override start, restart and stop puma tasks to so they call
+  # the eye equivalents
+  ['start', 'restart', 'stop'].each do |cmd|
     if Rake::Task.task_defined?("puma:#{cmd}")
       Rake::Task["puma:#{cmd}"].clear_actions
       # Reload or restart puma after the application is published

data/lib/negroku/capistrano/tasks/eye/thinking_sphinx.rake

@@ -3,18 +3,19 @@
 #########
 
 # Watch the sphinx processes using the build in template
-namespace :eye do
+namespace :thinking_sphinx do
   task :watch_process do
-
-    watch_process(:sphinx);
-
+    watch_process(:sphinx, start_timeout: fetch(:eye_thinking_sphinx_start_timeout, 60),
+                           stop_timeout: fetch(:eye_thinking_sphinx_stop_timeout, 30),
+                           restart_timeout: fetch(:eye_thinking_sphinx_restart_timeout, 30),
+                           start_grace: fetch(:eye_thinking_sphinx_start_grace, 100),
+                           stop_grace: fetch(:eye_thinking_sphinx_stop_grace, 30),
+                           restart_grace: fetch(:eye_thinking_sphinx_restart_grace, 30))
   end
-end
 
-# Override start, restart and stop sphinx tasks to so they call
-# the eye equivalents
-namespace :thinking_sphinx do
-  ['start','restart','stop'].each do |cmd|
+  # Override start, restart and stop sphinx tasks to so they call
+  # the eye equivalents
+  ['start', 'restart', 'stop'].each do |cmd|
     if Rake::Task.task_defined?("thinking_sphinx:#{cmd}")
       Rake::Task["thinking_sphinx:#{cmd}"].clear_actions
       # Reload or restart after the application is published

data/lib/negroku/capistrano/tasks/eye/unicorn.rake

@@ -3,18 +3,19 @@
 #########
 
 # Watch the unicorn processes using the build in template
-namespace :eye do
+namespace :unicorn do
   task :watch_process do
-
-    watch_process(:unicorn);
-
+    watch_process(:unicorn, start_timeout: fetch(:eye_puma_start_timeout, 60),
+                            stop_timeout: fetch(:eye_puma_stop_timeout, 30),
+                            restart_timeout: fetch(:eye_puma_restart_timeout, 30),
+                            start_grace: fetch(:eye_puma_start_grace, 100),
+                            stop_grace: fetch(:eye_puma_stop_grace, 30),
+                            restart_grace: fetch(:eye_puma_restart_grace, 30))
   end
-end
 
-# Override start, restart and stop unicorn tasks to so they call
-# the eye equivalents
-namespace :unicorn do
-  ['start','restart','stop'].each do |cmd|
+  # Override start, restart and stop unicorn tasks to so they call
+  # the eye equivalents
+  ['start', 'restart', 'stop'].each do |cmd|
     if Rake::Task.task_defined?("unicorn:#{cmd}")
       Rake::Task["unicorn:#{cmd}"].clear_actions
       # Reload or restart unicorn after the application is published

data/lib/negroku/capistrano/tasks/eye.rake

@@ -25,13 +25,14 @@ namespace :load do
   end
 end
 
-namespace :env do
-  desc 'Env variables changed'
-  task :changed do
-  end
-end
+# namespace :env do
+#   desc 'Env variables changed'
+#   task :changed do
+#   end
+# end
 
 namespace :eye do
+  WATCHED_PROCESSES = %w[unicorn delayed_job thinking_sphinx puma]
 
   desc "Loads eye config and starts monitoring"
   task :load do
@@ -60,48 +61,45 @@ namespace :eye do
       end
     end
   end
-end
-
-# Adds some task on complement the capistrano3-unicorn tasks
-# This tasks are under the negroku namespace for easier identification
-namespace :negroku do
-
-  namespace :eye do
 
-    desc "Upload eye configuration file"
-    task :setup => 'eye:watch_process' do
-      on release_roles fetch(:eye_roles) do
-        within "#{shared_path}/config" do
-          processes = fetch(:eye_watched_processes, {})
-
-          template_path = fetch(:eye_application_template)
+  desc "Upload eye configuration file"
+  task :setup do
+    WATCHED_PROCESSES.each do |task_name|
+      begin
+        Rake::Task["#{task_name}:watch_process"].invoke
+      rescue StandardError
+      end
+    end
 
-          # use a build in template if the template doesn't exists in the project
-          unless File.exists?(template_path)
-            template_path = "capistrano/templates/eye/application.eye.erb"
-          end
+    on release_roles fetch(:eye_roles) do
+      within "#{shared_path}/config" do
+        processes = fetch(:eye_watched_processes, {})
 
-          config = build_template(template_path, nil, binding)
-          upload! config, '/tmp/application.eye'
+        template_path = fetch(:eye_application_template)
 
-          execute :mv, '/tmp/application.eye', 'eye.rb'
+        # use a build in template if the template doesn't exists in the project
+        unless File.exists?(template_path)
+          template_path = "capistrano/templates/eye/application.eye.erb"
         end
-      end
-    end
 
-    before "deploy:published", "negroku:eye:setup"
-    after "negroku:eye:setup", "eye:load"
+        config = build_template(template_path, nil, binding)
+        upload! config, '/tmp/application.eye'
 
-    after 'env:changed', 'hard-restart' do
-      invoke 'eye:stop'
-      invoke 'eye:load'
-      invoke 'eye:start'
+        execute :mv, '/tmp/application.eye', 'eye.rb'
+      end
     end
+  end
 
-    define_logs(:eye, {
-      app: 'eye.log'
-    })
-
+  desc "Restart application by stoping, reloading and starting"
+  task :hard_restart do
+    invoke 'eye:stop'
+    sleep 5
+    invoke 'eye:load'
+    invoke 'eye:start'
   end
 
+  before "deploy:published", "eye:setup"
+  after "eye:setup", "eye:load"
+
+  define_logs(:eye, app: 'eye.log')
 end

data/lib/negroku/capistrano/templates/eye/_delayed_job.erb

@@ -1,13 +1,17 @@
   group 'delayed-jobs' do
     chain grace: 10.seconds
 
-    start_timeout <%= options[:start_timeout] || "30.seconds" %>
-    stop_timeout <%= options[:stop_timeout] || "40.seconds"  %>
-    restart_timeout <%= options[:restart_timeout] || "30.seconds"  %>
+    start_timeout <%= options[:start_timeout] %>.seconds
+    stop_timeout <%= options[:stop_timeout] %>.seconds
+    restart_timeout <%= options[:restart_timeout] %>.seconds
 
-    workers_count = '<%= fetch(:delayed_job_workers || 1) %>'.to_i
+    start_grace <%= options[:start_grace] %>.seconds
+    stop_grace <%= options[:stop_grace] %>.seconds
+    restart_grace <%= options[:restart_grace] %>.seconds
 
-    (0 ... workers_count.to_i).each do |i|
+    workers_count = <%= options[:workers] %>
+
+    (0 ... workers_count).each do |i|
 
     process "worker-#{i}" do
       pid_file "tmp/pids/delayed_job.#{i}.pid"
@@ -18,4 +22,3 @@
     end
 
   end
-

data/lib/negroku/capistrano/templates/eye/_process.erb

@@ -1,10 +1,13 @@
   process "<%= options[:name] %>" do
-    start_timeout <%= options[:start_timeout] || "30.seconds" %>
-    stop_timeout <%= options[:stop_timeout] || "20.seconds"  %>
-    restart_timeout <%= options[:restart_timeout] || "30.seconds"  %>
-
     pid_file "<%= options[:pid_file] %>"
     start_command "<%= options[:start_command] %>"
     stop_command "<%= options[:stop_command] %>"
-  end
 
+    start_timeout <%= options[:start_timeout] || 60 %>.seconds
+    stop_timeout <%= options[:stop_timeout] || 30 %>.seconds
+    restart_timeout <%= options[:restart_timeout] || 30 %>.seconds
+
+    start_grace <%= options[:start_grace] || 100 %>.seconds
+    stop_grace <%= options[:stop_grace] || 30 %>.seconds
+    restart_grace <%= options[:restart_grace] || 30 %>.seconds
+  end

data/lib/negroku/capistrano/templates/eye/_puma.erb

@@ -14,6 +14,11 @@
     <%= fetch(:puma_master_cpu_checks) %>
     <%= fetch(:puma_master_memory_checks) %>
 
-    start_timeout 100.seconds
-    restart_grace 30.seconds
+    start_timeout <%= options[:start_timeout] %>.seconds
+    stop_timeout <%= options[:stop_timeout] %>.seconds
+    restart_timeout <%= options[:restart_timeout] %>.seconds
+
+    start_grace <%= options[:start_grace] %>.seconds
+    stop_grace <%= options[:stop_grace] %>.seconds
+    restart_grace <%= options[:restart_grace] %>.seconds
   end

data/lib/negroku/capistrano/templates/eye/_sphinx.erb

@@ -9,6 +9,11 @@
 
     check :cpu, :every => 30, :below => 80, :times => 3
 
-    start_timeout 100.seconds
-    restart_grace 30.seconds
+    start_timeout <%= options[:start_timeout] %>.seconds
+    stop_timeout <%= options[:stop_timeout] %>.seconds
+    restart_timeout <%= options[:restart_timeout] %>.seconds
+
+    start_grace <%= options[:start_grace] %>.seconds
+    stop_grace <%= options[:stop_grace] %>.seconds
+    restart_grace <%= options[:restart_grace] %>.seconds
   end

data/lib/negroku/capistrano/templates/eye/_unicorn.erb

@@ -14,8 +14,13 @@
     <%= fetch(:unicorn_master_cpu_checks) %>
     <%= fetch(:unicorn_master_memory_checks) %>
 
-    start_timeout 100.seconds
-    restart_grace 30.seconds
+    start_timeout <%= options[:start_timeout] %>.seconds
+    stop_timeout <%= options[:stop_timeout] %>.seconds
+    restart_timeout <%= options[:restart_timeout] %>.seconds
+
+    start_grace <%= options[:start_grace] %>.seconds
+    stop_grace <%= options[:stop_grace] %>.seconds
+    restart_grace <%= options[:restart_grace] %>.seconds
 
     monitor_children do
       stop_command "kill -QUIT {PID}"

data/lib/negroku/templates/Capfile.erb

@@ -2,6 +2,7 @@
 CAPFILE_VERSION = "<%= Negroku::VERSION %>"
 
 # Load DSL and Setup Up Stages
+require 'active_support/all'
 require 'capistrano/setup'
 
 # Includes default deployment tasks

data/lib/negroku/version.rb

@@ -1,3 +1,3 @@
 module Negroku
-  VERSION = '2.7.1'
+  VERSION = '2.8.0'
 end

data/negroku.gemspec

@@ -22,7 +22,8 @@ spec = Gem::Specification.new do |s|
 
   s.add_runtime_dependency('rake', '~> 10.1')
   s.add_runtime_dependency('bundler', '~> 1.0')
-  s.add_runtime_dependency('capistrano','~> 3.4.0')
+  s.add_runtime_dependency('activesupport', '~> 3.0')
+  s.add_runtime_dependency('capistrano', '~> 3.4.0')
   s.add_runtime_dependency('capistrano-rbenv', '~> 2.0.3')
   s.add_runtime_dependency('capistrano-rails', '~> 1.1.3')
   s.add_runtime_dependency('capistrano-bundler', '~> 1.1.4')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: negroku
 version: !ruby/object:Gem::Version
-  version: 2.7.1
+  version: 2.8.0
 platform: ruby
 authors:
 - Juan Ignacio Donoso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-30 00:00:00.000000000 Z
+date: 2015-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -80,6 +80,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: capistrano
   requirement: !ruby/object:Gem::Requirement