mcproc 2016.2.20

data/lib/god/timeline.rb

@@ -0,0 +1,25 @@
+module God
+
+  class Timeline < Array
+    # Instantiate a new Timeline
+    #   +max_size+ is the maximum size to which the timeline should grow
+    #
+    # Returns Timeline
+    def initialize(max_size)
+      super()
+      @max_size = max_size
+    end
+
+    # Push a value onto the Timeline
+    #   +val+ is the value to push
+    #
+    # Returns Timeline
+    def push(val)
+      self.concat([val])
+      shift if size > @max_size
+    end
+
+    alias_method :<<, :push
+  end
+
+end

data/lib/god/trigger.rb

@@ -0,0 +1,43 @@
+module God
+
+  class Trigger
+
+    class << self
+      attr_accessor :triggers # {task.name => condition}
+    end
+
+    # init
+    self.triggers = {}
+    @mutex = Mutex.new
+
+    def self.register(condition)
+      @mutex.synchronize do
+        self.triggers[condition.watch.name] ||= []
+        self.triggers[condition.watch.name] << condition
+      end
+    end
+
+    def self.deregister(condition)
+      @mutex.synchronize do
+        self.triggers[condition.watch.name].delete(condition)
+        self.triggers.delete(condition.watch.name) if self.triggers[condition.watch.name].empty?
+      end
+    end
+
+    def self.broadcast(task, message, payload)
+      return unless self.triggers[task.name]
+
+      @mutex.synchronize do
+        self.triggers[task.name].each do |t|
+          t.process(message, payload)
+        end
+      end
+    end
+
+    def self.reset
+      self.triggers.clear
+    end
+
+  end
+
+end

data/lib/god/watch.rb

