cognizant 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a93e2f1d168e2683901d0a11ec11f306e76e0a74
+  data.tar.gz: 969dfb60b5efe2138fc44c7a37a687aaf75e5b46
+SHA512:
+  metadata.gz: 4d7dc8a641709996e05be712f59db9fb9b3c1c56176ae5314f21a8c2adc6b9e1b1b5163ec438db285268cbea12d0c55162ef209afb037e5750a2ae32befb2382
+  data.tar.gz: a34bb4420411f4a61722ae1887dad40cf04520df5e1684b4804981d40ffeb8f84278ae358497acc78043d433a0242ec4fdfc65ac6166488c23dc20270e7858ef

data/.gitignore

@@ -17,3 +17,4 @@ test/version_tmp
 tmp
 .DS_Store
 .rbenv*
+.rbx

data/.travis.yml

@@ -0,0 +1,17 @@
+---
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - rbx-19mode
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: rbx-19mode
+branches:
+  only:
+    - master
+notifications:
+  email: false

data/Gemfile

@@ -1,4 +1,7 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in cognizant.gemspec
+group :test do
+  gem 'coveralls', require: false
+end
+
 gemspec

data/{LICENSE → License.md}

@@ -1,6 +1,8 @@
-Copyright (c) 2012 Gurpartap Singh
+**Copyright (c) 2012 Gurpartap Singh**
 
-MIT License
+**All rights reserved**
+
+**MIT License**
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,2 +1,7 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require "cucumber/rake/task"
+
+Cucumber::Rake::Task.new(:features)
+
+task :default => [:features]

data/Readme.md

