cappy-monit 0.1.0

data/Manifest.txt

@@ -0,0 +1,13 @@
+Manifest.txt
+README.txt
+Rakefile
+lib/capistrano-monit
+lib/capistrano-monit.rb
+lib/capistrano-monit/monit_command_helper.rb
+lib/capistrano-monit/monit_config_helper.rb
+lib/capistrano-monit/recipes.rb
+lib/capistrano-monit/templates
+lib/capistrano-monit/templates/mongrel.erb
+lib/capistrano-monit/templates/monit.erb
+test/capistrano-monit_test.rb
+test/monit_command_helper_test.rb

data/README.txt

@@ -0,0 +1,83 @@
+= Capistrano Monit Tasks
+
+This library extends Capistrano to configure and control a *monit* daemon running on application servers.
+It replaces some of the standard tasks with monit versions and includes tasks and helpers to create monit configuration files.
+See below for instructions on downloading and configuring monit itself.
+
+== Quick Start for cappy-monit
+
+This assumes you're creating a fresh application install, not migrating an app from
+spinner/spawner/reaper. It also assumes you have setup monit as shown above.
+
+Install the package via gems or .tgz / .zip and setup.rb.
+
+Include it in your deploy.rb with: 
+
+require "capistrano-monit/recipes"
+
+Place at least the following directives in your deploy recipe:
+
+  set :mongrel_address, "127.0.0.1"
+  set :mongrel_servers, 2
+  set :mongrel_environment, "production"
+  set :mongrel_port, 9000
+
+Then run:
+
+* cap cold_deploy
+
+This sets up one mongrel listener on port 8000 by default. Make sure your database is setup
+and point your webserver at the new listener.
+
+Deployment will create a monit configuration file for the mongrel processes in the shared/ directory.
+Monit should be automatically configured to include this file. 
+
+== Usage
+
+Capistrano Monit uses the same configuration directives as the Railsmachine mongrel_cluster gem. This means that you have
+to define the mongrel settings in your deployment recipe.
+
+Coming soon.
+
+== Getting and setting up monit
+
+Monit is a single-server monitoring and alerting package with a clean, natural configuration language. It runs as
+a daemon, which also responds as an HTTP server, to control processes and to display their status.
+
+The latest version of monit lives at: http://www.tildeslash.com/monit/download
+The monit manual is thorough and recommended reading: http://www.tildeslash.com/monit/doc/manual.php
+There are no complicated dependencies. Many operating systems include monit in its default package repositories (Debian, FreeBSD, CentOS).
+
+Here is what a minimal monitrc file might look like:
+
+# poll every 2 minutes (required)
+set daemon 120
+
+# log to syslog
+set logfile syslog facility log_daemon
+
+# use the defined mail servers for alerts (required)
+set mailserver mail.example.com, localhost
+
+# 
+set alert alerts@example.com # send alerts to this email address
+
+# run the http server (required) with the defined user:pass
+
+set httpd port 2812 and 
+allow admin:admin
+
+# setup basic system checks and alerts
+
+check system app-server-1
+        if loadavg (1min) > 4 then alert
+        if loadavg (5min) > 2 then alert
+        if memory usage > 75% then alert
+        if cpu usage (user) > 70% then alert
+        if cpu usage (system) > 30% then alert
+        if cpu usage (wait) > 20% then alert
+
+
+Place this file where you please (/etc/monit/monitrc for example). Running monit -c /etc/monit/monitrc should do the trick.
+Some people prefer to run Monit directly from init. Please refer to the Monit manual for more information.
+

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'hoe'
+require './lib/capistrano-monit'
+
+# don't require hoe as a dependency to install this gem
+class Hoe
+  def extra_deps
+    @extra_deps.reject { |x| Array(x).first == 'hoe' }
+  end
+end
+
+Hoe.new('cappy-monit', CapistranoMonitTasks::VERSION) do |p|
+  p.rubyforge_name = 'cappy-monit'
+  p.summary = 'Capistrano tasks for monitoring, controlling and configuring a remote monit instance.'
+  p.author = 'Joshua Sierles'
+  p.email = "joshua@diluvia.net"
+  p.url = "http://cappy-monit.rubyforge.org"
+  p.description = p.paragraphs_of('README.txt', 1..1).join("\n\n")
+  p.extra_deps = ["capistrano"]
+end

