bloopletech-webstats 0.3.0 → 0.5.0

data/README

@@ -37,12 +37,16 @@ If all you want to do is be able to view the performance statistics for your ser
 
 Right now there's only one client application available, which is a Growl notifier. The Growl notifier only works on OS X, with RubyCocoa installed. This application runs in the background and monitors the server; if the server goes under high CPU load for more than a few seconds, or if the server is nearly out of memory, you'll get a Growl notification saying what the problem is. This way, you can just set and forget, knowing that Webstats will report any problems.
 
-To run the Growl notifier, open a terminal on your computer, then run (the first line is only needed the first time you run the notifier):
-~$ git clone git://github.com/bloopletech/webstats.git
+To run the Growl notifier, first install Webstats on your local machine, using the installation instructions below (Skip the step that starts the server application). Then, if you installed webstats locally via rubygems, run:
+~$ webstats_growl_notifier
+
+Otherwise, if you installed webstats manually, run:
 ~$ cd webstats/clients/growl_notifier
-~/webstats/clients/growl_notifier$ ruby growl_notifier.rb http://<server's hostname>:9970/
+~/webstats/clients/growl_notifier$ ruby growl_notifier.rb
 
-Where server's hostname is the host name of the server you want to monitor (e.g. bloople.net). The Growl notifier will then run in the background.
+The first time you run the growl notifier, it will create a configuration file at ~/.webstats_clients; you must edit this file to set the URL's for the growl notifier to monitor. The URL's should the the hostnames of the servers you want to monitor, along with the correct port number (e.g. http://bloople.net:9970/).
+
+Once you've edited the configuration file to add your URL's, run the notifier again; the Growl notifier will then run in the background and notify you od any warnings or danger situations on the server.
 
 Installation
 ------------
@@ -55,8 +59,6 @@ To run the server application, run:
 
 The server application will start in the background.
 
-Coming soon: growl notifier client via rubygems.
-
 If you don't want to use rubygems, then follow the below instructions:
 To install the server app, ssh into the computer you want to monitor. then run:
 ~$ git clone git://github.com/bloopletech/webstats.git

data/Rakefile

@@ -9,9 +9,9 @@ begin
       s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
       s.authors = ["Brenton Fletcher"]
       s.date = Date.today.strftime("%Y-%m-%d")
-      s.description = s.summary = %q{Display server CPU/Memory/Disk Usage on a web page, suitable for remote performance monitoring.}
+      s.description = s.summary = %q{Monitor server CPU/Memory/Disk Usage/URL Loading, so that you can view those statistics on a web page, as well as providing an interface to client prorams to read those statistics.}
       s.email = %q{i@bloople.net}
-      s.files = Dir['**/*'].reject { |fn| fn =~ /(\.o|\.so|Makefile|\.gem)$/ }
+      s.files = Dir['**/*'].reject { |fn| fn =~ /(\.o|\.so|\.bundle|Makefile|\.gem)$/ }
       s.executables = ['webstats', 'webstats_growl_notifier']
       s.extensions = ["server/data_providers/extconf.rb"]
       s.has_rdoc = false

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
-:minor: 3
-:patch: 0
+:minor: 5
+:patch: 1

data/clients/common.rb

@@ -0,0 +1,26 @@
+class Hash
+  alias_method :undecorated_get, :[]
+  def [](key)
+    undecorated_get(key) or undecorated_get(key.is_a?(String) ? key.to_sym : key.to_s)
+  end
+end
+
+def load_settings(defaults_key, defaults)
+  config_file_path = File.expand_path("~/.webstats_clients")
+
+  $settings = {}
+
+  if File.exists?(config_file_path)
+    $settings = YAML.load(IO.read(config_file_path))
+  else
+    $settings[defaults_key] = defaults
+
+    File.open(config_file_path, "w") do |f|
+      YAML.dump($settings, f)
+    end
+
+    puts "Please edit ~/.webstats_clients and add some URLs to monitor"
+    exit
+  end
+end
+  

data/clients/growl_notifier/growl_notifier.rb

@@ -1,43 +1,60 @@
-exit if fork
+if $DEBUG
+  Thread.abort_on_exception
+else
+  exit if fork
+  $stdout = File.new('/dev/null', 'w')
+  $stderr = File.new('/dev/null', 'w')
+end
 
 require 'rubygems'
 require 'json'
 require 'net/http'
 require 'uri'
-require 'Growl'
+require File.dirname(__FILE__) + '/Growl.rb'
 
-url = ARGV[0]
+require File.dirname(__FILE__) + '/../common'
+load_settings('growl_notifier', { 'urls' => [{ 'url' => '', 'password' => nil }] })
 
-g = GrowlNotifier.new("Webstats for #{url}",['Webstats Notification'], nil, OSX::NSWorkspace.sharedWorkspace().iconForFileType_('unknown'))
+def make_request(url, password)
+  req = Net::HTTP::Get.new(url.request_uri)
+  req.basic_auth 'webstats', password unless password.nil?
+  JSON.parse(Net::HTTP.new(url.host, url.port).start { |http| http.request(req).body })
+end
+
+urls = $settings[:growl_notifier][:urls]
+
+g = GrowlNotifier.new("Webstats", ['Webstats Notification'], nil, OSX::NSWorkspace.sharedWorkspace().iconForFileType_('unknown'))
 g.register
 
-meta_info = JSON.parse(Net::HTTP.get(URI.join(url, "information")))
-last_warnings_text = last_danger_text = nil
-last_time = 0
+urls.each do |url|
+  url.merge!({ :meta_info => make_request(URI.join(url[:url], "information"), url[:password]), :last_warnings_text => nil, :last_danger_text => nil, :last_time => 0 })
+end
 
 while(true)
-  data = JSON.parse(Net::HTTP.get(URI.join(url, "update")))
+  urls.each do |url|
+    data = make_request(URI.join(url[:url], "update"), url[:password])
 
-  bad = data.sort { |a, b| b[1]['importance'].to_f <=> a[1]['importance'].to_f }.select { |(k, v)| !v['status'].nil? && v['status'] != '' }
+    bad = data.sort { |a, b| b[1]['importance'].to_f <=> a[1]['importance'].to_f }.select { |(k, v)| !v['status'].nil? && v['status'] != '' }
 
-  has_warnings = bad.detect { |(k, v)| v['status'] == 'warning' }
-  has_dangers = bad.detect { |(k, v)| v['status'] == 'danger' }
+    has_warnings = bad.detect { |(k, v)| v['status'] == 'warning' }
+    has_dangers = bad.detect { |(k, v)| v['status'] == 'danger' }
   
-  title = []
-  title << "Danger" if has_dangers
-  title << "Warnings" if has_warnings
-  title = title.join(" & ") + " for host #{URI.parse(url).host}"
+    title = []
+    title << "Danger" if has_dangers
+    title << "Warnings" if has_warnings
+    title = title.join(" & ") + " for host #{URI.parse(url[:url]).host}"
   
-  warnings_text = has_warnings ? "Warnings for #{bad.select { |(k, v)| v['status'] == 'warning' }.map { |(k, v)| meta_info[k]['in_sentence'] }.join(", ")}." : nil
-  danger_text = has_dangers ? "Dangerous situation for #{bad.select { |(k, v)| v['status'] == 'danger' }.map { |(k, v)| meta_info[k]['in_sentence'] }.join(", ")}." : nil
+    warnings_text = has_warnings ? "Warnings for #{bad.select { |(k, v)| v['status'] == 'warning' }.map { |(k, v)| url[:meta_info][k]['in_sentence'] }.join(", ")}." : nil
+    danger_text = has_dangers ? "Dangerous situation for #{bad.select { |(k, v)| v['status'] == 'danger' }.map { |(k, v)| url[:meta_info][k]['in_sentence'] }.join(", ")}." : nil
 
-  if last_warnings_text != warnings_text or danger_text != last_danger_text or (Time.now - last_time) > 60
-    last_warnings_text = warnings_text
-    last_danger_text = danger_text
-    last_time = Time.now
+    if url[:last_warnings_text] != warnings_text or url[:last_danger_text] != danger_text or (url[:last_time] != 0 and (Time.now - url[:last_time]) > 60)
+      url[:last_warnings_text] = warnings_text
+      url[:last_danger_text] = danger_text
+      url[:last_time] = Time.now
 
-    unless bad.empty?
-      g.notify "Webstats Notification", title, [danger_text, warnings_text].compact.join(" "), nil, nil, true, (has_dangers ? 2 : 1)
+      unless bad.empty?
+        g.notify "Webstats Notification", title, [danger_text, warnings_text].compact.join(" "), nil, nil, true, (has_dangers ? 2 : 1)
+      end
     end
   end
 

data/server/webstats.rb

@@ -17,21 +17,15 @@ Thread.new do
 end
 
 class NilClass
-  def to_json
-    "null"
-  end
+  def to_json; "null"; end
 end
 
 class TrueClass
-  def to_json
-    "true"
-  end
+  def to_json; "true"; end
 end
 
 class FalseClass
-  def to_json
-    "false"
-  end
+  def to_json; "false"; end
 end
 
 class String
@@ -56,17 +50,46 @@ class Numeric
 end
 
 class Array
+  def formatted!
+    each_with_index do |v, i|
+      if v.is_a? Numeric
+        self[i] = v.formatted
+      elsif v.is_a? Hash or v.is_a? Array
+        self[i] = self[i].dup.formatted!
+      end
+    end
+  end
+
+  def stringify_keys!
+    each_with_index { |v, i| self[i] = self[i].dup.stringify_keys! if v.is_a? Hash }
+  end
+
   def to_json
     "[#{map { |e| e.to_json }.join(',')}]"
   end
 end
 
 class Hash
-  def formatted
-    out = self.dup
-    out.each_pair { |k, v| out[k] = v.formatted }
-    out
+  def formatted!
+    each_pair do |k, v|
+      if v.is_a? Numeric
+        self[k] = v.formatted
+      elsif v.is_a? Hash or v.is_a? Array
+        self[k] = self[k].dup.formatted!
+      end
+    end
+  end
+  
+  def stringify_keys!
+    keys.each { |key| self[key.to_s] = delete(key) }
+    each_pair { |k, v| self[k] = self[k].dup.stringify_keys! if v.is_a? Hash }
   end
+
+  alias_method :undecorated_get, :[]
+  def [](key)
+    undecorated_get(key) or undecorated_get(key.is_a?(String) ? key.to_sym : key.to_s)
+  end
+
   def to_json
     arr = []
     each_pair { |k, v| arr << "#{k.to_json}:#{v.to_json}" }
@@ -99,25 +122,21 @@ DataProviders.preload
 
 WEBSTATS_PATH = File.expand_path("~/.webstats")
 
-settings = {}
+$settings = {}
 
 if File.exists?(WEBSTATS_PATH)
-  settings = YAML.load(IO.read(WEBSTATS_PATH))
+  $settings = YAML.load(IO.read(WEBSTATS_PATH))
 else
-  DataProviders::DATA_SOURCES_CLASSES.each_pair do |k, v|
-    settings[k] = v.default_settings
-  end
-
-  File.open(WEBSTATS_PATH, "w") do |f|
-    YAML.dump(settings, f)
-  end
+  $settings['webstats'] = { 'password' => nil }
+  DataProviders::DATA_SOURCES_CLASSES.each_pair { |k, v| $settings[k.to_s] = v.default_settings.stringify_keys! }
+  File.open(WEBSTATS_PATH, "w") { |f| YAML.dump($settings, f) }
 end
 
-DataProviders.setup(settings)
+DataProviders.setup($settings)
 
 class Webstats < WEBrick::HTTPServlet::AbstractServlet
   def do_GET(req, res)
-    WEBrick::HTTPAuth.basic_auth(req, res, "Webstats") { |user, pass| user == 'webstats' and pass == ARGV[0] } unless ARGV.empty?
+    WEBrick::HTTPAuth.basic_auth(req, res, "Webstats") { |u, p| u == 'webstats' and p == $settings[:webstats][:password] } unless $settings[:webstats][:password].nil?
 
     body = ""
     if req.path_info == '/'
@@ -201,7 +220,7 @@ EOF
         out[k] = v.get.dup
       end
 
-      fix_leaves_hash(out)
+      out.formatted!
 
       body << out.to_json
     elsif req.path_info == '/information'
@@ -213,31 +232,6 @@ EOF
     res.body = body
     res['Content-Type'] = "text/html"
   end
-
-  private
-  def fix_leaves_array(array)
-    array.each_with_index do |v, i|
-      if v.is_a? Numeric
-        array[i] = v.formatted
-      elsif v.is_a? Hash
-        array[i] = fix_leaves_hash(array[i].dup)
-      elsif v.is_a? Array
-        array[i] = fix_leaves_array(array[i].dup)
-      end
-    end
-  end
-
-  def fix_leaves_hash(hash)
-    hash.each_pair do |k, v|
-      if v.is_a? Numeric
-        hash[k] = v.formatted
-      elsif v.is_a? Hash
-        hash[k] = fix_leaves_hash(hash[k].dup)
-      elsif v.is_a? Array
-        hash[k] = fix_leaves_array(hash[k].dup)
-      end
-    end
-  end
 end
 
 s = WEBrick::HTTPServer.new(:Port => 9970)

data/webstats.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{webstats}
-  s.version = "0.3.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brenton Fletcher"]
   s.date = %q{2009-04-27}