@@ -0,0 +1,95 @@
+![Cognizant](http://f.cl.ly/items/442w3l1n0i3V41220g0z/cognizant.png)
+
+Simple and reliable process monitoring framework written in Ruby
+
+[![Gem Version](https://badge.fury.io/rb/cognizant.png)](http://badge.fury.io/rb/cognizant) [![Dependency Status](https://gemnasium.com/Gurpartap/cognizant.png)](https://gemnasium.com/Gurpartap/cognizant) [![Code Climate](https://codeclimate.com/github/Gurpartap/cognizant.png)](https://codeclimate.com/github/Gurpartap/cognizant) [![Build Status](https://travis-ci.org/Gurpartap/cognizant.png?branch=master)](https://travis-ci.org/Gurpartap/cognizant) [![Coverage Status](https://coveralls.io/repos/Gurpartap/cognizant/badge.png?branch=master)](https://coveralls.io/r/Gurpartap/cognizant)
+
+
+## Quick start
+
+###### Install Cognizant
+```bash
+$ gem install cognizant
+```
+
+###### Example thin server cluster configuration
+```bash
+$ vim thin_cluster.cz
+```
+
+```ruby
+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
+```
+
+**YAML** version of this example is [available in the wiki](https://github.com/Gurpartap/cognizant/wiki/Thin-Server-Cluster).
+
+###### Start the daemon and load the configuration
+```bash
+$ cognizantd
+$ cognizant load thin_cluster.cz
+```
+
+###### Enter the Cognizant shell and view the status of managed processes
+```bash
+$ cognizant
+```
+```
+Welcome Gurpartap! You are speaking to the Cognizant Monitoring Daemon.
+Enter 'help' if you're not sure what to do.
+
+Type 'quit' or 'exit' to quit at any time.
+> use acmecorp.com
+OK
+```
+
+```
+(acmecorp.com)> status
++---------+-------+------------------------+-------+-------+--------+
+| Process | Group | State                  | PID   | % CPU | Memory |
++---------+-------+------------------------+-------+-------+--------+
+| thin-0  | thin  | running since 1 minute | 59825 | 0.0   | 47 MiB |
++---------+-------+------------------------+-------+-------+--------+
+| thin-1  | thin  | running since 1 minute | 59828 | 0.0   | 47 MiB |
++---------+-------+------------------------+-------+-------+--------+
+| thin-2  | thin  | running since 1 minute | 59829 | 0.0   | 47 MiB |
++---------+-------+------------------------+-------+-------+--------+
+2013-03-18 10:00:29 +0530
+```
+
+## Further information
+Cognizant has an [**extensively documented wiki**](https://github.com/Gurpartap/cognizant/wiki) for that.
+
+## About
+
+Cognizant is a project of [Gurpartap Singh](http://gurpartap.com/). Feel free to get in touch.

data/bin/cognizant

@@ -1,149 +1,105 @@
 #!/usr/bin/env ruby
 
-require "cognizant/version"
-require "gli"
-require "formatador"
-require "socket"
-require "json"
-
-include GLI::App
-
 # Set the process name.
 $0 = File.basename(__FILE__)
 
-# Set to flush standard output/error immediately.
+# Flush standard output/error immediately.
 $stdout.sync = true
 $stderr.sync = true
 
-program_desc "administration utility for cognizantd"
-@version = Cognizant::VERSION
-
-sort_help :manually
-
-desc "The socket lock file of the daemon server"
-arg_name "FILE"
-flag :socket, :type => String, :default_value => "/var/run/cognizant/cognizantd.sock"
-
-desc "The server address of the daemon server"
-arg_name "ADDRESS"
-flag "bind-address", :type => String
-
-desc "The server port of the daemon server"
-arg_name "PORT"
-flag :port, :type => Integer
-
-desc "Username to use for authentication with server"
-arg_name "USERNAME"
-flag :username, :type => String
-
-desc "Password to use for authentication with server"
-arg_name "PASSWORD"
-flag :password, :type => String
-
-desc "Print the version number and exit"
-switch :version, :negatable => false
-
-desc "Turn on tracing, enabling full backtrace"
-switch :trace, :negatable => false
-
-desc "Display status of managed process(es) or group(s)"
-arg_name "process_name", :optional
-command :status do |c|
-  c.action do |global_options, options, args|
-    connect_and_perform(global_options, :status, args) do |output|
-      begin  
-        JSON.parse(output)
-
-        status_data = JSON.parse(output)
-        status_data.each_with_index do |process, index|
-          status_data[index]["State"]  = "[green]#{process["State"]}[/] since #{distance_of_time_in_words(Time.now.to_i - process["Since"])}"
-          status_data[index]["Memory"] = number_to_human_size(process["Memory"] * 1024) # Convert kilobytes to bytes.
-        end
+require "cognizant/version"
+require "cognizant/shell"
+require "commander/import"
+require "formatador"
+require "shellwords"
+require "socket"
 
-        formatador = Formatador.new
-        formatador.display_line
-        formatador.display_table(status_data, ["Process", "Group", "State", "PID", "% CPU", "Memory"])
-        formatador.display_line(Time.now)
-        formatador.display_line
-      rescue => e
-        Formatador.display_line("[red]#{output}[/]")
+program :version, Cognizant::VERSION
+program :description, "administration utility for cognizantd"
+
+global_option("-a", "--app NAME", String, "The name of the application container (required)")
+global_option("-s", "--sockfile FILE", String, "The socket lock file of the application server (required)")
+
+default_command :shell
+
+command :shell do |c|
+  c.syntax = "cognizant shell"
+  c.description = "Enter the Cognizant shell for easy control"
+  c.action do |args, options|
+    Cognizant::Shell.new(app: options.app, socket: options.sockfile, shell: true).run do |output, cmd|
+      if cmd == "shutdown"
+        # TODO: Use Shell#emit instead of puts.
+        puts "The daemon has been shutdown successfuly."
+        exit(0)
+      else
+        format_status_table(output)
       end
     end
   end
 end
 
-desc "Loads the process information from specified Ruby file"
-arg_name "file"
-command :load do |c|
-  c.action do |global_options, options, args|
-    connect_and_perform(global_options, :load, args)
-  end
-end
-
-desc "Monitor the specified process or group"
-arg_name "process_name"
-command :monitor do |c|
-  c.action do |global_options, options, args|
-    connect_and_perform(global_options, :monitor, args)
-  end
-end
-
-desc "Unmonitor the specified process or group"
-arg_name "process_name"
-command :unmonitor do |c|
-  c.action do |global_options, options, args|
-    connect_and_perform(global_options, :unmonitor, args)
+command :status do |c|
+  c.syntax = "cognizant status [process or group name]"
+  c.description = "Display status of managed process(es) or group(s)"
+  c.action do |args, options|
+    connect_and_perform(:status, options, args) do |output|
+      format_status_table(output)
+    end
   end
 end
 
-desc "Start the specified process or group"
-arg_name "process_name"
-command :start do |c|
-  c.action do |global_options, options, args|
-    connect_and_perform(global_options, :start, args)
-  end
+[
+  [:load,      "FILE",                    "Loads the process information from specified Ruby file"],
+  [:monitor,   "[PROCESS OR GROUP NAME]", "Monitor the specified process or group"],
+  [:unmonitor, "[PROCESS OR GROUP NAME]", "Unmonitor the specified process or group"],
+  [:start,     "[PROCESS OR GROUP NAME]", "Start the specified process or group"],
+  [:stop,      "[PROCESS OR GROUP NAME]", "Stop the specified process or group"],
+  [:restart,   "[PROCESS OR GROUP NAME]", "Restart the specified process or group"]
+].each do |command, arg_name, description|
+  eval <<-heredoc
+    command "#{command}" do |c|
+      c.syntax = "cognizant #{command} #{arg_name}"
+      c.description = "#{description}"
+      c.action do |args, options|
+        connect_and_perform(:#{command}, options, args) do |output|
+          format_status_table(output)
+        end
+      end
+    end
+  heredoc
 end
 
-desc "Stop the specified process or group"
-arg_name "process_name"
-command :stop do |c|
-  c.action do |global_options, options, args|
-    connect_and_perform(global_options, :stop, args)
+command "shutdown" do |c|
+  c.syntax = "cognizant shutdown"
+  c.description = "Stop the monitoring daemon without affecting managed processes"
+  c.action do |args, options|
+    connect_and_perform(:shutdown, options, args) do |output|
+      # 
+    end
   end
 end
 
-desc "Restart the specified process or group"
-arg_name "process_name"
-command :restart do |c|
-  c.action do |global_options, options, args|
-    connect_and_perform(global_options, :restart, args)
-  end
-end
+def format_status_table(status_data)
+  if status_data.is_a?(Array)
+    status_data.each_with_index do |process, index|
+      status_data[index]["State"]  = "[green]#{process["State"]}[/] since #{distance_of_time_in_words(Time.now.to_i - process["Since"])}"
+      status_data[index]["Memory"] = number_to_human_size(process["Memory"] * 1024) # Convert kilobytes to bytes.
+    end
 
-desc "Stop the monitoring daemon without affecting processes"
-command :shutdown do |c|
-  c.action do |global_options, options, args|
-    connect_and_perform(global_options, :shutdown, args)
+    formatador = Formatador.new
+    formatador.display_line
+    formatador.display_table(status_data, ["Process", "Group", "State", "PID", "% CPU", "Memory"])
+    formatador.display_line(Time.now)
+    formatador.display_line
+  elsif status_data.is_a?(Hash)
+    puts status_data['message']
   end
+rescue => e
+  Formatador.display_line("[red]#{status_data}[/]")
 end
 
-def connect_and_perform(global_options, task, args, &block)
-  output_handler = Proc.new do |socket|
-    socket.write("#{task.to_s} #{args.join(' ')}")
-    socket.flush
-    output = socket.gets
-    if block
-      block.call(output)
-    else
-      Formatador.display_line(output)
-    end
-  end
-
-  if global_options[:socket]
-    output_handler.call(UNIXSocket.new(global_options[:socket]))
-  else
-    output_handler.call(TCPSocket.new(global_options["bind-address"], global_options["port"]))
-  end
+def connect_and_perform(task, options, args, &block)
+  Cognizant::Shell.new(app: options.app, socket: options.sockfile, shell: false).run_command(task, args, &block)
 end
 
 def distance_of_time_in_words(seconds)
@@ -174,5 +130,3 @@ end
 def pluralize(count, singular, plural)
   "#{count || 0} " + ((count == 1 || count =~ /^1(\.0+)?$/) ? singular : plural)
 end
-
-exit run(ARGV)

data/bin/cognizantd

@@ -10,6 +10,8 @@ $stderr.sync = true
 begin
   require "optparse"
   require "cognizant/version"
+  require "cognizant/controller"
+  require "cognizant/util/transform_hash_keys"
 
   options = {}
 
@@ -31,64 +33,24 @@ GLOBAL OPTIONS:
       options[:daemonize] = value
     end
 
-    opts.on("--pidfile FILE", String, "The pid (process identifier) lock file for the daemon.") do |value|
+    opts.on("--sockfile FILE", String, "The socket lock file of the command server.") do |value|
       options[:pidfile] = value
     end
 
-    opts.on("--logfile FILE", String, "The file to log the daemon's operational information into.") do |value|
-      options[:logfile] = value
-    end
-
-    opts.on("--loglevel LEVEL", String, "The level of information to log.") do |value|
-      options[:loglevel] = value
-    end
-
-    opts.on("--env ENV", String, "Environment variables for managed processes to inherit.") do |value|
-      options[:env] = value
-    end
-
-    opts.on("--chdir DIRECTORY", String, "The current working directory for the managed processes to start with.") do |value|
-      options[:chdir] = value
-    end
-
-    opts.on("--umask UMASK", String, "Permission mode limitations for file and directory creation.") do |value|
-      options[:umask] = value
-    end
-
-    opts.on("--user USER", String, "Run the daemon and managed processes as the given user.") do |value|
-      options[:user] = value
-    end
-
-    opts.on("--group GROUP", String, "Run the daemon and managed processes as the given user group.") do |value|
-      options[:group] = value
-    end
-
-    opts.on("--pids-dir DIRECTORY", String, "Directory to store the pid files of managed processes, when required.") do |value|
-      options[:pids_dir] = value
-    end
-
-    opts.on("--logs-dir DIRECTORY", String, "Directory to store the log files of managed processes, when required.") do |value|
-      options[:logs_dir] = value
-    end
-
-    opts.on("-s FILE", "--socket FILE", String, "The socket lock file for the server") do |value|
-      options[:socket] = value
-    end
-
-    opts.on("-b ADDRESS", "--bind-address ADDRESS", String, "The interface to bind the TCP server to.") do |value|
-      options[:bind_address] = value
+    opts.on("--pidfile FILE", String, "The pid (process identifier) lock file for the daemon.") do |value|
+      options[:pidfile] = value
     end
 
-    opts.on("-p PORT", "--port PORT", Integer, "The TCP port to start the server with.") do |value|
-      options[:port] = value
+    opts.on("--syslog", String, "Log the daemon's operational information into syslog.") do |_|
+      options[:syslog] = true
     end
 
-    opts.on("--username USERNAME", String, "Username for securing server access.") do |value|
-      options[:username] = value
+    opts.on("--logfile FILE", String, "Log the daemon's operational information into a file.") do |value|
+      options[:logfile] = value
     end
 
-    opts.on("--password PASSWORD", String, "Password to accompany the username.") do |value|
-      options[:password] = value
+    opts.on("--loglevel LEVEL", String, "The level of information to log.") do |value|
+      options[:loglevel] = value
     end
 
     opts.on("-t", "--trace", "Turn on tracing, enable full backtrace.") do
@@ -102,28 +64,33 @@ GLOBAL OPTIONS:
     end
   end.parse!
 
-  if config_file = ARGV.shift
-    require "cognizant/util/symbolize_hash_keys"
+  config = {}
+  config_file = ARGV.shift
 
-    if config_file.eql?("-")
-      config = YAML.load(ARGF.read)
-    else
+  if config_file == "-"
+    config = YAML.load(ARGF.read)
+
+  elsif config_file.to_s.size > 0
+    if File.exists?(config_file)
       config = YAML.load_file(config_file)
+    elsif File.exists?(default_config_file = "/etc/cognizant/cognizantd.yml")
+      config = YAML.load_file(default_config_file)
     end
-    config = config.inject({}) { |c,(k,v)| c[k.gsub("-", "_").to_sym] = v; c }
-    config.deep_symbolize_keys!
-    options = config.merge(options)
   end
 
-  require "cognizant/server"
-  Cognizant::Server.start(options)
+  config.deep_symbolize_keys!
+  config = config.merge(options)
+  trace = config[:trace]
+
+  Cognizant::Controller.start_daemon(config)
 rescue => exception
   if exception.instance_of?(SystemExit)
     raise
   else
-    $stderr.puts "ERROR: While executing #{$0} ... (#{exception.class})"
+    $stderr.puts "ERROR  While executing #{$0} ... (#{exception.class})"
     $stderr.puts "    #{exception.message}\n\n"
-    if options[:trace]
+
+    if trace
       $stderr.puts exception.backtrace.join("\n")
       $stderr.puts "\n(See usage by running #{$0} with --help)"
     else