data/lib/capistrano-monit.rb

@@ -0,0 +1,3 @@
+class CapistranoMonitTasks
+  VERSION = '0.1.0'
+end

data/lib/capistrano-monit/monit_command_helper.rb

@@ -0,0 +1,49 @@
+begin
+  require 'capistrano'
+rescue LoadError
+  require 'rubygems'
+  require 'capistrano'
+end
+
+# This module creates Capistrano tasks for controlling processes monitored by monit
+#
+# Supported non-group commands are:
+# * start, stop, restart, monitor, unmonitor
+#
+# Supported group commands:
+# * start_group, stop_group, restart_group, monitor_group, unmonitor_group
+#
+# Providing 'all' as a non-group argument will affect all monitored services
+#
+# Usage examples:
+#
+# * <tt>monit.restart_group :mongrel_cluster</tt>
+# * <tt>monit.restart 'lighttpd'</tt>
+# * <tt>monit.stop ['mongrel-9000','mongrel-9001']</tt>
+# * <tt>monit.unmonitor :all</tt>
+##
+# The methods are available through monit.<method name> in your deploy.rb
+#
+
+module MonitCommandHelper
+  PROCESS_SIGNALS = %w(start stop restart monitor unmonitor)
+  
+  PROCESS_SIGNALS.each do |command|
+    define_method(command) do |services|
+      if services.to_sym == :all
+        send(run_method, "monit #{command} all")
+        # TODO: confirm here whether the user really wants to restart ALL services
+      elsif services.is_a? Array
+        services.each {|serv| run "monit #{command} #{serv}" }
+      else
+        send(run_method, "monit #{command} #{services}")
+      end
+    end
+
+    define_method(command + "_group") do |serv|
+      send(run_method, "monit -g #{serv} #{command} all")
+    end
+  end
+end
+
+Capistrano.plugin :monit, MonitCommandHelper

data/lib/capistrano-monit/monit_config_helper.rb

@@ -0,0 +1,91 @@
+begin
+  require 'capistrano'
+rescue LoadError
+  require 'rubygems'
+  require 'capistrano'
+end
+
+# This modules provides methods to create monitrc configuration files for various services
+#
+# The methods are available through monitrc.<method name> in your deploy.rb 
+#
+# Currently you are required to manually modify your main monitrc file to include those generated by capistrano.
+#
+# An example include directive:
+# * include "/home/myapp/config/monit/*.monitrc"
+#
+#
+module MonitrcHelper
+  # Creates a monitrc file from a template, puts it on the server at the given
+  # path and sets file permissions to 0700.
+  #
+  # * template can be 'mongrel' or the name of a file or a string.
+  #   'mongrel' uses the standard mongrel templates provided with this package.
+  #   See get_template below for a list of places searched for template files of your own.
+  #
+
+  def create(template, path, options = {})
+    
+    template = template.to_s
+        
+    options = add_default_options(options)
+
+    if template == 'mongrel'
+      config_data = mongrel_ports.collect {|port| render options.merge(:template => get_template(template), :port => port)}.join("\n\n")
+    else
+      config_data = render options.merge(:template => get_template(template))
+    end
+    put config_data, path, :mode => 0700
+  
+  end
+    
+  # Works out whether the given template is a file or string containing rhtml.
+  # 
+  # Checks:
+  # * current directory
+  # * monitrc_templates path (defaults to templates/monit)
+  # * capistrano-monit-tasks-templates dir where cappy-monit is installed
+  #   (the standard templates are here)
+  # 
+  # If it can't find the file it assumes it's a one line string template and 
+  # returns that
+  def get_template(template)
+    if template =~ /<%/ or template =~ /\n/
+      template
+    else
+      [ ".",
+        configuration.monitrc_template_path,
+        File.join(File.dirname(__FILE__), 'templates')
+      ].each do |dir|
+        if File.file?(File.join(dir, template))
+          return File.read(File.join(dir, template))
+        elsif File.file?(File.join(dir, template + ".erb"))
+          @file_template_full_path = File.join(dir, template + ".erb")
+          return File.read(File.join(dir, template + ".erb"))
+        end
+      end
+    end
+    template
+  end
+  
+  protected
+  def add_default_options(options)
+    {:shared_path => configuration.shared_path,
+     :mongrel_pid_path => configuration.mongrel_pid_path,
+     :mongrel_path => configuration.mongrel_path,
+     :mongrel_user => configuration.mongrel_user,
+     :mongrel_group => configuration.mongrel_group,
+     :monitrc_path => configuration.monitrc_path,
+     :address => configuration.address,
+     :rails_env => configuration.rails_env,
+     :release_path => configuration.release_path,
+     :deploy_to => configuration.deploy_to
+     }.merge(options)
+  end
+  
+  def mongrel_ports
+    (configuration.mongrel_port..configuration.mongrel_port + (configuration.mongrel_servers - 1)).to_a
+  end
+end
+
+Capistrano.plugin :monitrc, MonitrcHelper

