capistrano-mon 0.0.2 → 0.0.3

data/README.md

@@ -18,14 +18,32 @@ Or install it yourself as:
 
 ## Usage
 
- * `:mon_path` - "/etc/mon"
- * `:mon_lib_path` - "/var/lib/mon"
- * `:mon_log_path` - "/var/log/mon"
- * `:mon_dependencies` - `%w(mon)`
- * `:mon_plugins_path` - "/usr/local/lib/mon"
- * `:mon_plugins` - `{}`
- * `:mon_configure_files` - `%w(/etc/default/mon mon.cf))`
- * `:mon_service_name` - `"mon"`
+This recipe will setup Mon during `deploy:setup` task.
+
+To enable this recipe, add following in your `config/deploy.rb`.
+
+    # in "config/deploy.rb"
+    require "capistrano-mon"
+    set(:mon_services) {{
+      "ping" => {
+        :description => "Responses to ping",
+        :interval => "5m",
+        :monitor => "fping.monitor",
+        :period => "wd {Mon-Fri} hr {7am-10pm}",
+        :alert => "mail.alert root@localhost",
+        :alertevery => "1h",
+      }
+    }
+
+Following options are available to configure your Mon.
+
+ * `:mon_path` - The base path of Mon configurations. Use `/etc/mon` by default.
+ * `:mon_services` - The key-value map of `service` definitions of Mon.
+ * `:mon_dependencies` - The packages of Mon.
+ * `:mon_plugins_path` - The installation path for custom plugins.
+ * `:mon_plugins` - The information of custom plugins.
+ * `:mon_configure_files` - The configuration files of Mon.
+ * `:mon_service_name` - The name of Mon service. Use `mon` by default.
 
 ## Contributing
 

data/capistrano-mon.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = Capistrano::Mon::VERSION
   gem.authors       = ["Yamashita Yuu"]
   gem.email         = ["yamashita@geishatokyo.com"]
-  gem.description   = %q{a capistrano recipe to setup mon.}
-  gem.summary       = %q{a capistrano recipe to setup mon.}
+  gem.description   = %q{a capistrano recipe to setup Mon.}
+  gem.summary       = %q{a capistrano recipe to setup Mon.}
   gem.homepage      = "https://github.com/yyuu/capistrano-mon"
 
   gem.files         = `git ls-files`.split($/)

data/lib/capistrano-mon.rb

@@ -11,6 +11,42 @@ module Capistrano
           _cset(:mon_path, "/etc/mon")
           _cset(:mon_lib_path, "/var/lib/mon")
           _cset(:mon_log_path, "/var/log/mon")
+          _cset(:mon_hostgroup_name) { application }
+          _cset(:mon_hostgroup, %w(localhost))
+          _cset(:mon_services, {})
+          #
+          # Example:
+          #
+          # set(:mon_services) {{
+          #   "ping" => {
+          #     :description => "Responses to ping",
+          #     :interval => "5m",
+          #     :monitor => "fping.monitor",
+          #     :period => "wd {Mon-Fri} hr {7am-10pm}",
+          #     :alert => "mail.alert root@localhost",
+          #     :alertevery => "1h",
+          #   },
+          #   "http" => {
+          #     :description => "HTTP service",
+          #     :interval => "10m",
+          #     :monitor => "http.monitor",
+          #     :period => "",
+          #     :numalerts => 10,
+          #     :alert => "mail.alert root@localhost",
+          #     :upalert => "mail.alert root@localhost",
+          #   },
+          #   "smtp" => {
+          #     :description => "SMTP service",
+          #     :interval => "10m",
+          #     :monitor => "smtp.monitor -t 60",
+          #     :period => "",
+          #     :numalerts => 10,
+          #     :alert => "mail.alert root@localhost",
+          #     :upalert => "mail.alert root@localhost",
+          #   },
+          # }}
+          #
+
           desc("Setup mon.")
           task(:setup, :roles => :app, :except => { :no_release => true }) {
             transaction {
@@ -85,6 +121,20 @@ module Capistrano
 
           _cset(:mon_plugins_path, "/usr/local/lib/mon")
           _cset(:mon_plugins, [])
+          #
+          # Example:
+          #
+          # ## simple definition
+          # set(:mon_plugins, %w(
+          #   https://example.com/foo.alert
+          #   https://example.com/bar.monitor
+          # ))
+          #
+          # ## use custom plugin name
+          # set(:mon_plugins) {{
+          #   "https://gist.github.com/raw/2321002/pyhttp.monitor.py" => "pyhttp.monitor",
+          # }}
+          #
           task(:update_plugins, :roles => :app, :except => { :no_release => true }) {
             srcs = mon_plugins.map { |uri, name| uri }
             tmps = mon_plugins.map { |uri, name| tempfile('capistrano-mon') }

data/lib/capistrano-mon/templates/mon.cf.erb

@@ -21,12 +21,12 @@ dtlogfile = <%= fetch(:mon_dtlogfile, "dtlog") %>
 #
 # Define groups of hosts to monitor
 #
-hostgroup localhost <%= fetch(:mon_hostgroup, %w(localhost)).join(' ') %>
+hostgroup <%= mon_hostgroup_name %> <%= mon_hostgroup.join(' ') %>
 
 #
 # Define watches
 #
-watch localhost<% fetch(:mon_services, {}).each { |service_name, service_defs| %>
+watch <%= mon_hostgroup_name %><% fetch(:mon_services, {}).each { |service_name, service_defs| %>
   service <%= service_name %><% service_defs.each { |monitor_name, monitor_def| %><% if Array === monitor_def %><% monitor_def.each { |d| %>
     <%= monitor_name %> <%= d %><% } %><% else %>
     <%= monitor_name %> <%= monitor_def %><% end %><% } %><% } %>

data/lib/capistrano-mon/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Mon
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-mon
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-07 00:00:00.000000000 Z
+date: 2012-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -27,7 +27,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: a capistrano recipe to setup mon.
+description: a capistrano recipe to setup Mon.
 email:
 - yamashita@geishatokyo.com
 executables: []
@@ -67,5 +67,5 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: a capistrano recipe to setup mon.
+summary: a capistrano recipe to setup Mon.
 test_files: []