-  s.description = %q{Display server CPU/Memory/Disk Usage on a web page, suitable for remote performance monitoring.}
+  s.description = %q{Monitor server CPU/Memory/Disk Usage/URL Loading, so that you can view those statistics on a web page, as well as providing an interface to client prorams to read those statistics.}
   s.email = %q{i@bloople.net}
   s.executables = ["webstats", "webstats_growl_notifier"]
   s.extensions = ["server/data_providers/extconf.rb"]
@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
     "VERSION.yml",
     "bin/webstats",
     "bin/webstats_growl_notifier",
+    "clients/common.rb",
     "clients/email_notifier/email_notifier.rb",
     "clients/growl_notifier/Growl.rb",
     "clients/growl_notifier/growl_notifier.rb",
@@ -39,7 +40,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = [""]
   s.rubygems_version = %q{1.3.1}
-  s.summary = %q{Display server CPU/Memory/Disk Usage on a web page, suitable for remote performance monitoring.}
+  s.summary = %q{Monitor server CPU/Memory/Disk Usage/URL Loading, so that you can view those statistics on a web page, as well as providing an interface to client prorams to read those statistics.}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bloopletech-webstats
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Brenton Fletcher
@@ -13,7 +13,7 @@ date: 2009-04-27 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
-description: Display server CPU/Memory/Disk Usage on a web page, suitable for remote performance monitoring.
+description: Monitor server CPU/Memory/Disk Usage/URL Loading, so that you can view those statistics on a web page, as well as providing an interface to client prorams to read those statistics.
 email: i@bloople.net
 executables: 
 - webstats
@@ -30,6 +30,7 @@ files:
 - VERSION.yml
 - bin/webstats
 - bin/webstats_growl_notifier
+- clients/common.rb
 - clients/email_notifier/email_notifier.rb
 - clients/growl_notifier/Growl.rb
 - clients/growl_notifier/growl_notifier.rb
@@ -67,6 +68,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Display server CPU/Memory/Disk Usage on a web page, suitable for remote performance monitoring.
+summary: Monitor server CPU/Memory/Disk Usage/URL Loading, so that you can view those statistics on a web page, as well as providing an interface to client prorams to read those statistics.
 test_files: []