data/lib/capistrano-monit/recipes.rb

@@ -0,0 +1,105 @@
+require 'capistrano-monit/monit_command_helper'
+require 'capistrano-monit/monit_config_helper'
+
+Capistrano.configuration(:must_exist).load do
+
+  MONIT_SIGNALS = %w(status summary reload validate)
+
+  set :monit_http_port, 2812
+  set :monitrc_path, '/etc/monitrc'
+  set :mongrel_path, '/usr/local/bin/mongrel_rails'
+  set :mongrel_servers, 2
+  set :mongrel_port, 8000
+  set :config_type, 'mongrel'
+  set :address, "127.0.0.1"
+  set :cluster_group_name, Proc.new { "#{application}_mongrels"}
+  set :mongrel_pid_path, Proc.new { "#{shared_path}/log" }
+  set :mongrel_user, nil
+  set :mongrel_group, nil
+  set :mongrel_monitrc_path, Proc.new { "#{shared_path}/monit/#{config_type}.monitrc" }
+  set :monitrc_template_path, File.join('templates', 'monit')
+  set :use_sudo, true
+  
+  desc <<-DESC
+  Create a monitrc file for the mongrel cluster and update the main monitrc. Obeys the :use_sudo directive (default is true).
+  DESC
+  task :configure_mongrel_cluster, :roles => :app do
+    run "mkdir -p #{shared_path}/monit"
+    monitrc.create 'mongrel', mongrel_monitrc_path
+    found_paths = capture("find /etc /usr/local/etc -name monitrc -o -name monit.conf 2>/dev/null || exit 0")
+    path = found_paths.split("\r\n").first
+    if path && path.length > 0
+      include_line = '"include '+mongrel_monitrc_path+'"'
+      command = "if ! sudo grep #{mongrel_monitrc_path} #{path} > /dev/null; then sudo sh -c 'echo #{include_line} >> #{path}'; fi"
+      run(command) do |channel, stream, data|
+        if data =~ /^Password:/
+            pass = readline("Sudo password:")
+            channel.send_data "#{pass}\n"
+        end
+      end
+      
+    else
+      puts "Could not find a file named monitrc nor monit.conf in /etc nor /usr/local/etc. Please add this line to your monitrc file manually: \n"
+      puts "include #{mongrel_monitrc_path}"
+    end
+    monit_reload
+  end
+  
+  desc <<-DESC
+  Start Mongrel processes on the app server using monit. 
+  Obeys the :use_sudo directive (default is true).
+  Overrides equivalent task from the mongrel_cluster gem.
+  DESC
+  task :start_mongrel_cluster, :roles => :app do
+    monit.start_group cluster_group_name
+  end
+  
+  desc <<-DESC
+  Restart the mongrel processes on the app server using monit.
+  Obeys the :use_sudo directive (default is true).
+  Overrides equivalent task from the mongrel_cluster gem.
+  DESC
+  task :restart_mongrel_cluster, :roles => :app do
+    monit.restart_group cluster_group_name
+  end
+  
+  desc <<-DESC
+  Stop the mongrel processes on the app server using monit.
+  Obeys the :use_sudo directive (default is true).
+  Overrides equivalent task from the mongrel_cluster gem.
+  DESC
+  task :stop_mongrel_cluster, :roles => :app do
+    monit.stop_group cluster_group_name
+  end
+  
+  desc <<-DESC
+  Restart the mongrel processes on the app servers -  alias of :restart_mongrel_cluster
+  DESC
+  task :restart, :roles => :app do
+    restart_mongrel_cluster
+  end
+  
+  desc <<-DESC
+  Start the Mongrel processes on the app servers - alias of :start_mongrel_cluster
+  DESC
+  task :spinner, :roles => :app do
+    configure_mongrel_cluster
+    start_mongrel_cluster
+  end
+
+  desc <<-DESC
+  Get the current status of the application server monit daemons.
+  DESC
+  task :monit_status, :roles => :app do
+    monit.status
+  end
+
+  
+  MONIT_SIGNALS.each do |command|
+    desc "Run the monit '#{command}' on application servers"
+    task "monit_#{command}" do
+      send(run_method, "monit #{command}")
+    end
+  end
+  
+end