@@ -0,0 +1,340 @@
+require 'etc'
+require 'forwardable'
+
+module God
+  # The Watch class is a specialized Task that handles standard process
+  # workflows. It has four states: init, up, start, and restart.
+  class Watch < Task
+    # The Array of Symbol valid task states.
+    VALID_STATES = [:init, :up, :start, :restart]
+
+    # The Sybmol initial state.
+    INITIAL_STATE = :init
+
+    # Public: The grace period for this process (seconds).
+    attr_accessor :grace
+
+    # Public: The start grace period (seconds).
+    attr_accessor :start_grace
+
+    # Public: The stop grace period (seconds).
+    attr_accessor :stop_grace
+
+    # Public: The restart grace period (seconds).
+    attr_accessor :restart_grace
+
+    # Public: God::Process delegators. See lib/god/process.rb for docs.
+    extend Forwardable
+    def_delegators :@process, :name, :uid, :gid, :start, :stop, :restart, :dir,
+                              :name=, :uid=, :gid=, :start=, :stop=, :restart=,
+                              :dir=, :pid_file, :pid_file=, :log, :log=,
+                              :log_cmd, :log_cmd=, :err_log, :err_log=,
+                              :err_log_cmd, :err_log_cmd=, :alive?, :pid,
+                              :unix_socket, :unix_socket=, :chroot, :chroot=,
+                              :env, :env=, :signal, :stop_timeout=,
+                              :stop_signal=, :umask, :umask=
+
+    # Initialize a new Watch instance.
+    def initialize
+      super
+
+      # This God::Process instance holds information specific to the process.
+      @process = God::Process.new
+
+      # Valid states.
+      self.valid_states = VALID_STATES
+      self.initial_state = INITIAL_STATE
+
+      # No grace period by default.
+      self.grace = self.start_grace = self.stop_grace = self.restart_grace = 0
+    end
+
+    # Is this Watch valid?
+    #
+    # Returns true if the Watch is valid, false if not.
+    def valid?
+      super && @process.valid?
+    end
+
+    ###########################################################################
+    #
+    # Behavior
+    #
+    ###########################################################################
+
+    # Public: Add a behavior to this Watch. See lib/god/behavior.rb.
+    #
+    # kind - The Symbol name of the Behavior to add.
+    #
+    # Yields the newly instantiated Behavior.
+    #
+    # Returns nothing.
+    def behavior(kind)
+      # Create the behavior.
+      begin
+        b = Behavior.generate(kind, self)
+      rescue NoSuchBehaviorError => e
+        abort e.message
+      end
+
+      # Send to block so config can set attributes.
+      yield(b) if block_given?
+
+      # Abort if the Behavior is invalid, the Behavior will have printed
+      # out its own error messages by now.
+      abort unless b.valid?
+
+      self.behaviors << b
+    end
+
+    ###########################################################################
+    #
+    # Quickstart mode
+    #
+    ###########################################################################
+
+    # Default Integer interval at which keepalive will runn poll checks.
+    DEFAULT_KEEPALIVE_INTERVAL = 5.seconds
+
+    # Default Integer or Array of Integers specification of how many times the
+    # memory condition must fail before triggering.
+    DEFAULT_KEEPALIVE_MEMORY_TIMES = [3, 5]
+
+    # Default Integer or Array of Integers specification of how many times the
+    # CPU condition must fail before triggering.
+    DEFAULT_KEEPALIVE_CPU_TIMES = [3, 5]
+
+    # Public: A set of conditions for easily getting started with simple watch
+    # scenarios. Keepalive is intended for use by beginners or on processes
+    # that do not need very sophisticated monitoring.
+    #
+    # If events are enabled, it will use the :process_exit event to determine
+    # if a process fails. Otherwise it will use the :process_running poll.
+    #
+    # options - The option Hash. Possible values are:
+    #           :interval -     The Integer number of seconds on which to poll
+    #                           for process status. Affects CPU, memory, and
+    #                           :process_running conditions (if used).
+    #                           Default: 5.seconds.
+    #           :memory_max   - The Integer memory max. A bare integer means
+    #                           kilobytes. You may use Numeric.kilobytes,
+    #                           Numeric#megabytes, and Numeric#gigabytes to
+    #                           makes things more clear.
+    #           :memory_times - If :memory_max is set, :memory_times can be
+    #                           set to either an Integer or a 2 element
+    #                           Integer Array to specify the number of times
+    #                           the memory condition must fail. Examples:
+    #                           3 (three times), [3, 5] (three out of any five
+    #                           checks). Default: [3, 5].
+    #           :cpu_max      - The Integer CPU percentage max. Range is
+    #                           0 to 100. You may use the Numberic#percent
+    #                           sugar to clarify e.g. 50.percent.
+    #           :cpu_times    - If :cpu_max is set, :cpu_times can be
+    #                           set to either an Integer or a 2 element
+    #                           Integer Array to specify the number of times
+    #                           the memory condition must fail. Examples:
+    #                           3 (three times), [3, 5] (three out of any five
+    #                           checks). Default: [3, 5].
+    def keepalive(options = {})
+      if God::EventHandler.loaded?
+        self.transition(:init, { true => :up, false => :start }) do |on|
+          on.condition(:process_running) do |c|
+            c.interval = options[:interval] || DEFAULT_KEEPALIVE_INTERVAL
+            c.running = true
+          end
+        end
+
+        self.transition([:start, :restart], :up) do |on|
+          on.condition(:process_running) do |c|
+            c.interval = options[:interval] || DEFAULT_KEEPALIVE_INTERVAL
+            c.running = true
+          end
+        end
+
+        self.transition(:up, :start) do |on|
+          on.condition(:process_exits)
+        end
+      else
+        self.start_if do |start|
+          start.condition(:process_running) do |c|
+            c.interval = options[:interval] || DEFAULT_KEEPALIVE_INTERVAL
+            c.running = false
+          end
+        end
+      end
+
+      self.restart_if do |restart|
+        if options[:memory_max]
+          restart.condition(:memory_usage) do |c|
+            c.interval = options[:interval] || DEFAULT_KEEPALIVE_INTERVAL
+            c.above = options[:memory_max]
+            c.times = options[:memory_times] || DEFAULT_KEEPALIVE_MEMORY_TIMES
+          end
+        end
+
+        if options[:cpu_max]
+          restart.condition(:cpu_usage) do |c|
+            c.interval = options[:interval] || DEFAULT_KEEPALIVE_INTERVAL
+            c.above = options[:cpu_max]
+            c.times = options[:cpu_times] || DEFAULT_KEEPALIVE_CPU_TIMES
+          end
+        end
+      end
+    end
+
+    ###########################################################################
+    #
+    # Simple mode
+    #
+    ###########################################################################
+
+    # Public: Start the process if any of the given conditions are triggered.
+    #
+    # Yields the Metric upon which conditions can be added.
+    #
+    # Returns nothing.
+    def start_if
+      self.transition(:up, :start) do |on|
+        yield(on)
+      end
+    end
+
+    # Public: Restart the process if any of the given conditions are triggered.
+    #
+    # Yields the Metric upon which conditions can be added.
+    #
+    # Returns nothing.
+    def restart_if
+      self.transition(:up, :restart) do |on|
+        yield(on)
+      end
+    end
+
+    # Public: Stop the process if any of the given conditions are triggered.
+    #
+    # Yields the Metric upon which conditions can be added.
+    #
+    # Returns nothing.
+    def stop_if
+      self.transition(:up, :stop) do |on|
+        yield(on)
+      end
+    end
+
+    ###########################################################################
+    #
+    # Lifecycle
+    #
+    ###########################################################################
+
+    # Enable monitoring. Start at the first available of the init or up states.
+    #
+    # Returns nothing.
+    def monitor
+      if !self.metrics[:init].empty?
+        self.move(:init)
+      else
+        self.move(:up)
+      end
+    end
+
+    ###########################################################################
+    #
+    # Actions
+    #
+    ###########################################################################
+
+    # Perform an action.
+    #
+    # a - The Symbol action to perform. One of :start, :restart, :stop.
+    # c - The Condition.
+    #
+    # Returns this Watch.
+    def action(a, c = nil)
+      if !self.driver.in_driver_context?
+        # Called from outside Driver. Send an async message to Driver.
+        self.driver.message(:action, [a, c])
+      else
+        # Called from within Driver.
+        case a
+        when :start
+          call_action(c, :start)
+          sleep(self.start_grace + self.grace)
+        when :restart
+          if self.restart
+            call_action(c, :restart)
+          else
+            action(:stop, c)
+            action(:start, c)
+          end
+          sleep(self.restart_grace + self.grace)
+        when :stop
+          call_action(c, :stop)
+          sleep(self.stop_grace + self.grace)
+        end
+      end
+
+      self
+    end
+
+    # Perform the specifics of the action.
+    #
+    # condition - The Condition.
+    # action    - The Symbol action.
+    #
+    # Returns nothing.
+    def call_action(condition, action)
+      # Before.
+      before_items = self.behaviors
+      before_items += [condition] if condition
+      before_items.each do |b|
+        info = b.send("before_#{action}")
+        if info
+          msg = "#{self.name} before_#{action}: #{info} (#{b.base_name})"
+          applog(self, :info, msg)
+        end
+      end
+
+      # Log.
+      if self.send(action)
+        msg = "#{self.name} #{action}: #{self.send(action).to_s}"
+        applog(self, :info, msg)
+      end
+
+      # Execute.
+      @process.call_action(action)
+
+      # After.
+      after_items = self.behaviors
+      after_items += [condition] if condition
+      after_items.each do |b|
+        info = b.send("after_#{action}")
+        if info
+          msg = "#{self.name} after_#{action}: #{info} (#{b.base_name})"
+          applog(self, :info, msg)
+        end
+      end
+    end
+
+    ###########################################################################
+    #
+    # Registration
+    #
+    ###########################################################################
+
+    # Register the Process in the global process registry.
+    #
+    # Returns nothing.
+    def register!
+      God.registry.add(@process)
+    end
+
+    # Unregister the Process in the global process registry.
+    #
+    # Returns nothing.
+    def unregister!
+      God.registry.remove(@process)
+      super
+    end
+  end
+end

