reel-eye 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4e0a9547f32b0eae31d793656a43b559eaa2df7
-  data.tar.gz: a2a6fa219d1b8d4f904075013ba61466cc32a881
+  metadata.gz: a8d7151c4d07968c95923d5e03e98479d9c5e2d2
+  data.tar.gz: 107ec65c2f5698d6402335517c5959d7a7599c36
 SHA512:
-  metadata.gz: 8b252fa537587c2678c9b3f85af63bbb2796ac1bac895c6ff8a1954847612f4c2cf4968fb72664439a584bcbef6701f1a7f8ed26b4cc631c2f4b48da44ca74aa
-  data.tar.gz: 737744391f0de8816aef5728d52f05649b48bb377c8b5c89808d98b3a2dc06f52cbf3296efdd2834a508f572efc8e247de8ac639ed74adb4812d1f82b7b43610
+  metadata.gz: a76c23dca14051ce14bf3f2d20c101cfdd0a8490b0afe81e8c83f2f54fc2bd06604be27de462b07de5f6ef7bbe8ce2b54e024a1f3eeca3e5719594997c753ba8
+  data.tar.gz: 331eccf87ef153b6c0241f9b5963a597bc1f28c5584e873633c80a2721b79c29dd01cfd6097eca2f73e6121b690a023ea6b1d828242ec0f0e5178d3e0c41ba15

data/.gitignore

@@ -2,6 +2,8 @@
 *.rbc
 .bundle
 .config
+.ruby-version
+.ruby-gemset
 .yardoc
 Gemfile.lock
 InstalledFiles

data/CHANGES.md

