fiveruns-dash-sensor 0.8.4 → 0.8.5

data/README.rdoc

@@ -4,11 +4,7 @@ Please see http://dash.fiveruns.com for an overview of the Dash service.
 
 == Summary
 
-Sensor provides a mechanism for "external" monitoring of infrastructure with Dash.
-Since Dash is usually embedded within an application (i.e. internal), there's no easy
-way to monitor things like Apache, memcached, or other pieces.  Sensor is designed to
-be installed on a machine and upload metrics for any infrastructure on that machine.
-The user just needs to configure which elements they want to monitor.
+Sensor provides a mechanism for "external" monitoring of infrastructure with Dash. Since Dash is usually embedded within an application (i.e. internal), there's no easy way to monitor things like Apache, memcached, or other pieces.  Sensor is designed to be installed on a machine and upload metrics for any infrastructure on that machine. The user just needs to configure which elements they want to monitor.
 
 == Installation
 
@@ -17,31 +13,22 @@ gem install fiveruns-dash-sensor -s http://gems.github.com
 == Configuration
 
 When you run 'fiveruns-dash-sensor' for the first time, it will create a blank
-configuration for you in ~/.fiveruns-dash-sensor/config.rb.  You will need to edit
-this file with your app token and activate the plugins for your environment.  Once
-done, you should be able to restart 'fiveruns-dash-sensor' for a few minutes to verify 
-everything is working as designed.  If there are no problems, you can run
-'fiveruns-dash-sensor -d' to spin off the daemon into the background and forget about it.
+configuration for you in ~/.fiveruns-dash-sensor/config.rb.  You will need to edit this file with your app token and activate the plugins for your environment.  Once done, you should be able to restart 'fiveruns-dash-sensor' for a few minutes to verify everything is working as designed.  If there are no problems, you can run 'fiveruns-dash-sensor -d' to spin off the daemon into the background and forget about it.
 
 == Command Summary
 
   fiveruns-dash-sensor --help
 
-Sensor allows you to control OS-specific parameters like log file and PID file location,
-the user and group to run as, etc.  -d will start Sensor as a daemon.  To stop it, just
-kill the associated PID.
+Sensor allows you to control OS-specific parameters like log file and PID file location, the user and group to run as, etc.  -d will start Sensor as a daemon.  To stop it, just kill the associated PID.
 
 == Creating your own Plugins
 
-Sensor allows you to create your own custom plugins for your own infrastructure.  Each
-plugin should reside in ~/.fiveruns-dash-sensor/<name>.rb and config.rb should have an
-entry in it like this:
+Sensor allows you to create your own custom plugins for your own infrastructure.  Each plugin should reside in ~/.fiveruns-dash-sensor/<name>.rb and config.rb should have an entry in it like this:
 
   sensor.plugin :<name>, any options here...
 
 Please see the existing plugins for examples of how your code should work.
 
-
 == License
 
   # (The FiveRuns License)

data/VERSION.yml

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

data/plugins/noaa_weather.rb

@@ -0,0 +1,73 @@
+require 'open-uri'
+
+begin
+  require 'nokogiri'
+rescue LoadError => le
+  puts [
+    "The NOAA weather plugin requires the nokogiri gem.  Install with:",
+    "   sudo gem install nokogiri"
+    ].join("\n")
+  raise le
+end
+
+# Collect the temperature and air pressure as reported by NOAA and send them to Dash.
+# Proof that Sensor and Dash work with more than boring old software metrics.
+# They work with boring real life metrics too.  :-)
+module Dash::Sensor::Plugins
+  class NoaaWeather
+    include SensorPlugin
+
+    register :noaa_weather, :url => 'http://dash.fiveruns.com' do |recipe|
+      recipe.absolute :temperature do
+        data[:temperature]
+      end
+      recipe.absolute :pressure do
+        data[:pressure]
+      end
+    end
+
+    def configure(options)
+      @url = "http://www.weather.gov/data/current_obs/#{options.fetch(:station, 'katt').upcase}.xml"
+      format = options.fetch(:format, 'metric')
+      case format.to_s
+      when 'metric'
+        @temp_format = 'c'
+        @pres_format = 'mb'
+      when 'english'
+        @temp_format = 'f'
+        @pres_format = 'in'
+      else
+        raise ArgumentError, "Unknown format '#{format}', must be either be :metric or :english"
+      end
+    end
+
+    private
+
+    def self.data
+      # Cache the data for 15 minutes, we don't really need it every minute.
+      if !@time || @time < Time.now - 900
+        logger.debug "Fetching data at #{Time.now}"
+        @data = instance.send(:data)
+        @time = Time.now
+      end
+      @data
+    end
+    
+    def data
+      begin
+        xml = open(@url)
+        doc = Nokogiri::XML(xml)
+
+        result = {}
+        result[:temperature] = Float(doc.xpath("/current_observation/temp_#{@temp_format}").inner_text)
+        result[:pressure] = Float(doc.xpath("/current_observation/pressure_#{@pres_format}").inner_text)
+        result
+      rescue Exception => e
+        logger.error "Error contacting #{@url}"
+        logger.error "#{e.class.name}: #{e.message}"
+        Hash.new(0)
+      end
+    end
+
+  end
+end

