fiveruns-dash-sensor 0.8.3 → 0.8.4

data/README.rdoc

@@ -16,23 +16,20 @@ gem install fiveruns-dash-sensor -s http://gems.github.com
 
 == Configuration
 
-When you run 'fiveruns-dash-sensor start' for the first time, it will create a blank
+When you run 'fiveruns-dash-sensor' for the first time, it will create a blank
 configuration for you in ~/.fiveruns-dash-sensor/config.rb.  You will need to edit
 this file with your app token and activate the plugins for your environment.  Once
-done, you should be able to run 'fiveruns-dash-sensor run' for a few minutes to verify 
+done, you should be able to restart 'fiveruns-dash-sensor' for a few minutes to verify 
 everything is working as designed.  If there are no problems, you can run
-'fiveruns-dash-sensor start' to spin off the daemon into the background and forget about it.
+'fiveruns-dash-sensor -d' to spin off the daemon into the background and forget about it.
 
 == Command Summary
 
-  'fiveruns-dash-sensor run' - start the daemon in the foreground, for debugging purposes.
-  'fiveruns-dash-sensor start' - start the daemon in the background, output and PID file goes
-                                 in the ~/.fiveruns-dash-sensor/log/ directory.
-  'fiveruns-dash-sensor stop' - stop the daemon in the background
+  fiveruns-dash-sensor --help
 
-You can run Sensor in verbose mode to get more debug output:
-
-  'fiveruns-dash-sensor run -- -v'
+Sensor allows you to control OS-specific parameters like log file and PID file location,
+the user and group to run as, etc.  -d will start Sensor as a daemon.  To stop it, just
+kill the associated PID.
 
 == Creating your own Plugins
 

data/bin/fiveruns-dash-sensor

@@ -1,42 +1,26 @@
 #!/usr/bin/env ruby
-require 'rubygems'
 
-unless File.exist?("#{ENV['HOME']}/.fiveruns-dash-sensor/config.rb")
-	local = File.join(File.dirname(__FILE__), "..", "config.rb")
-	dir = File.expand_path("~/.fiveruns-dash-sensor")
-	if File.exist?(local)
-		require 'fileutils'
-		FileUtils.mkdir_p dir
-		FileUtils.cp local, dir
-		puts ""
-		puts "Configuration Required"
-		puts ""
-		puts "A blank configuration file has been placed in ~/.fiveruns-dash-sensor/config.rb"
-		puts "Please edit this file to add your application token and configure the plugins"
-		puts "appropriate to this environment."
-		puts ""
-	end
-	exit
+begin
+  require 'runner'
+rescue LoadError
+  $LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+  require 'runner'
 end
 