data/lib/capistrano-monit/templates/mongrel.erb

@@ -0,0 +1,11 @@
+check process mongrel-<%= port %> with pidfile "<%= shared_path %>/log/mongrel.<%= port %>.pid"
+    start program = "<%= mongrel_path %> start -p <%= port %> -P <%= shared_path %>/log/mongrel.<%= port %>.pid -e <%= rails_env %> -a <%= address %> -c <%= deploy_to %>/current -d"	
+	<% if mongrel_user and mongrel_group %>
+	as uid <%= mongrel_user %> and gid <%= mongrel_group %>
+    <% end %>
+	stop program = "<%= mongrel_path %> stop -p <%= shared_path %>/log/mongrel.<%= port %>.pid"
+    if mem > 200 Mb then alert
+    if cpu usage > 95% for 3 cycles then restart
+    if failed port <%= port %> protocol http with timeout 15 seconds then restart
+    if 2 restarts within 3 cycles then timeout
+	group <%= cluster_group_name %>

data/lib/capistrano-monit/templates/monit.erb

@@ -0,0 +1,14 @@
+set daemon 120
+set logfile syslog facility log_daemon
+set mailserver mail.example.com, localhost
+set alert alerts@example.com
+set httpd port 2812 and
+allow admin:pass
+
+check system app-server
+        if loadavg (1min) > 4 then alert
+        if loadavg (5min) > 2 then alert
+        if memory usage > 75% then alert
+        if cpu usage (user) > 70% then alert
+        if cpu usage (system) > 30% then alert
+        if cpu usage (wait) > 20% then alert

data/test/capistrano-monit_test.rb

@@ -0,0 +1,38 @@
+$:.unshift File.dirname(__FILE__) + "/../lib"
+
+require 'test/unit'
+begin
+  require 'capistrano'
+rescue LoadError
+  require 'rubygems'
+  require 'capistrano'
+end
+
+class CapistranoRunitTasksConfigurationTest < Test::Unit::TestCase
+  class MockActor
+    attr_reader :tasks
+
+    def initialize(config)
+    end
+
+    def define_task(*args, &block)
+      (@tasks ||= []).push [args, block].flatten
+    end
+  end
+
+  def setup
+    @config = Capistrano::Configuration.new(MockActor)
+    file = File.dirname(__FILE__) + "/fixtures/monit_config.rb"
+    @config.load file
+  end  
+
+  def test_should_include_capistrano_monit_tasks
+    assert task_names(@config.actor.tasks).include?(:configure_monit)
+  end
+  
+  def task_names(tasks)
+    tasks.map { |task| task[0] }
+  end
+end
+
+

