qnotifier 0.7.5 → 0.7.6

data.tar.gz.sig

@@ -1,2 +1,3 @@
-=H0${�]��@����L��-o�UIB�Ku��`_�0�K���u\�*���O'Q[��fD~�<lj���%
�?���A��~�6.!��i����Z��kWf�j��-��"�l��ߍQ��V�=j+P�L��G����~�@���������?\(J�?��K���N�:��$�h���N�Ơt�#�*�ۙ����V�|$f�t)�C������'�E�ے��g�7Ƙ%ZR�?д>{�W4�Y���
-��
+�����
+kk�߳%E�x:S�N��^/d|��8>0��_��ɛds�I�6��
<' ��q�V.��/-T�j|��Y��Mq�)ӚԱ���o�v6�SD�Zs���B�
+��L��8|�6y9�S��'�

data/Manifest

@@ -10,7 +10,6 @@ lib/qnotifier_runner.rb
 lib/storage.rb
 lib/web_service.rb
 plugins/apache.rb
-plugins/iostat.rb
 plugins/mysql.rb
 plugins/network.rb
 plugins/nginx.rb

data/bin/qnotifier

@@ -33,6 +33,11 @@ module Qnotifier
             `rm /var/lib/qnotifier/saved_variables.yml`
           end
           
+        elsif argv.first == 'alert'
+          require "qnotifier"
+          qnotifier = Qnotifier::MainProcess.new
+          qnotifier.alert(argv[1], argv[2], 3)
+                      
         elsif argv.first == 'register'  
           require "qnotifier"
           qnotifier = Qnotifier::MainProcess.new

data/config/README

@@ -1 +1,54 @@
-Plugin Development
+Plugin Development
+
+QNotifier supports user defined plugins to extend its capability.  With this ability you can monitor and alert on pretty much anything on your system.
+
+Location
+- User generated plugins should be placed in /var/lib/qnotifier/plugins
+
+Plugin Structure
+- A plugin must subclass Qnotifier::Plugin and contain a main method and an initializer. 
+
+Here's a basic plugin that counts the number of processes on the system:
+
+module Qnotifier
+  class Iostat < Qnotifier::Plugin
+    def main
+      processes = `ps -ef`
+      if processes
+        process_count = processes.split("/n").count
+        stat("Count", process_count)
+        report("Count", process_count)
+        if process_count > 100
+          alert("Count", "There are more than 100 processes running")
+        else
+          reset_alert("Count", "There are now under 100 processes running")
+        end
+      else
+        Qnotifier.log.error "Couldn't get output from the ps command"
+      end
+    end
+  end
+end
+
+Methods:
+
+stat(key, value)
+Will update the stat for key with value on the server.  Value is a text field that will appear next to the property in the stats portion of the client. 
+
+report(key, value)
+Will create a datapoint for graphs for the associated key.  Value is a float or integer. 
+
+alert(key, message)
+Sends a push notification for the specified key with the message string.
+
+reset_alert(key, message)
+Resets an alert, key must match the alert that it is associated with.  
+
+put(key, value)
+Puts a value string in the saved variables to be retrieved on a subsequent run by get.
+
+get(key)
+Retrieves a stored value by key.
+
+
+Submit your plugin to support@qnotifier.com if you feel like sharing it with others!

data/config/qnotifier_config.yml

@@ -30,12 +30,10 @@ System:
     use_load: five_minute     
     # normalize_load: whether to divide the reported load by the number of CPUs in the system          
     normalize_load: false
-    # Alert if the CPU is above this percent usage, 0 disables                
-    alert_cpu_threshold: 95
     # Alert if the memory is above this percent usage, 0 disables             
     alert_memory_threshold: 90
     # Alert if the load is above this percent usage, 0 disables          
-    alert_load_threshold: 1.0
+    alert_load_threshold: 1.5
     # Alert if the disk is above this percent usage, 0 disables
     alert_disk_threshold: 90
     # Partitions which to monitor for free disk space
@@ -43,20 +41,12 @@ System:
         - "/"
     
 # The Apache built-in plugin
-# Not currently supported
+# You must enable mod_status at this URL
 Apache:
     # Enabled, set to either true or false
     enabled: false
-    monitor_url: "http://localhost/foo"
-    username: "username"
-    password: "password"
-    
-# The IOStat built-in plugin
-# Not currently supported
-Iostat:
-    # Enabled, set to either true or false
-    enabled: false
-    
+    url: "http://username:password@127.0.0.1/nginx_status"
+        
 # The MySQL built-in plugin
 Mysql:
     # Enabled, set to either true or false
@@ -71,7 +61,8 @@ Mysql:
     #port: 3306 
 
 # The URL Monitor built-in plugin, will watch a URL for non-200 HTTP responses
-Url:
+# Please be aware to make sure this isn't a redirect (301, 302)
+Urls:
     enabled: false
     url: "http://localhost"
 
@@ -84,6 +75,7 @@ Network:
         - eth0
 
 # The Nginx built-in plugin
+# You must compile nginx with --with-http_stub_status_module and point this url to the stub_status location
 Nginx:
     # Enabled, set to either true or false
     enabled: false

data/lib/plugin.rb

@@ -6,6 +6,7 @@ require "storage"
 module Qnotifier
   class Plugin
       
+    attr_accessor :defaults
     attr_accessor :reports
     attr_accessor :alerts
     attr_accessor :stats    

data/lib/qnotifier.rb

@@ -45,7 +45,7 @@ module Qnotifier
     end
     
     def run      
-      Qnotifier.log.info "QNotifier Running"
+      Qnotifier.log.debug "QNotifier Running"
       
       runlock_file = "/var/lib/qnotifier/.runlock"
       if File.exists?(runlock_file)
@@ -160,6 +160,16 @@ module Qnotifier
       Qnotifier::Storage.wipe
     end
     
+    def alert(key, message, priority)
+      start_logging
+      load_config
+      
+      alerts = {"User" => [[key, message, priority]]}
+      webservice = Qnotifier::WebService.new
+      webservice.config = @config
+      webservice.send_alerts(alerts)
+    end
+        
     def save_api_key(api_key)
       return unless api_key
       @config["api_key"] = api_key

data/lib/web_service.rb

@@ -79,7 +79,6 @@ module Qnotifier
         return
       end
       if last_run and (Time.now - last_run) <= @@poll_interval
-        Qnotifier.log.info "Not reporting to the service yet, waiting until #{last_run + @@poll_interval}"
         return
       end
       Qnotifier::Storage.put("last_run", Time.now)

data/plugins/apache.rb

@@ -8,7 +8,26 @@ module Qnotifier
     end
     
     def main
-      Qnotifier.log.error "Apache stats plugin not yet supported in this beta version"
+      
+      return if @options["url"].empty?
+      
+      connections, requests, cpu = nil
+      
+      begin
+        open( @options["url"]) {|f|
+      	  f.each_line do |line|
+      	    connections = $1 if line.strip =~ /^(\d+)\srequests\scurrently\sbeing\sprocessed/
+      	    cpu = line if line.strip =~/CPU\sUsage/
+      	    requests = line if line =~/requests\/sec/
+      	  end
+      	}
+    	
+    	  report("Connections", connections)
+        stat("Activity", "#{cpu} #{requests}")
+              
+      rescue Exception => e
+        Qnotifier.log.error "Can not check Apache Status #{e}"
+      end
     end
   end
 end

data/plugins/system.rb

@@ -67,7 +67,7 @@ module Qnotifier
               items = line.split
 
               disk = "Used: #{items[-2]} (#{items[-4]}), #{items[-3]} free"
-              stat("Disk #{partition}", disk) if partition == "/"
+              stat("Disk #{partition}", disk)
               report("Disk #{partition} %", items[-2].delete("%").to_i)
               
               if @options["alert_disk_threshold"] != 0 and items[-2].delete("%").to_i >= @options["alert_disk_threshold"]
@@ -86,52 +86,48 @@ module Qnotifier
       if RUBY_PLATFORM =~ /linux/
         
         # Need to rewrite this, vmstat is only giving stats since system boot, not instant stats
-        vmstat = nil #`vmstat | tail -1`
-        if vmstat 
-          vmstat = vmstat.split
-          if vmstat.size >= 16
-
-            cpu = "User: #{vmstat[12].to_i}%, System: #{vmstat[13].to_i}%, Idle: #{vmstat[14].to_i}%, Wait: #{vmstat[15].to_i}%"
-            cpu_percent = (100 - vmstat[14].to_i)
-
-            stat("CPU", cpu)
-            report("CPU %", cpu_percent)
-
-            if @options["alert_cpu_threshold"] != 0 and cpu_percent >= @options["alert_cpu_threshold"]
-              alert("cpu", "CPU is at #{cpu_percent}%")
-            else
-              reset_alert("cpu", "CPU is now #{cpu_percent}%")
-            end
-
-          else
-            Qnotifier.log.error "Can't parse vmstat, is it installed?"
-          end
-        else
-          Qnotifier.log.error "Can't parse vmstat, is it installed?"
-        end
-        
-      elsif RUBY_PLATFORM =~ /darwin/
-        iostat = `iostat | tail -1`
-        if iostat
-          iostat = iostat.split
-          if iostat.size >= 9
-            cpu = "User: #{iostat[3].to_i}%, System: #{iostat[4].to_i}%, Idle: #{iostat[5].to_i}%"
-            cpu_percent = (100 - iostat[5].to_i)
-        
-            stat("CPU", cpu)
-            report("CPU %", cpu_percent)
-            
-            if @options["alert_cpu_threshold"] != 0 and cpu_percent >= @options["alert_cpu_threshold"]
-              alert("cpu", "CPU is at #{cpu_percent}%")
-            else
-              reset_alert("cpu", "CPU is now #{cpu_percent}%")
+        proc_stat = `cat /proc/stat`
+        if proc_stat 
+          for line in proc_stat.split("\n")
+            item = line.split
+            if item[0] == "cpu"
+              user = item[1].to_i + item[2].to_i
+              system = item[3].to_i
+              idle = item[4].to_i
+              iowait = item[5].to_i + item[6].to_i + item[7].to_i
+              
+              last_user = get("cpu_user") ? get("cpu_user") : 0
+              last_system = get("cpu_system") ? get("cpu_system") : 0
+              last_idle = get("cpu_idle") ? get("cpu_idle") : 0
+              last_iowait = get("cpu_iowait") ? get("cpu_iowait") : 0
+              
+              user_diff = user - last_user
+              system_diff = system - last_system
+              idle_diff = idle - last_idle
+              iowait_diff = iowait - last_iowait
+              
+              div = user_diff + system_diff + idle_diff + iowait_diff
+              half_div = div / 2
+              
+              user_pc = (100 * user_diff + half_div) / div
+              system_pc = (100 * system_diff + half_div) / div
+              idle_pc = (100 * idle_diff + half_div) / div
+              iowait_pc = (100 * iowait_diff + half_div) / div
+              cpu_pc = 100 - idle_pc
+                            
+              put("cpu_user", user)
+              put("cpu_system", system)
+              put("cpu_idle", idle)
+              put("cpu_iowait", iowait)
+              
+              stat("CPU", "#{user_pc}% user, #{system_pc}% system, #{iowait_pc}% iowait, #{idle_pc}% idle")
+              report("CPU %", cpu_pc)
+              
+              break
             end
-            
-          else
-            Qnotifier.log.error "Can't parse iostat"
           end
         else
-          Qnotifier.log.error "Can't parse iostat"
+          Qnotifier.log.error "Can't parse /proc/stat"
         end
       else
         Qnotifier.log.error "Can't parse CPU for this platform - #{RUBY_PLATFORM}"
@@ -169,8 +165,6 @@ module Qnotifier
           Qnotifier.log.error "Can't get memory information from /proc/meminfo (is it supported by this OS?)"
         end
         
-      elsif RUBY_PLATFORM =~ /darwin/
-        # Not supported on OSX currently
       else
         Qnotifier.log.error "Can't parse Memory for this platform - #{RUBY_PLATFORM}"
       end

data/plugins/urls.rb

@@ -28,6 +28,9 @@ module Qnotifier
       
       start_time = Time.now.usec
       
+      code = 0
+      failure_message = ""
+      
       begin
         http = Net::HTTP.new(uri.host,uri.port)
         http.use_ssl = url =~ %r{\Ahttps://}
@@ -38,23 +41,25 @@ module Qnotifier
                 req.basic_auth uri.user, uri.password
               end
               response = http.request(req)
+              code = response.code.to_i
         }
       rescue Exception => e
-        puts "Exception #{e}"
-        stat("Code", 0)
-        alert("response", "HTTP connection error: #{e.message} #{url}")
-        return
+        Qnotifier.log.error "Exception #{e}"
+        failure_message = e
+        code = 0
       end
       
-      response_time = (Time.now.usec - start_time) / 1000 
-      report("Latency msec", response_time)
-        
-      if response.code == 200
+      if code == 200
         stat("Code", 200)
         reset_alert("response", "HTTP OK #{url}")
+        response_time = (Time.now.usec - start_time) / 1000 
+        report("Latency msec", response_time)
+      elsif code == 0
+        stat("Code", code)
+        alert("response", "HTTP Connection Failed #{url} #{failure_message}")
       else
-        stat("Code", response.code)
-        alert("response", "HTTP #{response.code} #{url}")
+        stat("Code", code)
+        alert("response", "HTTP #{code} #{url}")
       end
     end
   end

data/qnotifier.gemspec

@@ -2,17 +2,17 @@
 
 Gem::Specification.new do |s|
   s.name = %q{qnotifier}
-  s.version = "0.7.5"
+  s.version = "0.7.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Gersham Meharg"]
-  s.date = %q{2010-06-30}
+  s.date = %q{2010-07-06}
   s.default_executable = %q{qnotifier}
   s.description = %q{The server side agent for the QNotifier monitoring system.  This software will monitor local Linux system parameters and upload them to the QNotifier servers where users can use iPhone/iPad applications to view those stats and recieve alerts.}
   s.email = %q{gersham@qnotifier.com}
   s.executables = ["qnotifier"]
   s.extra_rdoc_files = ["bin/qnotifier", "lib/plugin.rb", "lib/qnotifier.rb", "lib/storage.rb", "lib/web_service.rb"]
-  s.files = ["Manifest", "Rakefile", "bin/qnotifier", "config/README", "config/qnotifier_config.yml", "gem-public_cert.pem", "lib/plugin.rb", "lib/qnotifier.rb", "lib/storage.rb", "lib/web_service.rb", "plugins/apache.rb", "plugins/iostat.rb", "plugins/mysql.rb", "plugins/network.rb", "plugins/nginx.rb", "plugins/passenger.rb", "plugins/rails.rb", "plugins/ruby.rb", "plugins/system.rb", "plugins/urls.rb", "init.d/qnotifier", "qnotifier.gemspec"]
+  s.files = ["Manifest", "Rakefile", "bin/qnotifier", "config/README", "config/qnotifier_config.yml", "gem-public_cert.pem", "lib/plugin.rb", "lib/qnotifier.rb", "lib/storage.rb", "lib/web_service.rb", "plugins/apache.rb", "plugins/mysql.rb", "plugins/network.rb", "plugins/nginx.rb", "plugins/passenger.rb", "plugins/rails.rb", "plugins/ruby.rb", "plugins/system.rb", "plugins/urls.rb", "init.d/qnotifier", "qnotifier.gemspec"]
   s.homepage = %q{http://qnotifier.com/qnotifier_gem}
   s.post_install_message = %q{Qnotifier installed,  please register by running 'qnotifier' in order to register this server.}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Qnotifier"]

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 7
-  - 5
-  version: 0.7.5
+  - 6
+  version: 0.7.6
 platform: ruby
 authors: 
 - Gersham Meharg
@@ -35,7 +35,7 @@ cert_chain:
   wu7A8rLN6CU0SfWf
   -----END CERTIFICATE-----
 
-date: 2010-06-30 00:00:00 -07:00
+date: 2010-07-06 00:00:00 -07:00
 default_executable: qnotifier
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -182,7 +182,6 @@ files:
 - lib/storage.rb
 - lib/web_service.rb
 - plugins/apache.rb
-- plugins/iostat.rb
 - plugins/mysql.rb
 - plugins/network.rb
 - plugins/nginx.rb

data/plugins/iostat.rb

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-module Qnotifier
-  class Iostat < Qnotifier::Plugin
-
-    def initialize
-      @defaults = {
-      }
-    end
-    
-    def main
-      Qnotifier.log.error "IOStats plugin not yet supported in this beta version"
-    end
-  end
-end