eric-god 0.7.7

data/lib/god/logger.rb

@@ -0,0 +1,120 @@
+module God
+  
+  class Logger < SimpleLogger
+    SYSLOG_EQUIVALENTS = {:fatal => :crit,
+                          :error => :err,
+                          :warn => :debug,
+                          :info => :debug,
+                          :debug => :debug}
+    
+    attr_accessor :logs
+    
+    class << self
+      attr_accessor :syslog
+    end
+    
+    self.syslog ||= true
+    
+    # Instantiate a new Logger object
+    def initialize
+      super($stdout)
+      self.logs = {}
+      @mutex = Mutex.new
+      @capture = nil
+      @templogio = StringIO.new
+      @templog = SimpleLogger.new(@templogio)
+      @templog.level = Logger::INFO
+      load_syslog
+    end
+    
+    # If Logger.syslog is true then attempt to load the syslog bindings. If syslog
+    # cannot be loaded, then set Logger.syslog to false and continue.
+    #
+    # Returns nothing
+    def load_syslog
+      return unless Logger.syslog
+      
+      begin
+        require 'syslog'
+        
+        # Ensure that Syslog is open
+        begin
+          Syslog.open('god')
+        rescue RuntimeError
+          Syslog.reopen('god')
+        end
+      rescue Exception
+        Logger.syslog = false
+      end
+    end
+    
+    # Log a message
+    #   +watch+ is the String name of the Watch (may be nil if not Watch is applicable)
+    #   +level+ is the log level [:debug|:info|:warn|:error|:fatal]
+    #   +text+ is the String message
+    #
+    # Returns nothing
+    def log(watch, level, text)
+      # initialize watch log if necessary
+      self.logs[watch.name] ||= Timeline.new(God::LOG_BUFFER_SIZE_DEFAULT) if watch
+      
+      # push onto capture and timeline for the given watch
+      @templogio.truncate(0)
+      @templogio.rewind
+      @templog.send(level, text % [])
+      @mutex.synchronize do
+        @capture.puts(@templogio.string.dup) if @capture
+        self.logs[watch.name] << [Time.now, @templogio.string.dup] if watch
+      end
+      
+      # send to regular logger
+      self.send(level, text % [])
+      
+      # send to syslog
+      Syslog.send(SYSLOG_EQUIVALENTS[level], text) if Logger.syslog
+    end
+    
+    # Get all log output for a given Watch since a certain Time.
+    #   +watch_name+ is the String name of the Watch
+    #   +since+ is the Time since which to fetch log lines
+    #
+    # Returns String
+    def watch_log_since(watch_name, since)
+      # initialize watch log if necessary
+      self.logs[watch_name] ||= Timeline.new(God::LOG_BUFFER_SIZE_DEFAULT)
+      
+      # get and join lines since given time
+      @mutex.synchronize do
+        self.logs[watch_name].select do |x|
+          x.first > since
+        end.map do |x|
+          x[1]
+        end.join
+      end
+    end
+    
+    # private
+    
+    # Enable capturing of log
+    #
+    # Returns nothing
+    def start_capture
+      @mutex.synchronize do
+        @capture = StringIO.new
+      end
+    end
+    
+    # Disable capturing of log and return what was captured since
+    # capturing was enabled with Logger#start_capture
+    #
+    # Returns String
+    def finish_capture
+      @mutex.synchronize do
+        cap = @capture.string
+        @capture = nil
+        cap
+      end
+    end
+  end
+  
+end

data/lib/god/metric.rb

@@ -0,0 +1,59 @@
+module God
+  
+  class Metric
+    attr_accessor :watch, :destination, :conditions
+    
+    def initialize(watch, destination = nil)
+      self.watch = watch
+      self.destination = destination
+      self.conditions = []
+    end
+    
+    # Instantiate a Condition of type +kind+ and pass it into the optional
+    # block. Attributes of the condition must be set in the config file
+    def condition(kind)
+      # create the condition
+      begin
+        c = Condition.generate(kind, self.watch)
+      rescue NoSuchConditionError => e
+        abort e.message
+      end
+      
+      # send to block so config can set attributes
+      yield(c) if block_given?
+      
+      # call prepare on the condition
+      c.prepare
+      
+      # test generic and specific validity
+      unless Condition.valid?(c) && c.valid?
+        abort "Exiting on invalid condition"
+      end
+      
+      # inherit interval from watch if no poll condition specific interval was set
+      if c.kind_of?(PollCondition) && !c.interval
+        if self.watch.interval
+          c.interval = self.watch.interval
+        else
+          abort "No interval set for Condition '#{c.class.name}' in Watch '#{self.watch.name}', and no default Watch interval from which to inherit"
+        end
+      end
+      
+      # remember
+      self.conditions << c
+    end
+    
+    def enable
+      self.conditions.each do |c|
+        self.watch.attach(c)
+      end
+    end
+    
+    def disable
+      self.conditions.each do |c|
+        self.watch.detach(c)
+      end
+    end
+  end
+  
+end