data/test/monit_command_helper_test.rb

@@ -0,0 +1,35 @@
+$:.unshift File.dirname(__FILE__) + "/../lib/capistrano-monit", File.dirname(__FILE__)
+
+require 'test/unit'
+require 'test_helper'
+require 'monit_command_helper'
+
+class RunitRunnerHelperTest < Test::Unit::TestCase
+  include TestHelper
+  
+  TEST_PROCESS_SIGNALS = %w(start stop restart monitor unmonitor)
+  TEST_MONIT_SIGNALS = %w(status summary reload validate)
+  
+  def setup
+    @actor = TestActor.new(MockConfiguration.new)
+  end
+
+  def test_should_load_monit_runner_helper
+    assert Capistrano.const_get(:EXTENSIONS).include?(:monit)
+  end
+
+  def test_should_generate_correct_single_process_commands
+    TEST_PROCESS_SIGNALS.each_with_index do |signal, i|
+      @actor.monit.send(signal, "foo")
+      assert_equal "monit #{signal} foo", @actor.run_data[i]
+    end
+  end
+
+  def test_should_generate_correct_group_process_commands
+    TEST_PROCESS_SIGNALS.each_with_index do |signal, i|
+      @actor.monit.send(signal+"_group", "foo")
+      assert_equal "monit -g foo #{signal} all", @actor.run_data[i]
+    end
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'capistrano'
+
+module TestHelper
+  class TestingConnectionFactory
+    def initialize(config)
+    end
+
+    def connect_to(server)
+      server
+    end
+  end
+
+  class TestActor < Capistrano::Actor
+    attr_reader :put_data, :run_data
+    
+    def run(cmd, options={}, &block)
+      (@run_data ||= []) << cmd
+    end
+  
+    def put(data, path, options={})
+      (@put_data ||= {})[path] = data
+    end
+
+    self.connection_factory = TestingConnectionFactory
+    
+    def reset!
+      @put_data = {}
+      @run_data = []
+    end
+  end
+
+  class MockConfiguration    
+    def initialize
+      @variables = {}
+    end
+    
+    def set(variable, value = nil)
+      @variables[variable] = value
+    end
+    
+    Role = Struct.new(:host, :options)
+
+    ROLES = { 
+      :db  => [ Role.new("01.example.com", :primary => true)],
+      :web => [ Role.new("01.example.com", {})],
+      :app => [ Role.new("01.example.com", {})]
+    }
+
+    def roles
+      ROLES
+    end
+    
+    def method_missing(sym, *args, &block)
+      if @variables.has_key?(sym)
+        @variables[sym]
+      else
+        super
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: cappy-monit
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2007-03-28 00:00:00 +02:00
+summary: Capistrano tasks for monitoring, controlling and configuring a remote monit instance.
+require_paths: 
+- lib
+email: joshua@diluvia.net
+homepage: http://cappy-monit.rubyforge.org
+rubyforge_project: cappy-monit
+description: This library extends Capistrano to configure and control a *monit* daemon running on application servers. It replaces some of the standard tasks with monit versions and includes tasks and helpers to create monit configuration files. See below for instructions on downloading and configuring monit itself.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Joshua Sierles
+files: 
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/capistrano-monit
+- lib/capistrano-monit.rb
+- lib/capistrano-monit/monit_command_helper.rb
+- lib/capistrano-monit/monit_config_helper.rb
+- lib/capistrano-monit/recipes.rb
+- lib/capistrano-monit/templates
+- lib/capistrano-monit/templates/mongrel.erb
+- lib/capistrano-monit/templates/monit.erb
+- test/capistrano-monit_test.rb
+- test/monit_command_helper_test.rb
+test_files: 
+- test/test_helper.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capistrano
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: