cognizant 0.0.2 → 0.0.3

data/cognizant.gemspec

@@ -4,9 +4,10 @@ require File.expand_path('../lib/cognizant/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Gurpartap Singh"]
   gem.email         = ["contact@gurpartap.com"]
-  gem.description   = "Cognizant is a process management system utility that supervises your processes, ensuring their state based on a flexible criteria."
-  gem.summary       = "Cognizant is a process management system utility that supervises your processes, ensuring their state based on a flexible criteria."
+  gem.description   = "Cognizant is a process management framework inspired from God and Bluepill. It supervises your processes, ensuring their state based on a flexible criteria."
+  gem.summary       = "Cognizant is a process management framework inspired from God and Bluepill. It supervises your processes, ensuring their state based on a flexible criteria."
   gem.homepage      = "http://github.com/Gurpartap/cognizant"
+  gem.license       = "MIT"
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")
@@ -16,15 +17,18 @@ Gem::Specification.new do |gem|
   gem.version       = Cognizant::VERSION
 
   gem.add_development_dependency "rake"
-  gem.add_development_dependency "redcarpet"
+  gem.add_development_dependency "ruby-graphviz"
   gem.add_development_dependency "yard"
+  gem.add_development_dependency "kramdown"
+  gem.add_development_dependency "aruba"
 
   # cognizantd
   gem.add_dependency "eventmachine"
   gem.add_dependency "state_machine"
   gem.add_dependency "activesupport"
+  gem.add_dependency "logging"
 
   # cognizant
-  gem.add_dependency "gli"
+  gem.add_dependency "commander"
   gem.add_dependency "formatador"
 end

data/examples/apps/redis-server.cz

@@ -0,0 +1,42 @@
+Cognizant.application("redis-example") do |app|
+  app.pids_dir = "~/.cognizant/redis-example/pids/"
+  app.logs_dir = "~/.cognizant/redis-example/logs/"
+
+  # 2 slave instances to master at port 6000.
+  3.times do |i|
+    app.monitor("redis-server-600#{i}") do |process|
+      process.autostart = true
+      # process.name = "redis-server-600#{i}" # Same thing as above.
+      process.group = "redis"
+      # process.uid = "redis"
+      # process.gid = "redis"
+      process.start_command = "redis-server -"
+      process.ping_command = "redis-cli -p 600#{i} PING"
+
+      process.daemonize!
+      slaveof = i == 0 ? "" : "slaveof 127.0.0.1 6000"
+      process.start_with_input = <<-heredoc
+        daemonize no
+        port 600#{i}
+        #{slaveof}
+      heredoc
+
+      # process.check(:always_true, :every => 2.seconds, :times => 3) do |p|
+      #   `say "Boom!"`
+      # end
+
+      process.check(:transition, :from => :running, :to => :stopped) do |p|
+        `say --rate 250 "A process has stopped!"`
+      end
+
+      # :retry_after => 0 means do not retry.
+      process.check(:flapping, :times => 5, :within => 30.seconds, :retry_after => 7.seconds)
+
+      process.check(:cpu_usage, :every => 5.seconds, :above => 60.percent, :times => [3, 5], :do => :restart)
+      process.check(:memory_usage, :every => 5.seconds, :above => 100.megabytes, :times => [3, 5]) do |p|
+        # Send email or something.
+        p.restart # Restart is the default anyways.
+      end
+    end
+  end
+end

data/examples/apps/redis-server.yml

@@ -0,0 +1,29 @@
+defaults: &defaults
+  autostart: false
+  group: redis
+  start_command: /usr/local/bin/redis-server -
+  stop_signals: [TERM, INT]
+  checks:
+    cpu_usage:
+      every: 3
+      above: 60
+      times: 3
+      do: restart
+    memory_usage:
+      every: 5 # Seconds.
+      above: 1220608 # Bytes.
+      times: [3, 5] # Three out of five times.
+      do: stop # Defaults to restart.
+
+applications:
+  example:
+    monitor:
+      redis-server-6666:
+        <<: *defaults
+        start_with_input: "daemonize no\nport 6666"
+        ping_command: redis-cli -p 6666 PING
+      redis-server-7777:
+        <<: *defaults
+        start_with_input: "daemonize no\nport 7777"
+        ping_command: redis-cli -p 7777 PING
+        stop_command: redis-cli -p 7777 SHUTDOWN

data/examples/apps/redis-server_dsl.cz

@@ -0,0 +1,54 @@
+# Cognizant.application "redis-example-dsl" do
+#   pids_dir "~/.cognizant/redis-example-dsl/pids/"
+#   logs_dir "~/.cognizant/redis-example-dsl/logs/"
+# 
+#   monitor "redis-server-7000" do
+#     autostart!
+#     group "redis"
+#     start_command "/usr/local/bin/redis-server -"
+#     start_with_input "daemonize no\nport 6666"
+#     ping_command "redis-cli -p 6666 PING"
+#   end
+# end
+
+# Not using dsl for app to use some Ruby in the immediate block.
+Cognizant.application "redis-example-dsl" do |app|
+  app.pids_dir = "~/.cognizant/redis-example-dsl/pids/"
+  app.logs_dir = "~/.cognizant/redis-example-dsl/logs/"
+
+  # 2 slave instances to master at port 7000.
+  3.times do |i|
+    slaveof = i == 0 ? "" : "slaveof 127.0.0.1 7000" # Any custom code has to be outside the monitor block.
+
+    app.monitor do
+      autostart!
+      name "redis-server-700#{i}"
+      group "redis"
+      start_command "redis-server -"
+      ping_command "redis-cli -p 700#{i} PING"
+
+      daemonize!
+      start_with_input <<-heredoc
+        daemonize no
+        port 700#{i}
+        #{slaveof}
+      heredoc
+
+      # check :always_true, :every => 2.seconds, :times => 3 do |p|
+      #   `say "Boom!"`
+      # end
+
+      check :transition, :from => :running, :to => :stopped do
+        `say --rate 250 "A process has stopped!"`
+      end
+
+      check :flapping, :times => 5, :within => 30.seconds, :retry_after => 7.seconds
+
+      check :cpu_usage, :every => 3.seconds, :above => 60.percent, :times => 3, :do => :restart
+      check :memory_usage, :every => 5.seconds, :above => 100.megabytes, :times => [3, 5] do |p|
+        # Send email or something.
+        p.restart # Restart is the default anyways.
+      end
+    end
+  end
+end

data/examples/apps/resque.cz

@@ -0,0 +1,17 @@
+Cognizant.application("my-web-app") do |app|
+  5.times do |i|
+    app.monitor "resque-worker-#{i}" do |process|
+      process.group         = "resque"
+      process.uid           = "deploy"
+      process.gid           = "deploy"
+      process.chdir         = "/apps/example/current/"
+      process.env           = { "QUEUE" => "*", "RACK_ENV" => "production" }
+      process.start_command = "bundle exec rake resque:work"
+
+      process.monitor_children do
+        check :memory_usage, :every => 5.seconds, :above => 100.megabytes, :times => [2, 3], :do => :stop
+        stop_signals ["TERM", "INT", "KILL"]
+      end
+    end
+  end
+end

data/examples/apps/thin.cz

@@ -0,0 +1,32 @@
+app_root = "/apps/acmecorp.com"
+servers = 5
+port = 4000
+
+Cognizant.application "acmecorp.com" do |app|
+  servers.times do |n|
+    app.monitor "thin-#{n}" do
+      # autostart!
+      group "thin"
+      uid "www-data"
+      gid "www-data"
+
+      env RACK_ENV: "production"
+      chdir "#{app_root}/current"
+
+      daemonize false
+      pidfile "#{app_root}/shared/tmp/pids/thin.400#{n}.pid"
+
+      start_command   "bundle exec thin start   --only #{n} --servers #{servers} --port #{port}"
+      stop_command    "bundle exec thin stop    --only #{n} --servers #{servers} --port #{port}"
+      restart_command "bundle exec thin restart --only #{n} --servers #{servers} --port #{port}"
+
+      check :flapping, times: 3, within: 1.minute, retry_after: 15.seconds, retries: 10
+      check :transition, from: :running, to: :stopped do |process|
+        `say a thin server has stopped` # send an email, etc.
+      end
+
+      check :cpu_usage,    above: 50.percent,    every: 5.seconds, times: 5,      do: :restart
+      check :memory_usage, above: 300.megabytes, every: 5.seconds, times: [3, 5], do: :restart
+    end
+  end
+end

data/examples/apps/thin.yml

@@ -0,0 +1,48 @@
+thin: &thin
+  # autostart: true
+  group: thin
+  uid: www-data
+  gid: www-data
+  env: 
+    RACK_ENV: production
+  chdir: /apps/acmecorp.com/current
+  daemonize: false
+  checks:
+    flapping:
+      times: 3
+      within: 1
+      retry_after: 15
+      retries: 10
+    # transition trigger is not useful in YAML config as blocks are not possible
+    cpu_usage:
+      above: 50
+      every: 5
+      times: 5
+      do: stop
+    memory_usage:
+      above: 314572800 # 300 megabytes in bytes
+      every: 5
+      times: [3, 5]
+      do: stop
+
+applications:
+  acmecorp.com:
+    monitor:
+      thin-0:
+        <<: *thin
+        start_command:   bundle exec thin start   --only 0 --servers 3 --port 5000
+        stop_command:    bundle exec thin stop    --only 0 --servers 3 --port 5000
+        restart_command: bundle exec thin restart --only 0 --servers 3 --port 5000
+        pidfile: /apps/acmecorp.com/shared/tmp/pids/thin.5000.pid
+      thin-1:
+        <<: *thin
+        start_command:   bundle exec thin start   --only 1 --servers 3 --port 5000
+        stop_command:    bundle exec thin stop    --only 1 --servers 3 --port 5000
+        restart_command: bundle exec thin restart --only 1 --servers 3 --port 5000
+        pidfile: /apps/acmecorp.com/shared/tmp/pids/thin.5001.pid
+      thin-2:
+        <<: *thin
+        start_command:   bundle exec thin start   --only 2 --servers 3 --port 5000
+        stop_command:    bundle exec thin stop    --only 2 --servers 3 --port 5000
+        restart_command: bundle exec thin restart --only 2 --servers 3 --port 5000
+        pidfile: /apps/acmecorp.com/shared/tmp/pids/thin.5002.pid

data/examples/cognizantd.yml

@@ -1,50 +1,21 @@
 ---
 daemonize: false
-pidfile: ~/.cognizant/cognizantd.pid
-logfile: ~/.cognizant/cognizantd.log
-socket: ~/.cognizant/cognizantd.sock
-pids_dir: ~/.cognizant/pids/
-logs_dir: ~/.cognizant/logs/
+loglevel: debug
 
-monitor: {
-  redis-server-1: {
-    autostart: false,
-    group: redis,
-    start_command: /usr/local/bin/redis-server -,
-    start_with_input: "daemonize no\nport 6666",
-    ping_command: redis-cli -p 6666 PING,
-    stop_signals: [TERM, INT],
-    checks: {
-      cpu_usage: {
-        every: 3,
-        above: 60,
-        times: 3,
-        do: restart
-      },
-      memory_usage: {
-        every: 5, # Seconds.
-        above: 1220608, # Bytes.
-        times: [3, 5], # Three out of five times.
-        do: stop # Defaults to restart.
-      }
-    }
-  },
-  redis-server-2: {
-    autostart: false,
-    group: redis,
-    start_command: /usr/local/bin/redis-server -,
-    start_with_input: "daemonize no\nport 7777",
-    ping_command: redis-cli -p 7777 PING,
-    stop_command: redis-cli -p 7777 SHUTDOWN
-  },
-  sleep: {
-    start_command: sleep 3,
-    checks: {
-      flapping: {
-        times: 4,
-        within: 15, # Seconds.
-        retry_after: 30 # Seconds.
-      }
-    }
-  }
-}
+load:
+  - ./examples/apps/*.cz
+  - ./examples/apps/*.yml
+
+applications:
+  sleep-example:
+    monitor:
+      sleep:
+        autostart: false
+        start_command: sleep 3
+        uid: nobody
+        gid: nobody
+        checks:
+          flapping:
+            times: 4
+            within: 15 # seconds.
+            retry_after: 30 # seconds.

data/features/child_process.feature

@@ -0,0 +1,62 @@
+Feature: Child Process
+
+  Forks (children) of a process can be checked for conditions and triggers
+  similar to their parent process.
+
+  Background:
+    Given a file named "fork_machine.rb" with:
+      """ruby
+      require 'timeout'
+      $0 = File.basename(__FILE__) # Useful identification when debugging.
+      children = []
+      Signal.trap('TERM') do
+        children.each do |child|
+          Process.kill('INT', child)
+        end
+      end
+      children << fork do
+        Signal.trap 'INT' do
+          exit
+        end
+        data = ''
+        Timeout::timeout(60) do
+          loop do
+            data += '*' * 100
+          end
+        end
+        data = nil
+      end
+      Process.waitall
+      """
+    Given a file named "monitor.cz" with:
+      """ruby
+      Cognizant.application 'child_process_app' do
+        pids_dir './cognizant/pids/'
+        logs_dir './cognizant/logs/'
+        monitor 'fork_machine' do
+          autostart false
+          daemonize!
+          start_command 'ruby ./fork_machine.rb'
+          stop_signals ['TERM']
+          monitor_children do
+            check :memory_usage, :every => 2.seconds, :above => 10.megabytes, :times => 3, :do => :stop
+            stop_signals ['INT']
+          end
+        end
+      end
+      """
+
+  @daemon
+  @shell
+  Scenario: Check child process memory usage
+    Given the daemon is running
+    And the shell is running
+
+    When I run "load monitor.cz" successfully in the shell
+    And I run "use child_process_app" successfully in the shell
+    Then the status of "fork_machine" should be "stopped"
+
+    When I run "start fork_machine" successfully in the shell
+    Then the status of "fork_machine" should be "running"
+
+    And the status of "fork_machine" should be "stopped"

data/features/commands.feature

@@ -0,0 +1,65 @@
+Feature: Commands
+
+  Cognizant provides a number of commands to maually change the state of a
+  process as a part of its maintenance.
+
+  Background:
+    Given a file named "sleep_process.cz" with:
+      """ruby
+      Cognizant.application 'sleep_app' do
+        pids_dir './cognizant/pids/'
+        logs_dir './cognizant/logs/'
+        monitor 'sleep_process' do
+          autostart false
+          daemonize!
+          start_command 'sleep 60'
+        end
+      end
+      """
+
+  @daemon
+  @shell
+  Scenario: Run all maintenance commands for a sample sleep process
+    Given the daemon is running
+    And the shell is running
+
+    When I run "load sleep_process.cz" successfully in the shell
+    And I run "use sleep_app" successfully in the shell
+    Then the status of "sleep_process" is "stopped"
+
+    When I run "start sleep_process" successfully in the shell
+    Then the status of "sleep_process" should be "running"
+
+    When I run "stop sleep_process" successfully in the shell
+    Then the status of "sleep_process" should be "stopped"
+
+    When I run "restart sleep_process" successfully in the shell
+    Then the status of "sleep_process" should be "running"
+
+    When I run "unmonitor sleep_process" successfully in the shell
+    Then the status of "sleep_process" should be "unmonitored"
+
+    When I run "monitor sleep_process" successfully in the shell
+    Then the status of "sleep_process" should be "running"
+
+    When I run "stop sleep_process" successfully in the shell
+    Then the status of "sleep_process" should be "stopped"
+
+  @daemon
+  @shell
+  Scenario: Run the help command
+    Given the daemon is running
+    And the shell is running
+
+    When I run "help" in the shell
+    Then I should see "You can run the following commands" in the shell
+
+  @daemon
+  @shell
+  Scenario: Shut down the daemon via command
+    Given the daemon is running
+    And the shell is running
+
+    When I run "shutdown" in the shell
+    Then I should see "The daemon has been shutdown successfuly." in the shell
+    And a process named "cognizantd" should not be running