nines 1.0.0 → 1.0.1

data/README.rdoc

@@ -2,16 +2,49 @@
 
 Nines is a simple server monitoring tool written in Ruby. It reads in hand-coded YAML config files (see config.yml.sample). Rename to config.yml and edit as needed before first run.
 
-When run, it forks into the background and runs in a continuous loop. If there are bugs in the code (likely) it may die, so keep it running with monit, init, etc.
+When run, it forks into the background and runs in a continuous loop. If there are bugs in the code (possible) it may die, so keep it running with monit, init, cron, whatever.
+
+It's no substitute for paid services like Pingdom, but it's great for keeping tabs on less critical services.
 
 =Usage
 
-git clone git://github.com/anamba/nines.git && cd nines && bundle install && bundle exec ./nines
-To stop: bundle exec ./nines stop
+ % gem install nines
+ % nines -f <config file> start
+
+The config file can be in YAML or ruby format. Refer to the included examples: {nines.yml.sample}[https://github.com/anamba/nines/blob/master/nines.yml.sample] |  {nines.rb.sample}[https://github.com/anamba/nines/blob/master/nines.rb.sample]
+
+What if you have only one server, and you want to monitor it? You do need to have a server to run nines on, and you don't want to have your one server monitoring itself. If you have a shared hosting account that allows shell access, you can run nines there. Many hosts offer an ancient version of ruby, but you can work around that with {rvm}[https://rvm.io/rvm/install/]. Here's how (tested on {Dreamhost}[http://dreamhost.com/]:
+ 
+ % \curl -L https://get.rvm.io | bash -s stable --ruby  # installs rvm and stable version of ruby (currently 1.9.3p327)
+ % echo 'gem: --no-ri --no-rdoc' > ~/gemrc              # gems install more quickly sans documentation
+ % gem install nines                                    # grab the latest version of the nines gem
+ % cd ; mkdir nines && cd nines                         # put nines stuff in its own dir
+ % vi nines.yml                                         # create a config file (start with a sample config)
+ % nines -d -f nines.yml                                # then test it in debug mode (remove -d once your config is working)
+
+Add nines to your crontab to keep it running through errors and server reboots. When using cron+rvm, remember to grab the GEM_HOME and GEM_PATH environment variables from your shell and make sure the rvm version of ruby is in your path.
+
+ % echo $GEM_HOME
+ /home/[username]/.rvm/gems/ruby-1.9.3-p327
+ $ echo $GEM_PATH
+ /home/[username]/.rvm/gems/ruby-1.9.3-p327:/home/[username]/.rvm/gems/ruby-1.9.3-p327@global
+ % which ruby
+ /home/[username]/.rvm/rubies/ruby-1.9.3-p327/bin/ruby
+
+Example crontab (note the two different bin dirs for rvm):
+
+ MAILTO="aaron@biggerbird.com"
+ PATH=/home/[username]/.rvm/rubies/ruby-1.9.3-p327/bin:/home/[username]/.rvm/gems/ruby-1.9.3-p327/bin:/usr/bin:/bin
+ GEM_HOME=/home/[username]/.rvm/gems/ruby-1.9.3-p327
+ GEM_PATH=/home/[username]/.rvm/gems/ruby-1.9.3-p327:/home/[username]/.rvm/gems/ruby-1.9.3-p327@global
+ 
+ */15 * * * * nines -d -f /home/[username]/nines/nines.rb
+
+This will try to (re)start nines every 15 minutes. (If it is running, the command will just exit.)
 
 =Dependencies
 
-Developed and tested with MRI ruby 1.9.3.
+Developed and tested with MRI ruby 1.9.3. Regularly used on CentOS 5, Amazon Linux and OS X 10.8, but ought to work on any POSIX-compliant OS.
 
 Dependencies:
 * trollop (commandline options)

data/bin/nines

@@ -44,10 +44,15 @@ end
 # process subcommands
 cmd = ARGV.shift
 case cmd
-when 'start'
+when 'start', nil
   cmd_opts = Trollop.options do
   end
   
+  if app.running?
+    STDERR.puts "Nines appears to be running at pid #{File.open(app.pidfile).read}, exiting."
+    exit 1
+  end
+  
   app.start(cmd_opts)
   
 when 'stop'
@@ -55,7 +60,4 @@ when 'stop'
   end
   
   app.stop(cmd_opts)
-  
-else
-  app.start
 end

data/lib/nines/app.rb

@@ -38,6 +38,32 @@ module Nines
     def debug     ; self.class.debug    ; end
     def logger    ; self.class.logger   ; end
     
+    def running?
+      pid = nil
+      
+      begin
+        pid = File.open(pidfile).read.to_i
+        return false if pid == 0
+      rescue
+        # puts "Pidfile doesn't exist"
+        return false
+      end
+      
+      begin
+        Process.kill(0, pid)
+        # puts "#{pid} is running"
+        return true
+      rescue Errno::EPERM
+        # puts "No permission to query #{pid}!"
+      rescue Errno::ESRCH
+        # puts "#{pid} is NOT running."
+      rescue
+        # puts "Unable to determine status for #{pid} : #{$!}"
+      end
+      
+      false
+    end
+    
     def logfile_writable
       begin
         File.open(logfile, 'a') { }
@@ -170,20 +196,29 @@ module Nines
       logger.puts "[#{Time.now}] - nines finished"
       logger.close
       
+      File.unlink(pidfile)
+      
       puts "Background process finished"
     end
     
     def stop(options = {})
       begin
-        pid = File.read(self.class.pidfile).to_i
+        pid = File.read(pidfile).to_i
+        if pid == 0
+          STDERR.puts "nines does not appear to be running."
+          exit 1
+        end
       rescue Errno::ENOENT => e
-        STDERR.puts "Couldn't open pid file #{self.class.pidfile}, please check your config."
+        STDERR.puts "Couldn't open pid file #{pidfile}, please check your config."
         exit 1
       end
       
       begin
         Process.kill "INT", pid
         exit 0
+      rescue Errno::EPERM => e
+        STDERR.puts "Couldn't kill process with pid #{pid}, appears to be owned by someone else."
+        exit 1
       rescue Errno::ESRCH => e
         STDERR.puts "Couldn't kill process with pid #{pid}. Are you sure it's running?"
         exit 1

data/lib/nines/version.rb

@@ -1,3 +1,3 @@
 module Nines
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/nines.rb.sample

@@ -2,8 +2,8 @@ Nines::App.config = {
   debug: false,
   verbose: false,
   
-  logfile: 'log/nines.log',
-  pidfile: 'tmp/nines.pid',
+  logfile: './nines.log',
+  pidfile: './nines.pid',
   email_from: 'Nines Notifier <no-reply@example.com>',
   email_subject_prefix: '[NINES] ',
   
@@ -53,4 +53,4 @@ Nines::App.config = {
     authentication: 'plain',
     enable_starttls_auto: true
   }
-}
+}

data/nines.yml.sample

@@ -2,8 +2,8 @@
 debug: false
 verbose: false
 
-logfile: log/nines.log
-pidfile: tmp/nines.pid
+logfile: ./nines.log
+pidfile: ./nines.pid
 email_from: 'Nines Notifier <no-reply@calchost.com>'
 email_subject_prefix: '[NINES] '
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nines
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-03 00:00:00.000000000 Z
+date: 2012-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ping