data/lib/god/process.rb

@@ -0,0 +1,325 @@
+module God
+  class Process
+    WRITES_PID = [:start, :restart]
+    
+    attr_accessor :name, :uid, :gid, :log, :start, :stop, :restart, :unix_socket, :chroot, :env
+    
+    def initialize
+      self.log = '/dev/null'
+      
+      @pid_file = nil
+      @tracking_pid = true
+      @user_log = false
+      @pid = nil
+      @unix_socket = nil
+    end
+    
+    def alive?
+      if self.pid
+        System::Process.new(self.pid).exists?
+      else
+        false
+      end
+    end
+    
+    def file_writable?(file)
+      pid = fork do
+        uid_num = Etc.getpwnam(self.uid).uid if self.uid
+        gid_num = Etc.getgrnam(self.gid).gid if self.gid
+
+        ::Dir.chroot(self.chroot) if self.chroot
+        ::Process::Sys.setgid(gid_num) if self.gid
+        ::Process::Sys.setuid(uid_num) if self.uid
+
+        File.writable?(file) ? exit(0) : exit(1)
+      end
+      
+      wpid, status = ::Process.waitpid2(pid)
+      status.exitstatus == 0 ? true : false
+    end
+    
+    def valid?
+      # determine if we're tracking pid or not
+      self.pid_file
+      
+      valid = true
+      
+      # a start command must be specified
+      if self.start.nil?
+        valid = false
+        applog(self, :error, "No start command was specified")
+      end
+      
+      # self-daemonizing processes must specify a stop command
+      if !@tracking_pid && self.stop.nil?
+        valid = false
+        applog(self, :error, "No stop command was specified")
+      end
+      
+      # uid must exist if specified
+      if self.uid
+        begin
+          Etc.getpwnam(self.uid)
+        rescue ArgumentError
+          valid = false
+          applog(self, :error, "UID for '#{self.uid}' does not exist")
+        end
+      end
+      
+      # gid must exist if specified
+      if self.gid
+        begin
+          Etc.getgrnam(self.gid)
+        rescue ArgumentError
+          valid = false
+          applog(self, :error, "GID for '#{self.gid}' does not exist")
+        end
+      end
+      
+      # pid dir must exist if specified
+      if !@tracking_pid && !File.exist?(File.dirname(self.pid_file))
+        valid = false
+        applog(self, :error, "PID file directory '#{File.dirname(self.pid_file)}' does not exist")
+      end
+      
+      # pid dir must be writable if specified
+      if !@tracking_pid && File.exist?(File.dirname(self.pid_file)) && !file_writable?(File.dirname(self.pid_file))
+        valid = false
+        applog(self, :error, "PID file directory '#{File.dirname(self.pid_file)}' is not writable by #{self.uid || Etc.getlogin}")
+      end
+      
+      # log dir must exist
+      if !File.exist?(File.dirname(self.log))
+        valid = false
+        applog(self, :error, "Log directory '#{File.dirname(self.log)}' does not exist")
+      end
+      
+      # log file or dir must be writable
+      if File.exist?(self.log)
+        unless file_writable?(self.log)
+          valid = false
+          applog(self, :error, "Log file '#{self.log}' exists but is not writable by #{self.uid || Etc.getlogin}")
+        end
+      else
+        unless file_writable?(File.dirname(self.log))
+          valid = false
+          applog(self, :error, "Log directory '#{File.dirname(self.log)}' is not writable by #{self.uid || Etc.getlogin}")
+        end
+      end
+
+      # chroot directory must exist and have /dev/null in it
+      if self.chroot
+        if !File.directory?(self.chroot)
+          valid = false
+          LOG.log(self, :error, "CHROOT directory '#{self.chroot}' does not exist")
+        end
+
+        if !File.exist?(File.join(self.chroot, '/dev/null'))
+          valid = false
+          LOG.log(self, :error, "CHROOT directory '#{self.chroot}' does not contain '/dev/null'")
+        end
+      end
+      
+      valid
+    end
+    
+    # DON'T USE THIS INTERNALLY. Use the instance variable. -- Kev
+    # No really, trust me. Use the instance variable.
+    def pid_file=(value)
+      # if value is nil, do the right thing
+      if value
+        @tracking_pid = false
+      else
+        @tracking_pid = true
+      end
+      
+      @pid_file = value
+    end
+    
+    def pid_file
+      @pid_file ||= default_pid_file
+    end
+    
+    # Fetch the PID from pid_file. If the pid_file does not
+    # exist, then use the PID from the last time it was read.
+    # If it has never been read, then return nil.
+    #
+    # Returns Integer(pid) or nil
+    def pid
+      contents = File.read(self.pid_file).strip rescue ''
+      real_pid = contents =~ /^\d+$/ ? contents.to_i : nil
+      
+      if real_pid
+        @pid = real_pid
+        real_pid
+      else
+        @pid
+      end
+    end
+    
+    def start!
+      call_action(:start)
+    end
+    
+    def stop!
+      call_action(:stop)
+    end
+    
+    def restart!
+      call_action(:restart)
+    end
+    
+    def default_pid_file
+      File.join(God.pid_file_directory, "#{self.name}.pid")
+    end
+    
+    def call_action(action)
+      command = send(action)
+      
+      if action == :stop && command.nil?
+        pid = self.pid
+        name = self.name
+        command = lambda do
+          applog(self, :info, "#{self.name} stop: default lambda killer")
+          
+          ::Process.kill('TERM', pid) rescue nil
+          applog(self, :info, "#{self.name} sent SIGTERM")
+          
+          # Poll to see if it's dead
+          5.times do
+            begin
+              ::Process.kill(0, pid)
+            rescue Errno::ESRCH
+              # It died. Good.
+              applog(self, :info, "#{self.name} process stopped")
+              return
+            end
+            
+            sleep 1
+          end
+          
+          ::Process.kill('KILL', pid) rescue nil
+          applog(self, :info, "#{self.name} still alive; sent SIGKILL")
+        end
+      end
+            
+      if command.kind_of?(String)
+        pid = nil
+        
+        if @tracking_pid
+          # double fork god-daemonized processes
+          # we don't want to wait for them to finish
+          r, w = IO.pipe
+          begin
+            opid = fork do
+              STDOUT.reopen(w)
+              r.close
+              pid = self.spawn(command)
+              puts pid.to_s # send pid back to forker
+            end
+            
+            ::Process.waitpid(opid, 0)
+            w.close
+            pid = r.gets.chomp
+          ensure
+            # make sure the file descriptors get closed no matter what
+            r.close rescue nil
+            w.close rescue nil
+          end
+        else
+          # single fork self-daemonizing processes
+          # we want to wait for them to finish
+          pid = self.spawn(command)
+          status = ::Process.waitpid2(pid, 0)
+          exit_code = status[1] >> 8
+          
+          if exit_code != 0
+            applog(self, :warn, "#{self.name} #{action} command exited with non-zero code = #{exit_code}")
+          end
+          
+          ensure_stop if action == :stop
+        end
+        
+        if @tracking_pid or (@pid_file.nil? and WRITES_PID.include?(action))
+          File.open(default_pid_file, 'w') do |f|
+            f.write pid
+          end
+          
+          @tracking_pid = true
+          @pid_file = default_pid_file
+        end
+      elsif command.kind_of?(Proc)
+        # lambda command
+        command.call
+      else
+        raise NotImplementedError
+      end
+    end
+    
+    # Fork/exec the given command, returns immediately
+    #   +command+ is the String containing the shell command
+    #
+    # Returns nothing
+    def spawn(command)
+      fork do
+        uid_num = Etc.getpwnam(self.uid).uid if self.uid
+        gid_num = Etc.getgrnam(self.gid).gid if self.gid
+
+        ::Dir.chroot(self.chroot) if self.chroot
+        ::Process.setsid
+        ::Process::Sys.setgid(gid_num) if self.gid
+        ::Process::Sys.setuid(uid_num) if self.uid
+        Dir.chdir "/"
+        $0 = command
+        STDIN.reopen "/dev/null"
+        STDOUT.reopen file_in_chroot(self.log), "a"
+        STDERR.reopen STDOUT
+        
+        # close any other file descriptors
+        3.upto(256){|fd| IO::new(fd).close rescue nil}
+
+        if self.env && self.env.is_a?(Hash)
+          self.env.each do |(key, value)|
+            ENV[key] = value
+          end
+        end
+
+        exec command unless command.empty?
+      end
+    end
+    
+    # Ensure that a stop command actually stops the process. Force kill
+    # if necessary.
+    #
+    # Returns nothing
+    def ensure_stop
+      unless self.pid
+        applog(self, :warn, "#{self.name} stop called but pid is uknown")
+        return
+      end
+      
+      # Poll to see if it's dead
+      10.times do
+        begin
+          ::Process.kill(0, self.pid)
+        rescue Errno::ESRCH
+          # It died. Good.
+          return
+        end
+        
+        sleep 1
+      end
+      
+      # last resort
+      ::Process.kill('KILL', self.pid) rescue nil
+      applog(self, :warn, "#{self.name} process still running 10 seconds after stop command returned. Force killing.")
+    end
+
+    private
+    def file_in_chroot(file)
+      return file unless self.chroot
+
+      file.gsub(/^#{Regexp.escape(File.expand_path(self.chroot))}/, '')
+    end
+  end
+end

data/lib/god/registry.rb

@@ -0,0 +1,32 @@
+module God
+  def self.registry
+    @registry ||= Registry.new
+  end
+  
+  class Registry
+    def initialize
+      @storage = {}
+    end
+    
+    def add(item)
+      # raise TypeError unless item.is_a? God::Process
+      @storage[item.name] = item
+    end
+    
+    def remove(item)
+      @storage.delete(item.name)
+    end
+    
+    def size
+      @storage.size
+    end
+    
+    def [](name)
+      @storage[name]
+    end
+    
+    def reset
+      @storage.clear
+    end
+  end
+end

data/lib/god/simple_logger.rb

@@ -0,0 +1,53 @@
+module God
+  
+  class SimpleLogger
+    DEBUG = 2
+    INFO = 4
+    WARN = 8
+    ERROR = 16
+    FATAL = 32
+    
+    SEV_LABEL = {DEBUG => 'DEBUG',
+                 INFO => 'INFO',
+                 WARN => 'WARN',
+                 ERROR => 'ERROR',
+                 FATAL => 'FATAL'}
+    
+    attr_accessor :datetime_format, :level
+    
+    def initialize(io)
+      @io = io
+      @level = INFO
+      @datetime_format = "%Y-%m-%d %H:%M:%S"
+    end
+    
+    def output(level, msg)
+      return if level < self.level
+      
+      time = Time.now.strftime(self.datetime_format)
+      label = SEV_LABEL[level]
+      @io.print("#{label[0..0]} [#{time}] #{label.rjust(5)}: #{msg}\n")
+    end
+    
+    def fatal(msg)
+      self.output(FATAL, msg)
+    end
+    
+    def error(msg)
+      self.output(ERROR, msg)
+    end
+    
+    def warn(msg)
+      self.output(WARN, msg)
+    end
+    
+    def info(msg)
+      self.output(INFO, msg)
+    end
+    
+    def debug(msg)
+      self.output(DEBUG, msg)
+    end
+  end
+  
+end

data/lib/god/socket.rb

@@ -0,0 +1,96 @@
+require 'drb'
+
+module God
+
+  # The God::Server oversees the DRb server which dishes out info on this God daemon.
+  class Socket
+    attr_reader :port
+    
+    # The location of the socket for a given port
+    #   +port+ is the port number
+    #
+    # Returns String (file location)
+    def self.socket_file(port)
+      "/tmp/god.#{port}.sock"
+    end
+    
+    # The address of the socket for a given port
+    #   +port+ is the port number
+    #
+    # Returns String (drb address)
+    def self.socket(port)
+      "drbunix://#{self.socket_file(port)}"
+    end
+    
+    # The location of the socket for this Server
+    #
+    # Returns String (file location)
+    def socket_file
+      self.class.socket_file(@port)
+    end
+    
+    # The address of the socket for this Server
+    #
+    # Returns String (drb address)
+    def socket
+      self.class.socket(@port)
+    end
+    
+    # Create a new Server and star the DRb server
+    #   +port+ is the port on which to start the DRb service (default nil)
+    def initialize(port = nil)
+      @port = port
+      start
+    end
+    
+    # Returns true
+    def ping
+      true
+    end
+    
+    # Forward API calls to God
+    #
+    # Returns whatever the forwarded call returns
+    def method_missing(*args, &block)
+      God.send(*args, &block)
+    end
+    
+    # Stop the DRb server and delete the socket file
+    #
+    # Returns nothing
+    def stop
+      DRb.stop_service
+      FileUtils.rm_f(self.socket_file)
+    end
+    
+    private
+    
+    # Start the DRb server. Abort if there is already a running god instance
+    # on the socket.
+    #
+    # Returns nothing
+    def start
+      begin
+        @drb ||= DRb.start_service(self.socket, self)
+        applog(nil, :info, "Started on #{DRb.uri}")
+      rescue Errno::EADDRINUSE
+        applog(nil, :info, "Socket already in use")
+        DRb.start_service
+        server = DRbObject.new(nil, self.socket)
+        
+        begin
+          Timeout.timeout(5) do
+            server.ping
+          end
+          abort "Socket #{self.socket} already in use by another instance of god"
+        rescue StandardError, Timeout::Error
+          applog(nil, :info, "Socket is stale, reopening")
+          File.delete(self.socket_file) rescue nil
+          @drb ||= DRb.start_service(self.socket, self)
+          applog(nil, :info, "Started on #{DRb.uri}")
+        end
+      end
+    end
+  end
+
+end