-root = File.expand_path("~/.fiveruns-dash-sensor")
-log_dir = File.join(root, "log")
-unless File.exist? log_dir
-	require 'fileutils'
-	FileUtils.mkdir_p log_dir 
-end
-
-gem 'daemons'
-require 'daemons'
-
-options = {
-	:app_name   => "fiveruns-dash-sensor",
-	:dir_mode   => :normal,
-	:dir        => log_dir,
-	:multiple   => true,
-	:backtrace  => true,
-	:monitor    => false,
-	:log_output => true
+app_options = {
+  :config_file => File.expand_path('~/.fiveruns-dash-sensor/config.rb')
 }
 
-Daemons.run(File.join(File.dirname(__FILE__), '..', 'lib', 'daemon.rb'), options)
+app = Dash::Runner.new
+app.parse do |opts|
+  opts.on("-c CONFIG", "--config FILE", "Select config file [default: #{app_options[:config_file]}]") do |v|
+    app_options[:config_file] = v
+  end
+end
+app.start do |options|
+  require "sensor"
+
+  all_opts = app_options.merge(options)
+  engine = Dash::Sensor::Engine.new(all_opts)
+  engine.start(all_opts)
+end

data/lib/runner.rb

@@ -0,0 +1,230 @@
+require 'optparse'
+require 'fileutils'
+require 'logger'
+
+# Handles daemonizing of Ruby code
+module Dash
+  class Runner
+
+    attr_accessor :options
+    private :options, :options=
+
+    def self.shutdown
+      @@instance.shutdown
+    end
+
+    def initialize
+      @app_name = File.basename($0)
+      @@instance = self
+    end
+    
+    def parse(&block)
+      self.options = { 
+                       :log_level => Logger::INFO,
+                       :daemonize => false,
+                       :pid_file => File.join('/var', 'run', "#{@app_name}.pid"),
+                       :log_file => File.join('/var', 'log', "#{@app_name}.log"),
+                     }
+
+      OptionParser.new do |opts|
+        opts.summary_width = 25
+
+        opts.banner = "usage: #{@app_name} [options...]\n",
+                      "       #{@app_name} --help\n"
+
+        opts.separator ""; opts.separator "Process:"
+
+        opts.on("-d", "Run as a daemon.") do
+          options[:daemonize] = true
+        end
+
+        opts.on("--pid FILENAME", "save PID in FILENAME when using -d option.", "(default: #{options[:pid_file]})") do |pid_file|
+          options[:pid_file] = File.expand_path(pid_file)
+        end
+
+        opts.on("--user USER", "User to run as") do |user|
+          options[:user] = user.to_i == 0 ? Etc.getpwnam(user).uid : user.to_i
+        end
+
+        opts.on("--group GROUP", "Group to run as") do |group|
+          options[:group] = group.to_i == 0 ? Etc.getgrnam(group).gid : group.to_i
+        end
+
+        opts.separator ""; opts.separator "Logging:"
+
+        opts.on("-L", "--log [FILE]", "Path to print debugging information.") do |log_path|
+          options[:logger] = File.expand_path(log_path)
+        end
+
+        opts.on("-l", "--syslog CHANNEL", "Write logs to the syslog instead of a log file.") do |channel|
+          begin
+            require 'syslog_logger'
+          rescue LoadError => e
+            require 'rubygems'
+            require 'syslog_logger'
+          end
+          options[:syslog_channel] = channel
+        end
+
+        opts.on("-v", "Increase logging verbosity (may be used multiple times).") do
+          options[:log_level] -= 1
+        end
+
+        opts.separator ""; opts.separator "Miscellaneous:"
+
+        opts.on_tail("-?", "--help", "Display this usage information.") do
+          puts "#{opts}\n"
+          exit
+        end
+        
+        # application-specific parameters
+        yield opts if block_given?
+
+      end.parse!
+    end
+
+    def start
+      raise ArgumentError, "Please pass an application block to execute" unless block_given?
+      
+      @process = ProcessHelper.new(options)
+      pid = @process.running?
+      if pid
+        STDERR.puts "There is already a #{@app_name} process running (pid #{pid}), exiting."
+        exit(1)
+      elsif pid.nil?
+        STDERR.puts "Cleaning up stale pidfile at #{options[:pid_file]}."
+      end
+
+      drop_privileges
+
+      @process.daemonize if options[:daemonize]
+
+      setup_signal_traps
+      @process.write_pid_file if options[:daemonize]
+
+      yield options
+      # never reached
+    end
+
+    def drop_privileges
+      Process.egid = options[:group] if options[:group]
+      Process.euid = options[:user] if options[:user]
+    end
+
+    def shutdown
+      STDOUT.puts "Shutting down."
+      @process.remove_pid_file
+      exit(0)
+    end
+
+    def setup_signal_traps
+      Signal.trap("INT") { shutdown }
+      Signal.trap("TERM") { shutdown }
+    end
+  end
+
+  class ProcessHelper
+
+    def initialize(options)
+      @log_file = options[:logger]
+      @pid_file = options[:pid_file]
+      @user = options[:user]
+      @group = options[:group]
+    end
+
+    def safefork
+      begin
+        if pid = fork
+          return pid
+        end
+      rescue Errno::EWOULDBLOCK
+        sleep 5
+        retry
+      end
+    end
+
+    def daemonize
+      sess_id = detach_from_terminal
+      exit if pid = safefork
+
+      Dir.chdir("/")
+      File.umask 0000
+
+      close_io_handles
+      redirect_io
+
+      return sess_id
+    end
+
+    def detach_from_terminal
+      srand
+      safefork and exit
+
+      unless sess_id = Process.setsid
+        raise "Couldn't detach from controlling terminal."
+      end
+
+      trap 'SIGHUP', 'IGNORE'
+
+      sess_id
+    end
+
+    def close_io_handles
+      ObjectSpace.each_object(IO) do |io|
+        unless [STDIN, STDOUT, STDERR].include?(io)
+          begin
+            io.close unless io.closed?
+          rescue Exception
+          end
+        end
+      end
+    end
+
+    def redirect_io
+      begin; STDIN.reopen('/dev/null'); rescue Exception; end
+
+      if @log_file
+        begin
+          STDOUT.reopen(@log_file, "a")
+          STDOUT.sync = true
+        rescue Exception
+          begin; STDOUT.reopen('/dev/null'); rescue Exception; end
+        end
+      else
+        begin; STDOUT.reopen('/dev/null'); rescue Exception; end
+      end
+
+      begin; STDERR.reopen(STDOUT); rescue Exception; end
+      STDERR.sync = true
+    end
+
+    def write_pid_file
+      return unless @pid_file
+      FileUtils.mkdir_p(File.dirname(@pid_file))
+      File.open(@pid_file, "w") { |f| f.write(Process.pid) }
+      File.chmod(0644, @pid_file)
+    end
+
+    def remove_pid_file
+      return unless @pid_file
+      File.unlink(@pid_file) if File.exists?(@pid_file)
+    end
+
+    def running?
+      return false unless @pid_file
+
+      pid = File.read(@pid_file).chomp.to_i rescue nil
+      pid = nil if pid == 0
+      return false unless pid
+
+      begin
+        Process.kill(0, pid)
+        return pid
+      rescue Errno::ESRCH
+        return nil
+      rescue Errno::EPERM
+        return pid
+      end
+    end
+  end
+end

data/lib/sensor.rb

@@ -1,43 +1,75 @@
+require 'rubygems'
 require 'fiveruns/dash'
 require 'sensor_plugin'
 
+def logger
+  Dash::Sensor::Engine.logger
+end
+
 module Dash
   module Sensor
 
     RECIPES = []
 
     class Engine
+      
+      def initialize(options)
+        if options[:syslog_channel]
+          begin
+            require 'syslog_logger'
+            @@logger = SyslogLogger.new(options[:syslog_channel])
+          rescue LoadError
+            # SyslogLogger isn't available, so we're just going to use Logger
+          end
+        end
 
+        @@logger ||= case options[:logger]
+                     when IO, String
+                       Logger.new(options[:logger])
+                     else
+                       Logger.new(STDERR)
+                     end
+        @@logger.level = options[:log_level]
+      end
+      
+      def self.logger
+        @@logger
+      end
+      
       def self.registered(name, url, klass)
         klass.instance = klass.new
         RECIPES << [name, url, klass]
       end
 
       def start(options)
-        load_plugins(options)
+        logger.info("Starting Dash Sensor [#{$$}] at #{Time.now}")
+        logger.info("Options: #{options.inspect}")
+        logger.debug("Debugging enabled")
+
+        load_plugins_from options[:config_file]
         wait_forever
       end
 
       private
-
-      def load_plugins(options)
+      
+      def load_plugins_from(file)
         # Add the user's config directory to the load path so they can load custom plugins
         # without modifying this gem.
         $PLUGIN_PATH = [
-          File.dirname(options.config_file), 
+          File.dirname(file), 
           File.expand_path(File.join(File.dirname(__FILE__), '..', 'plugins')),
           nil
         ]
 
         setup = Setup.new
-        config = File.read(options.config_file)
-        setup.instance_eval(config, options.config_file)
+        config = File.read(file)
+        setup.instance_eval(config, file)
 
         start_dash(setup)
       end
 
       def start_dash(setup)
-        LOG.info("Configured Dash Sensor for #{setup.name} [#{setup.token}]")
+        logger.info("Configured Dash Sensor for #{setup.name} [#{setup.token}]")
         Fiveruns::Dash.configure :app => setup.token do |config|
           RECIPES.each do |(name, url, _)|
             config.add_recipe name.to_sym, url
@@ -64,13 +96,13 @@ module Dash
       end
       
       def plugin(name, options={})
-        LOG.info("Loading plugin #{name} with options #{options.inspect}")
+        logger.info("Loading plugin #{name} with options #{options.inspect}")
         
         $PLUGIN_PATH.each do |path|
           raise ArgumentError, "Unable to find #{name}.rb in plugin path: #{$PLUGIN_PATH[0..-2].inspect}" unless path
           file = File.join(path, name)
           if File.exist?("#{file}.rb")
-            LOG.debug "Loading #{file}"
+            logger.debug "Loading #{file}"
             require file
             break
           end

data/plugins/apache.rb

@@ -30,7 +30,7 @@ module Dash::Sensor::Plugins
     def self.stats
       if !@time || @time < Time.now - 55
         @old_stats = @stats || Hash.new(0)
-        LOG.debug "Fetching status at #{Time.now}"
+        logger.debug "Fetching status at #{Time.now}"
         @stats = instance.send(:stats_data)
         @time = Time.now
       end
@@ -46,11 +46,11 @@ module Dash::Sensor::Plugins
         lines = open(@url).read.split("\n")
         Hash[*lines.map {|line| line.split(':') }.flatten]
       rescue => e
-        LOG.error "Error contacting #{@url}"
-        LOG.error "#{e.class.name}: #{e.message}"
+        logger.error "Error contacting #{@url}"
+        logger.error "#{e.class.name}: #{e.message}"
         Hash.new(0)
       end
     end
 
   end
-end
+end

data/plugins/memcached.rb

@@ -23,7 +23,7 @@ module Dash::Sensor::Plugins
     
     def self.stats
       if !@time || @time < Time.now - 55
-        LOG.debug "Fetching stats at #{Time.now}"
+        logger.debug "Fetching stats at #{Time.now}"
         @stats = parse(instance.send(:stats_data))
         @time = Time.now
       end
@@ -47,8 +47,8 @@ module Dash::Sensor::Plugins
         end
         sock.close
       rescue Exception => e
-        LOG.error "Error contacting Starling at #{@host}:#{@port}"
-        LOG.error "#{e.class.name}: #{e.message}"
+        logger.error "Error contacting Starling at #{@host}:#{@port}"
+        logger.error "#{e.class.name}: #{e.message}"
       end
       data
     end
@@ -62,4 +62,4 @@ module Dash::Sensor::Plugins
     end
 
   end
-end
+end

data/plugins/nginx.rb

@@ -27,7 +27,7 @@ module Dash::Sensor::Plugins
     def self.stats
       if !@time || @time < Time.now - 55
         @old_stats = @stats || Hash.new(0)
-        LOG.debug "Fetching status at #{Time.now}"
+        logger.debug "Fetching status at #{Time.now}"
         @stats = instance.send(:stats_data)
         @time = Time.now
       end
@@ -52,11 +52,11 @@ module Dash::Sensor::Plugins
         end
         results
       rescue Exception => e
-        LOG.error "Error contacting #{@url}"
-        LOG.error "#{e.class.name}: #{e.message}"
+        logger.error "Error contacting #{@url}"
+        logger.error "#{e.class.name}: #{e.message}"
         Hash.new(0)
       end
     end
 
   end
-end
+end

data/plugins/starling.rb

@@ -22,7 +22,7 @@ module Dash::Sensor::Plugins
 
     def self.stats
       if !@time || @time < Time.now - 55
-        LOG.debug "Fetching stats at #{Time.now}"
+        logger.debug "Fetching stats at #{Time.now}"
         @stats = parse(instance.send(:stats_data))
         @time = Time.now
       end
@@ -46,8 +46,8 @@ module Dash::Sensor::Plugins
         end
         sock.close
       rescue Exception => e
-        LOG.error "Error contacting Starling at #{@host}:#{@port}"
-        LOG.error "#{e.class.name}: #{e.message}"
+        logger.error "Error contacting Starling at #{@host}:#{@port}"
+        logger.error "#{e.class.name}: #{e.message}"
       end
       data
     end
@@ -61,4 +61,4 @@ module Dash::Sensor::Plugins
     end
 
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fiveruns-dash-sensor
 version: !ruby/object:Gem::Version 
-  version: 0.8.3
+  version: 0.8.4
 platform: ruby
 authors: 
 - FiveRuns
@@ -21,11 +21,10 @@ extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
-- History.rdoc
 files: 
 - bin/fiveruns-dash-sensor
 - config.rb
-- lib/daemon.rb
+- lib/runner.rb
 - lib/sensor.rb
 - lib/sensor_plugin.rb
 - plugins/memcached.rb
@@ -33,7 +32,6 @@ files:
 - plugins/nginx.rb
 - plugins/apache.rb
 - README.rdoc
-- History.rdoc
 has_rdoc: false
 homepage: http://github.com/fiveruns/dash-sensor/
 post_install_message: 

data/History.rdoc

@@ -1,5 +0,0 @@
-= Changelog
-
-== 0.8.0 (2009-01-07)
-
-* Initial internal release.

data/lib/daemon.rb

@@ -1,46 +0,0 @@
-require 'ostruct'
-require 'optparse'
-
-# Sent by daemons when you run '<script> stop'
-Signal.trap('TERM') { puts "fiveruns-dash-sensor PID #{$$} exiting at #{Time.now}..."; exit(0) }
-# Sent by daemons when you hit Ctrl-C after '<script> run'
-Signal.trap('INT') { puts "fiveruns-dash-sensor terminated at #{Time.now}..."; exit(0) }
-
-options = OpenStruct.new
-options.environment = ENV['RAILS_ENV'] || 'production'
-options.verbose = false
-options.config_file = "#{ENV['HOME']}/.fiveruns-dash-sensor/config.rb"
-
-op = OptionParser.new do |opts|
-  opts.banner = "Usage: fiveruns-dash-sensor [options]"
-  opts.separator "General Options:"
-  opts.on("-e ENVIRONMENT", "--environment NAME", "Select environment [default: #{options.environment}]") do |v|
-    options.environment = v
-  end
-  opts.on("-c CONFIG", "--config FILE", "Select config file [default: #{options.config_file}]") do |v|
-    options.config_file = v
-  end
-  opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
-    options.verbose = v
-  end
-  opts.separator "Other Options:"
-  opts.on("-h", "--help", "Display this message") do |v|
-    STDERR.puts opts
-    exit
-  end
-end
-op.parse!(ARGV)
-
-unless File.exist? options.config_file
-  puts "Please create a configuration file for your environment in ~/.fiveruns-dash-sensor/config.rb"
-  exit(1)
-end
-
-require 'logger'
-LOG = Logger.new(STDOUT)
-LOG.level = options.verbose ? Logger::DEBUG : Logger::INFO
-
-$LOAD_PATH.unshift File.dirname(__FILE__)
-require "sensor"
-LOG.info("Starting Dash Sensor [#{$$}] at #{Time.now}")
-Dash::Sensor::Engine.new.start(options)