data/plugins/twitter.rb

@@ -0,0 +1,79 @@
+require 'open-uri'
+
+begin
+  require 'nokogiri'
+rescue LoadError => le
+  puts [
+    "The Twitter plugin requires the nokogiri gem.  Install with:",
+    "   sudo gem install nokogiri"
+    ].join("\n")
+  raise le
+end
+
+# Collect common Twitter metrics and send them to Dash.
+# Proof that Sensor and Dash work with more than boring old technical metrics.
+# They work with boring social networking metrics too.  :-)
+module Dash::Sensor::Plugins
+  class Twitter
+    include SensorPlugin
+
+    register :twitter, :url => 'http://dash.fiveruns.com' do |recipe|
+      recipe.absolute :updates do
+        data[:update_count]
+      end
+      recipe.absolute :following do
+        data[:following_count]
+      end
+      recipe.absolute :followers do
+        data[:follower_count]
+      end
+      recipe.counter :tweets do
+        count = data[:update_count] - old_data[:update_count]
+        # update the old data to reflect the current metric
+        # since we are caching and don't want to return the same
+        # counter value every minute.
+        old_data.merge(data)
+        count > 0 ? count : 0
+      end
+    end
+
+    def configure(options)
+      @url = "http://twitter.com/#{options[:username]}"
+    end
+
+    private
+
+    def self.data
+      # Cache the data for 15 minutes, we don't really need it every minute.
+      if !@time || @time < Time.now - 900
+        logger.debug "Fetching data at #{Time.now}"
+        @old_data = @data || Hash.new(1_000_000_000)
+        @data = instance.send(:data)
+        @time = Time.now
+      end
+      @data
+    end
+    
+    def self.old_data
+      @old_data
+    end
+
+    def data
+      begin
+        html = open(@url)
+        doc = Nokogiri::HTML(html)
+
+        %w(following_count follower_count update_count).inject({}) do |result, metric|
+          txt = doc.css("\##{metric}").inner_text
+          result[metric.to_sym] = Integer(txt.gsub /\D/, '')
+          result
+        end
+      rescue Exception => e
+        logger.error "Error contacting #{@url}"
+        logger.error "#{e.class.name}: #{e.message}"
+        Hash.new(0)
+      end
+    end
+
+  end
+end

metadata

@@ -1,42 +1,54 @@
 --- !ruby/object:Gem::Specification 
 name: fiveruns-dash-sensor
 version: !ruby/object:Gem::Version 
-  version: 0.8.4
+  version: 0.8.5
 platform: ruby
 authors: 
-- FiveRuns
+- FiveRuns Development Team
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-02-05 00:00:00 -08:00
-default_executable: 
-dependencies: []
-
-description: Sensor allows Dash to monitor ad-hoc infrastructure non-invasively
-email: support@fiveruns.com
+date: 2009-02-26 00:00:00 -08:00
+default_executable: fiveruns-dash-sensor
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fiveruns-dash-ruby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.8.2
+    version: 
+description: Daemon to monitor ad-hoc infrastructure non-invasively for FiveRuns Dash
+email: dev@fiveruns.com
 executables: 
 - fiveruns-dash-sensor
 extensions: []
 
-extra_rdoc_files: 
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
+- README.rdoc
+- VERSION.yml
 - bin/fiveruns-dash-sensor
-- config.rb
 - lib/runner.rb
 - lib/sensor.rb
 - lib/sensor_plugin.rb
+- plugins/apache.rb
 - plugins/memcached.rb
-- plugins/starling.rb
 - plugins/nginx.rb
-- plugins/apache.rb
-- README.rdoc
-has_rdoc: false
+- plugins/noaa_weather.rb
+- plugins/starling.rb
+- plugins/twitter.rb
+has_rdoc: true
 homepage: http://github.com/fiveruns/dash-sensor/
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -57,6 +69,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Sensor allows Dash to monitor ad-hoc infrastructure non-invasively
+summary: FiveRuns Sensor allows Dash to monitor ad-hoc infrastructure non-invasively
 test_files: []
 

data/config.rb

@@ -1,19 +0,0 @@
-# Example configuration for FiveRuns Dash Sensor daemon.
-# Configure your Dash sensor instance here.
-# This file should reside in ~/.fiveruns-dash-sensor/config.rb
-#
-# We suggest you have a single Dash Sensor instance running per machine
-# and an application token per environment.  So if you have 8 machines
-# in your application's production cluster, you would have 8 sensor instances
-# running for one application named "<App> Production Cluster".
-
-#sensor.token = 'change-to-your-application-token'
-
-# One line per piece of infrastructure you wish to monitor.
-# The plugins are in the plugins directory.
-
-# Available options and their defaults are listed.
-#sensor.plugin 'memcached', :iface => 'localhost', :port => 11211
-#sensor.plugin 'starling', :iface => 'localhost', :port => 22122
-#sensor.plugin 'apache', :url => 'http://localhost/server-status?auto'
-#sensor.plugin 'nginx', :url => 'http://localhost/nginx_status'