@@ -1,3 +1,9 @@
+0.5.2
+-----
+* rename dsl :childs_update_period to :children_update_period
+* grammar fixes
+* add checker option `above`
+
 0.5.1
 -----
 * fix ordering in info (#27)

data/README.md

@@ -16,69 +16,81 @@ Recommended installation on the server (system wide):
     $ sudo ln -sf /usr/local/ruby/1.9.3/bin/eye /usr/local/bin/eye
 
 
-Config example, shows some typical processes and most of the options (see in exampes/ folder):
+###  Why?
+
+We have used god and bluepill in production and always ran into bugs (segfaults, crashes, lost processes, kill not-related processes, load problems, deploy problems, ...)
+
+We wanted something more robust and production stable.
+
+We wanted the features of bluepill and god, with a few extras like chains, nested configuring, mask matching, easy debug configs
+
+I hope we've success, we're using eye in production and are quite happy.
+
+###  Config example
 
 examples/test.eye
 ```ruby
 # load submodules, here just for example
-Eye.load("./eye/*.rb")
+Eye.load('./eye/*.rb')
 
 # Eye self-configuration section
 Eye.config do
-  logger "/tmp/eye.log"
+  logger '/tmp/eye.log'
 end
 
 # Adding application
-Eye.application "test" do
+Eye.application 'test' do
   # All options inherits down to the config leafs.
   # except `env`, which merging down
 
   working_dir File.expand_path(File.join(File.dirname(__FILE__), %w[ processes ]))
-  stdall "trash.log" # stdout,err logs for processes by default
-  env "APP_ENV" => "production" # global env for each processes
-  trigger :flapping, :times => 10, :within => 1.minute, :retry_in => 10.minutes
-  check :cpu, :below => 100, :times => 3 # global check for all processes
+  stdall 'trash.log' # stdout,err logs for processes by default
+  env 'APP_ENV' => 'production' # global env for each processes
+  trigger :flapping, times: 10, within: 1.minute, retry_in: 10.minutes
+  check :cpu, every: 10.seconds, below: 100, times: 3 # global check for all processes
 
-  group "samples" do
-    chain :grace => 5.seconds # chained start-restart with 5s interval, one by one.
+  group 'samples' do
+    chain grace: 5.seconds # chained start-restart with 5s interval, one by one.
 
     # eye daemonized process
     process :sample1 do
-      pid_file "1.pid" # pid_path will be expanded with the working_dir
-      start_command "ruby ./sample.rb"
+      pid_file '1.pid' # pid_path will be expanded with the working_dir
+      start_command 'ruby ./sample.rb'
 
       # when no stop_command or stop_signals, default stop is [:TERM, 0.5, :KILL]
       # default `restart` command is `stop; start`
 
       daemonize true
-      stdall "sample1.log"
+      stdall 'sample1.log'
 
-      check :cpu, :below => 30, :times => [3, 5]
+      # ensure the CPU is below 30% at least 3 out of the last 5 times checked
+      check :cpu, below: 30, times: [3, 5]
     end
 
     # self daemonized process
     process :sample2 do
-      pid_file "2.pid"
-      start_command "ruby ./sample.rb -d --pid 2.pid --log sample2.log"
-      stop_command "kill -9 {PID}"
+      pid_file '2.pid'
+      start_command 'ruby ./sample.rb -d --pid 2.pid --log sample2.log'
+      stop_command 'kill -9 {PID}'
 
-      check :memory, :below => 300.megabytes, :times => 3
+      # ensure the memory is below 300Mb the last 3 times checked
+      check :memory, every: 20.seconds, below: 300.megabytes, times: 3
     end
   end
 
-  # daemon with 3 childs
+  # daemon with 3 children
   process :forking do
-    pid_file "forking.pid"
-    start_command "ruby ./forking.rb start"
-    stop_command "ruby forking.rb stop"
-    stdall "forking.log"
+    pid_file 'forking.pid'
+    start_command 'ruby ./forking.rb start'
+    stop_command 'ruby forking.rb stop'
+    stdall 'forking.log'
 
     start_timeout 10.seconds
     stop_timeout 5.seconds
 
     monitor_children do
-      restart_command "kill -2 {PID}" # for this child process
-      check :memory, :below => 300.megabytes, :times => 3
+      restart_command 'kill -2 {PID}' # for this child process
+      check :memory, below: 300.megabytes, times: 3
     end
   end
 
@@ -90,18 +102,18 @@ Eye.application "test" do
     daemonize true
     stop_signals [:QUIT, 2.seconds, :KILL]
 
-    check :socket, :addr => "tcp://127.0.0.1:33221", :every => 10.seconds, :times => 2,
-                   :timeout => 1.second, :send_data => "ping", :expect_data => /pong/
+    check :socket, addr: 'tcp://127.0.0.1:33221', every: 10.seconds, times: 2,
+                   timeout: 1.second, send_data: 'ping', expect_data: /pong/
   end
 
   # thin process, self daemonized
   process :thin do
-    pid_file "thin.pid"
-    start_command "bundle exec thin start -R thin.ru -p 33233 -d -l thin.log -P thin.pid"
+    pid_file 'thin.pid'
+    start_command 'bundle exec thin start -R thin.ru -p 33233 -d -l thin.log -P thin.pid'
     stop_signals [:QUIT, 2.seconds, :TERM, 1.seconds, :KILL]
 
-    check :http, :url => "http://127.0.0.1:33233/hello", :pattern => /World/,
-                 :every => 5.seconds, :times => [2, 3], :timeout => 1.second
+    check :http, url: 'http://127.0.0.1:33233/hello', pattern: /World/,
+                 every: 5.seconds, times: [2, 3], timeout: 1.second
   end
 
 end
@@ -120,7 +132,7 @@ foreground load:
 
     $ eye l CONF -f
 
-If eye daemon already started and you call `load` command, config will be updated (into eye daemon). New objects(applications, groups, processes) will be added and monitored. Removed from config processes will be removed (and stopped if process has `stop_on_delete true`). Other objects update their configs.
+If the eye daemon has already started and you call the `load` command, the config will be updated (into eye daemon). New objects(applications, groups, processes) will be added and monitored. Processes removed from the config will be removed (and stopped if the process has `stop_on_delete true`). Other objects will update their configs.
 
 
 Process statuses:

data/examples/puma.eye

@@ -18,7 +18,7 @@ Eye.application :puma do
 
     start_command "#{BUNDLE} exec puma --port 33280 --environment #{RAILS_ENV} thin.ru"
     stop_signals [:TERM, 5.seconds, :KILL]
-    restart_command "kill -USR2 {{PID}}"
+    restart_command "kill -USR2 {PID}"
 
     restart_grace 10.seconds # just sleep this until process get up status
                              # (maybe enought to puma soft restart)

data/examples/test.eye

@@ -1,62 +1,64 @@
 # load submodules, here just for example
-Eye.load("./eye/*.rb")
+Eye.load('./eye/*.rb')
 
 # Eye self-configuration section
 Eye.config do
-  logger "/tmp/eye.log"
+  logger '/tmp/eye.log'
 end
 
 # Adding application
-Eye.application "test" do
+Eye.application 'test' do
   # All options inherits down to the config leafs.
   # except `env`, which merging down
 
   working_dir File.expand_path(File.join(File.dirname(__FILE__), %w[ processes ]))
-  stdall "trash.log" # stdout,err logs for processes by default
-  env "APP_ENV" => "production" # global env for each processes
-  trigger :flapping, :times => 10, :within => 1.minute, :retry_in => 10.minutes
-  check :cpu, :below => 100, :times => 3 # global check for all processes
+  stdall 'trash.log' # stdout,err logs for processes by default
+  env 'APP_ENV' => 'production' # global env for each processes
+  trigger :flapping, times: 10, within: 1.minute, retry_in: 10.minutes
+  check :cpu, every: 10.seconds, below: 100, times: 3 # global check for all processes
 
-  group "samples" do
-    chain :grace => 5.seconds # chained start-restart with 5s interval, one by one.
+  group 'samples' do
+    chain grace: 5.seconds # chained start-restart with 5s interval, one by one.
 
     # eye daemonized process
     process :sample1 do
-      pid_file "1.pid" # pid_path will be expanded with the working_dir
-      start_command "ruby ./sample.rb"
+      pid_file '1.pid' # pid_path will be expanded with the working_dir
+      start_command 'ruby ./sample.rb'
 
       # when no stop_command or stop_signals, default stop is [:TERM, 0.5, :KILL]
       # default `restart` command is `stop; start`
 
       daemonize true
-      stdall "sample1.log"
+      stdall 'sample1.log'
 
-      check :cpu, :below => 30, :times => [3, 5]
+      # ensure the CPU is below 30% at least 3 out of the last 5 times checked
+      check :cpu, below: 30, times: [3, 5]
     end
 
     # self daemonized process
     process :sample2 do
-      pid_file "2.pid"
-      start_command "ruby ./sample.rb -d --pid 2.pid --log sample2.log"
-      stop_command "kill -9 {PID}"
+      pid_file '2.pid'
+      start_command 'ruby ./sample.rb -d --pid 2.pid --log sample2.log'
+      stop_command 'kill -9 {PID}'
 
-      check :memory, :below => 300.megabytes, :times => 3
+      # ensure the memory is below 300Mb the last 3 times checked
+      check :memory, every: 20.seconds, below: 300.megabytes, times: 3
     end
   end
 
-  # daemon with 3 childs
+  # daemon with 3 children
   process :forking do
-    pid_file "forking.pid"
-    start_command "ruby ./forking.rb start"
-    stop_command "ruby forking.rb stop"
-    stdall "forking.log"
+    pid_file 'forking.pid'
+    start_command 'ruby ./forking.rb start'
+    stop_command 'ruby forking.rb stop'
+    stdall 'forking.log'
 
     start_timeout 10.seconds
     stop_timeout 5.seconds
 
     monitor_children do
-      restart_command "kill -2 {PID}" # for this child process
-      check :memory, :below => 300.megabytes, :times => 3
+      restart_command 'kill -2 {PID}' # for this child process
+      check :memory, below: 300.megabytes, times: 3
     end
   end
 
@@ -68,18 +70,18 @@ Eye.application "test" do
     daemonize true
     stop_signals [:QUIT, 2.seconds, :KILL]
 
-    check :socket, :addr => "tcp://127.0.0.1:33221", :every => 10.seconds, :times => 2,
-                   :timeout => 1.second, :send_data => "ping", :expect_data => /pong/
+    check :socket, addr: 'tcp://127.0.0.1:33221', every: 10.seconds, times: 2,
+                   timeout: 1.second, send_data: 'ping', expect_data: /pong/
   end
 
   # thin process, self daemonized
   process :thin do
-    pid_file "thin.pid"
-    start_command "bundle exec thin start -R thin.ru -p 33233 -d -l thin.log -P thin.pid"
+    pid_file 'thin.pid'
+    start_command 'bundle exec thin start -R thin.ru -p 33233 -d -l thin.log -P thin.pid'
     stop_signals [:QUIT, 2.seconds, :TERM, 1.seconds, :KILL]
 
-    check :http, :url => "http://127.0.0.1:33233/hello", :pattern => /World/,
-                 :every => 5.seconds, :times => [2, 3], :timeout => 1.second
+    check :http, url: 'http://127.0.0.1:33233/hello', pattern: /World/,
+                 every: 5.seconds, times: [2, 3], timeout: 1.second
   end
 
 end

data/examples/unicorn.eye

@@ -1,4 +1,4 @@
-# Example: now to run unicorn, and monitor its childs processes
+# Example: now to run unicorn, and monitor its child processes
 
 RUBY = '/usr/local/ruby/1.9.3/bin/ruby' # ruby on the server
 RAILS_ENV = 'production'

data/lib/eye.rb

@@ -1,5 +1,5 @@
 module Eye
-  VERSION   = "0.5.1"
+  VERSION   = "0.5.2"
   ABOUT     = "ReelEye v#{VERSION} (c) 2012-2014 @kostya"
   PROCLINE  = "reel-eye monitoring v#{VERSION}"
 

data/lib/eye/checker.rb

@@ -131,7 +131,7 @@ class Eye::Checker
   end
 
   def get_value
-    raise 'Realize me'
+    raise NotImplementedError
   end
 
   def human_value(value)
@@ -220,4 +220,27 @@ class Eye::Checker
       register(base)
     end
   end
+
+  class Measure < Eye::Checker
+    param :below, [Fixnum, Float]
+    param :above, [Fixnum, Float]
+
+    def good?(value)
+      return false if below && (value > below)
+      return false if above && (value < above)
+      true
+    end
+
+    def measure_str
+      if below && above
+        ">#{human_value(above)}<#{human_value(below)}"
+      elsif below
+        "<#{human_value(below)}"
+      elsif above
+        ">#{human_value(above)}"
+      else
+        '-'
+      end
+    end
+  end
 end

data/lib/eye/checker/cpu.rb

@@ -1,11 +1,9 @@
-class Eye::Checker::Cpu < Eye::Checker
+class Eye::Checker::Cpu < Eye::Checker::Measure
 
-  # checks :cpu, :every => 3.seconds, :below => 80, :times => [3,5]
-
-  param :below, [Fixnum, Float], true
+  # check :cpu, :every => 3.seconds, :below => 80, :times => [3,5]
 
   def check_name
-    @check_name ||= "cpu(#{human_value(below)})"
+    @check_name ||= "cpu(#{measure_str})"
   end
 
   def get_value
@@ -16,12 +14,4 @@ class Eye::Checker::Cpu < Eye::Checker
     "#{value}%"
   end
 
-  def good?(value)
-    if below
-      value < below
-    else
-      true
-    end
-  end
-
-end
+end

data/lib/eye/checker/cputime.rb

@@ -1,9 +1,7 @@
-class Eye::Checker::Cputime < Eye::Checker
+class Eye::Checker::Cputime < Eye::Checker::Measure
 
   # check :cputime, :every => 1.minute, :below => 120.minutes
 
-  param :below, [Fixnum, Float], true
-
   def get_value
     Eye::SystemResources.cputime(@pid).to_f
   end
@@ -12,12 +10,4 @@ class Eye::Checker::Cputime < Eye::Checker
     "#{value / 60}m"
   end
 
-  def good?(value)
-    if below
-      value < below
-    else
-      true
-    end
-  end
-
-end
+end

data/lib/eye/checker/file_ctime.rb

@@ -1,8 +1,7 @@
 class Eye::Checker::FileCTime < Eye::Checker
 
   # Check that file changes (log for example)
-
-  # checks :ctime, :every => 5.seconds, :file => "/tmp/1.log", :times => [3,5]
+  # check :ctime, :every => 5.seconds, :file => "/tmp/1.log", :times => [3,5]
 
   param :file, [String], true
 
@@ -22,4 +21,4 @@ class Eye::Checker::FileCTime < Eye::Checker
     value.to_i > previous_value.to_i
   end
 
-end
+end

data/lib/eye/checker/file_size.rb

@@ -1,13 +1,14 @@
-class Eye::Checker::FileSize < Eye::Checker
+class Eye::Checker::FileSize < Eye::Checker::Measure
 
   # Check that file size changed (log for example)
-
-  # checks :fsize, :every => 5.seconds, :file => "/tmp/1.log", :times => [3,5],
+  # check :fsize, :every => 5.seconds, :file => "/tmp/1.log", :times => [3,5],
   #      :below => 30.kilobytes, :above => 10.kilobytes
 
   param :file, [String], true
-  param :below, [Fixnum, Float]
-  param :above, [Fixnum, Float]
+
+  def check_name
+    @check_name ||= "fsize(#{measure_str})"
+  end
 
   def get_value
     File.size(file) rescue nil
@@ -24,11 +25,10 @@ class Eye::Checker::FileSize < Eye::Checker
 
     return true if diff < 0 # case when logger nulled
 
-    return false if below && diff > below
-    return false if above && diff < above
+    return false unless super(diff)
     return false if diff == 0
 
     true
   end
 
-end
+end