data/mcproc.gemspec

@@ -0,0 +1,192 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+
+  s.name = 'mcproc'
+  s.version = '2016.2.20'
+  s.date = '2016-02-19'
+
+  s.summary = "Process monitoring framework."
+  s.description = "An easy to configure, easy to extend monitoring framework written in Ruby."
+
+  s.authors = ["Mario Scondo"]
+  s.email = 'mcproc@googlegroups.com'
+  s.homepage = 'http://www.linux-support.com/mcproc/'
+
+  s.rubyforge_project = 'mcproc'
+  s.rubygems_version = '1.3.5'
+  s.require_paths = %w[lib ext]
+
+  s.executables = ["mcproc"]
+  s.extensions = %w[ext/god/extconf.rb]
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md]
+
+  s.add_development_dependency('json', '~> 1.6')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('minitest')
+  s.add_development_dependency('rdoc', '~> 3.10')
+  s.add_development_dependency('twitter', '~> 5.0')
+  s.add_development_dependency('prowly', '~> 0.3')
+  s.add_development_dependency('xmpp4r', '~> 0.5')
+  s.add_development_dependency('dike', '~> 0.0.3')
+ # s.add_development_dependency('rcov', '~> 0.9')
+  s.add_development_dependency('daemons', '~> 1.1')
+  s.add_development_dependency('mocha', '~> 0.10')
+  s.add_development_dependency('gollum', '~> 1.3.1')
+  #the last version to support 1.8.7 is 0.99.6
+  s.add_development_dependency('mustache', ['~> 0.99.0', '< 0.99.7'])
+  s.add_development_dependency('airbrake', '~> 3.1.7')
+  s.add_development_dependency('nokogiri', '~> 1.5.0')
+  s.add_development_dependency('activesupport', [ '>= 2.3.10', '< 4.0.0' ])
+  s.add_development_dependency('statsd-ruby')
+  s.add_development_dependency('i18n', '< 0.7.0')
+  # = MANIFEST =
+  s.files = %w[
+    Announce.txt
+    Gemfile
+    History.txt
+    LICENSE
+    README.md
+    Rakefile
+    TODO.md
+    bin/mcproc
+    doc/intro.asciidoc
+    doc/mcproc.asciidoc
+    ext/god/.gitignore
+    ext/god/extconf.rb
+    ext/god/kqueue_handler.c
+    ext/god/netlink_handler.c
+    lib/god.rb
+    lib/god/behavior.rb
+    lib/god/behaviors/clean_pid_file.rb
+    lib/god/behaviors/clean_unix_socket.rb
+    lib/god/behaviors/notify_when_flapping.rb
+    lib/god/cli/command.rb
+    lib/god/cli/run.rb
+    lib/god/cli/version.rb
+    lib/god/compat19.rb
+    lib/god/condition.rb
+    lib/god/conditions/always.rb
+    lib/god/conditions/complex.rb
+    lib/god/conditions/cpu_usage.rb
+    lib/god/conditions/degrading_lambda.rb
+    lib/god/conditions/disk_usage.rb
+    lib/god/conditions/file_mtime.rb
+    lib/god/conditions/file_touched.rb
+    lib/god/conditions/flapping.rb
+    lib/god/conditions/http_response_code.rb
+    lib/god/conditions/lambda.rb
+    lib/god/conditions/memory_usage.rb
+    lib/god/conditions/process_exits.rb
+    lib/god/conditions/process_running.rb
+    lib/god/conditions/socket_responding.rb
+    lib/god/conditions/tries.rb
+    lib/god/configurable.rb
+    lib/god/contact.rb
+    lib/god/contacts/airbrake.rb
+    lib/god/contacts/campfire.rb
+    lib/god/contacts/email.rb
+    lib/god/contacts/hipchat.rb
+    lib/god/contacts/jabber.rb
+    lib/god/contacts/prowl.rb
+    lib/god/contacts/scout.rb
+    lib/god/contacts/sensu.rb
+    lib/god/contacts/slack.rb
+    lib/god/contacts/statsd.rb
+    lib/god/contacts/twitter.rb
+    lib/god/contacts/webhook.rb
+    lib/god/driver.rb
+    lib/god/errors.rb
+    lib/god/event_handler.rb
+    lib/god/event_handlers/dummy_handler.rb
+    lib/god/event_handlers/kqueue_handler.rb
+    lib/god/event_handlers/netlink_handler.rb
+    lib/god/logger.rb
+    lib/god/metric.rb
+    lib/god/process.rb
+    lib/god/registry.rb
+    lib/god/simple_logger.rb
+    lib/god/socket.rb
+    lib/god/sugar.rb
+    lib/god/sys_logger.rb
+    lib/god/system/portable_poller.rb
+    lib/god/system/process.rb
+    lib/god/system/slash_proc_poller.rb
+    lib/god/task.rb
+    lib/god/timeline.rb
+    lib/god/trigger.rb
+    lib/god/watch.rb
+    mcproc.gemspec
+    test/configs/child_events/child_events.god
+    test/configs/child_events/simple_server.rb
+    test/configs/child_polls/child_polls.god
+    test/configs/child_polls/simple_server.rb
+    test/configs/complex/complex.god
+    test/configs/complex/simple_server.rb
+    test/configs/contact/contact.god
+    test/configs/contact/simple_server.rb
+    test/configs/daemon_events/daemon_events.god
+    test/configs/daemon_events/simple_server.rb
+    test/configs/daemon_events/simple_server_stop.rb
+    test/configs/daemon_polls/daemon_polls.god
+    test/configs/daemon_polls/simple_server.rb
+    test/configs/degrading_lambda/degrading_lambda.god
+    test/configs/degrading_lambda/tcp_server.rb
+    test/configs/keepalive/keepalive.god
+    test/configs/keepalive/keepalive.rb
+    test/configs/lifecycle/lifecycle.god
+    test/configs/matias/matias.god
+    test/configs/real.rb
+    test/configs/running_load/running_load.god
+    test/configs/stop_options/simple_server.rb
+    test/configs/stop_options/stop_options.god
+    test/configs/stress/simple_server.rb
+    test/configs/stress/stress.god
+    test/configs/task/logs/.placeholder
+    test/configs/task/task.god
+    test/configs/test.rb
+    test/configs/usr1_trapper.rb
+    test/helper.rb
+    test/suite.rb
+    test/test_airbrake.rb
+    test/test_behavior.rb
+    test/test_campfire.rb
+    test/test_condition.rb
+    test/test_conditions_disk_usage.rb
+    test/test_conditions_http_response_code.rb
+    test/test_conditions_process_running.rb
+    test/test_conditions_socket_responding.rb
+    test/test_conditions_tries.rb
+    test/test_contact.rb
+    test/test_driver.rb
+    test/test_email.rb
+    test/test_event_handler.rb
+    test/test_god.rb
+    test/test_god_system.rb
+    test/test_handlers_kqueue_handler.rb
+    test/test_hipchat.rb
+    test/test_jabber.rb
+    test/test_logger.rb
+    test/test_metric.rb
+    test/test_process.rb
+    test/test_prowl.rb
+    test/test_registry.rb
+    test/test_sensu.rb
+    test/test_slack.rb
+    test/test_socket.rb
+    test/test_statsd.rb
+    test/test_sugar.rb
+    test/test_system_portable_poller.rb
+    test/test_system_process.rb
+    test/test_task.rb
+    test/test_timeline.rb
+    test/test_trigger.rb
+    test/test_watch.rb
+    test/test_webhook.rb
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end