tronprint 1.2.0 → 1.2.1

data/lib/tronprint.rb

@@ -82,12 +82,20 @@ module Tronprint
 
   # The Tronprint::Aggregator instance.
   def aggregator
-    @aggregator ||= Aggregator.new aggregator_options.dup
+    return @aggregator unless @aggregator.nil?
+    begin
+      @aggregator = Aggregator.new aggregator_options.dup
+    rescue => e
+      backtrace = ([e] + e.backtrace).join("\n")
+      log_error "Failed to connect to aggregator: #{backtrace}"
+      @aggregator = nil
+    end
+    @aggregator
   end
 
   # The Tronprint::CPUMonitor instance.
   def cpu_monitor
-    @cpu_monitor ||= CPUMonitor.new aggregator, application_name
+    @cpu_monitor ||= CPUMonitor.new application_name
   end
 
   # The Tronprint::TrafficMonitor instance
@@ -158,4 +166,7 @@ module Tronprint
   def log_info(message)
     logger.info message if logger
   end
+  def log_error(message)
+    logger.error message if logger
+  end
 end

data/lib/tronprint/aggregator.rb

@@ -21,6 +21,9 @@ module Tronprint
       self.adapter = options.delete :adapter
       self.adapter ||= 'pstore'
       self.adapter = self.adapter.to_s.downcase
+
+      options = process_options(options)
+
       begin
         require "moneta/#{self.adapter}"
         klass = Moneta.const_get adapter_constant
@@ -34,6 +37,14 @@ module Tronprint
       super instance
     end
 
+    # Handle initializer options for some special cases
+    def process_options(options)
+      if adapter == 'mongodb'
+        options[:pool_size] = 3
+      end
+      options
+    end
+
     def __getobj__ # :nodoc:
       @delegate_sd_obj
     end
@@ -133,10 +144,22 @@ module Tronprint
     end
 
     def update_entry(key, value)
-      old_value = self[key]
+      begin
+        old_value = self[key]
+      rescue => e
+        backtrace = ([e] + e.backtrace).join("\n")
+        Tronprint.log_error "Tronprint: Unable to fetch statistics from datastore: #{backtrace}"
+      end
+
       new_value = old_value ? old_value + value : value
       Tronprint.log_debug "Tronprint.aggregator[#{key.inspect}] = #{new_value}"
-      self[key] = new_value
+
+      begin
+        self[key] = new_value
+      rescue => e
+        backtrace = ([e] + e.backtrace).join("\n")
+        Tronprint.log_error "Tronprint: Unable to update datastore with statistics: #{backtrace}"
+      end
     end
   end
 end

data/lib/tronprint/cpu_monitor.rb

@@ -2,34 +2,47 @@ module Tronprint
 
   # Tronprint::CPUMonitor is a thread that monitors aggregate CPU usage.
   class CPUMonitor < Thread
-    attr_accessor :total_recorded_cpu_time, :aggregator, :application_name
+    attr_accessor :total_recorded_cpu_time, :application_name, :run_continuously
 
     # Parameters:
-    # +aggregator+:: A Tronprint::Aggregator instance.
     # +application_name+:: A unique application name.
     # +options+:: Extra options, such as:
     # --+run+:: Whether to fork the thread and run continuously. +true+ by default.
-    def initialize(aggregator, application_name, options = {})
-      self.aggregator = aggregator
+    def initialize(application_name, options = {})
       self.application_name = application_name
       options[:run] = true if options[:run].nil?
       if options[:run]
-        super do
-          while(true) do
-           monitor
-           sleep(5)
-          end
-        end
+        super &method(:thread_loop)
       else
         super() {}  # Ruby 1.8 hack
       end
     end
 
+    def run_continuously?
+      @run_continuously = true if @run_continuously.nil?
+      @run_continuously
+    end
+
+    # The main thread loop, monitors CPU usage every 5 seconds if
+    # a connection to the aggregator is available
+    def thread_loop
+      first_run = true
+      begin
+        monitor if aggregator
+        sleep(5) if run_continuously?
+        first_run = false
+      end while(first_run or run_continuously?)
+    end
+
     # The key used to store CPU data in the Aggregator.
     def key
       [application_name, 'application', 'cpu_time'].join('/')
     end
 
+    def aggregator
+      Tronprint.aggregator
+    end
+
     # The process used to collect CPU uptime data and store it.
     def monitor
       elapsed_time = elapsed_cpu_time

data/lib/tronprint/rails/tronprint_helper.rb

@@ -21,31 +21,37 @@ module TronprintHelper
 
   # An informational badge displaying total energy, footprint, CO2/minute
   def footprint_badge(options = {})
-    footprint = pounds_with_precision total_estimate
+    begin
+      footprint = pounds_with_precision total_estimate
 
-    two_hr_emissions = Tronprint.statistics.
-      emission_estimate(Time.now - 7200, Time.now).to_f
-    rate = two_hr_emissions / 120  # kgs CO2 per minute over last 2 hours
-    rate = rate < 0.0001 ? "< 0.0001" : pounds_with_precision(rate)
+      two_hr_emissions = Tronprint.statistics.
+        emission_estimate(Time.now - 7200, Time.now).to_f
+      rate = two_hr_emissions / 120  # kgs CO2 per minute over last 2 hours
+      rate = rate < 0.0001 ? "< 0.0001" : pounds_with_precision(rate)
 
-    text = <<-HTML
-      <p class="tronprint-footprint">
-        <span class="tronprint-total-footprint">
-          <span class="tronprint-label">Total app footprint:</span>
-          <span class="tronprint-value">#{total_electricity.to_i}</span>
-          <span class="tronprint-units">W</span>,
-          <span class="tronprint-value">#{footprint}</span>
-          <span class="tronprint-units">lbs. CO<sub>2</sub>e</span>
-        </span>
-        <span class="tronprint-separator">&middot;</span>
-        <span class="tronprint-current-footprint">
-          <span class="tronprint-label">Current footprint:</span>
-          <span class="tronprint-value">#{rate}</span>
-          <span class="tronprint-units">lbs. CO<sub>2</sub>e/min.</span>
-        </span>
-        <span class="tronprint-attribution">#{tronprint_attribution if options[:attribution]}</span>
-      </p>
-    HTML
+      text = <<-HTML
+        <p class="tronprint-footprint">
+          <span class="tronprint-total-footprint">
+            <span class="tronprint-label">Total app footprint:</span>
+            <span class="tronprint-value">#{total_electricity.to_i}</span>
+            <span class="tronprint-units">W</span>,
+            <span class="tronprint-value">#{footprint}</span>
+            <span class="tronprint-units">lbs. CO<sub>2</sub>e</span>
+          </span>
+          <span class="tronprint-separator">&middot;</span>
+          <span class="tronprint-current-footprint">
+            <span class="tronprint-label">Current footprint:</span>
+            <span class="tronprint-value">#{rate}</span>
+            <span class="tronprint-units">lbs. CO<sub>2</sub>e/min.</span>
+          </span>
+          <span class="tronprint-attribution">#{tronprint_attribution if options[:attribution]}</span>
+        </p>
+      HTML
+    rescue => e
+      text = <<-HTML
+        <p class="tronprint-footprint">App footprint unavailable</p>
+      HTML
+    end
 
     text.html_safe
   end
@@ -57,7 +63,7 @@ module TronprintHelper
 
   # A link to more information about Tronprint
   def tronprint_badge
-    %Q{<p class="tronprint-link"><%= tronprint_attribution %></p>}.html_safe
+    %Q{<p class="tronprint-link">#{tronprint_attribution}</p>}.html_safe
   end
 
   # Let the world know that your app is powered by CM1

data/lib/tronprint/version.rb

@@ -1,3 +1,3 @@
 module Tronprint
-  VERSION = "1.2.0"
+  VERSION = "1.2.1"
 end

data/spec/tronprint/aggregator_spec.rb

@@ -73,6 +73,22 @@ describe Tronprint::Aggregator do
     end
   end
 
+  describe '#process_options' do
+    it 'sets a pool size if the adapter is mongodb' do
+      aggregator.adapter = 'mongodb'
+      options = aggregator.process_options :hostname => 'example.com'
+      options[:pool_size].should > 1
+    end
+  end
+
+  describe '#update_entry' do
+    it 'logs any connection errors' do
+      aggregator.stub!(:[]).and_raise StandardError
+      Tronprint.should_receive(:log_error).once
+      aggregator.send :update_entry, 'foo', 77
+    end
+  end
+
   describe '#range_total' do
     before :each do
       [

data/spec/tronprint/cpu_monitor_spec.rb

@@ -2,7 +2,32 @@ require 'spec_helper'
 
 describe Tronprint::CPUMonitor do
   let(:aggregator) { Tronprint::Aggregator.new :adapter => :memory }
-  let(:cpu_monitor) { Tronprint::CPUMonitor.new aggregator, 'my_app', :run => false }
+  let(:cpu_monitor) { Tronprint::CPUMonitor.new 'my_app', :run => false }
+
+  before :each do
+    Tronprint.stub!(:aggregator).and_return aggregator
+    cpu_monitor.run_continuously = false
+  end
+
+  describe '#thread_loop' do
+    it 'monitors CPU usage' do
+      cpu_monitor.should_receive :monitor
+      cpu_monitor.thread_loop
+    end
+    it 'does not monitor if no aggregator is available' do
+      cpu_monitor.should_not_receive :monitor
+      Tronprint.stub!(:aggregator)
+      cpu_monitor.thread_loop
+    end
+    it 'eventually monitors when it can connect to an aggregator' do
+      cpu_monitor.stub!(:sleep)
+      cpu_monitor.stub!(:run_continuously?).and_return(true, true, true, true, true, false)
+      Tronprint.stub!(:aggregator).and_return(nil, nil, aggregator)
+
+      cpu_monitor.should_receive :monitor
+      cpu_monitor.thread_loop
+    end
+  end
 
   describe '#monitor' do
     before :each do

data/spec/tronprint/rails/tronprint_helper_spec.rb

@@ -14,5 +14,19 @@ describe TronprintHelper do
       helper.total_footprint.should == 89.4
     end
   end
+
+  describe '#footprint_badge' do
+    it 'outputs a badge' do
+      helper.stub!(:pounds_with_precision).and_return "100.0"
+      helper.stub!(:total_estimate).and_return 100.0
+      Tronprint.statistics.stub!(:emission_estimate).and_return 100.0
+      helper.stub!(:total_electricity).and_return 20
+      helper.footprint_badge.should =~ /Total app footprint/
+    end
+    it 'gracefully handles lost aggregator connections' do
+      helper.stub!(:total_estimate).and_raise StandardError
+      helper.footprint_badge.should =~ /App footprint unavailable/
+    end
+  end
 end
 

data/spec/tronprint_spec.rb

@@ -37,6 +37,12 @@ describe Tronprint do
     end
   end
 
+  describe '.traffic_monitor' do
+    it 'returns a traffic monitor' do
+      Tronprint.traffic_monitor.should be_a(Tronprint::TrafficMonitor)
+    end
+  end
+
   describe '.config' do
     it 'returns a configuration loaded from disk' do
       Tronprint.stub!(:load_config).and_return :foo => :bar
@@ -89,6 +95,25 @@ describe Tronprint do
     end
   end
 
+  describe '.aggregator' do
+    it 'returns an aggregator' do
+      Tronprint.aggregator.should be_a(Tronprint::Aggregator)
+    end
+    context 'when the aggregator fails to load a datastore' do
+      before :each do
+        Tronprint::Aggregator.stub!(:new).and_raise(StandardError)
+        Tronprint.instance_variable_set :@aggregator, nil
+      end
+      it 'logs an error' do
+        Tronprint.should_receive :log_error
+        Tronprint.aggregator
+      end
+      it 'returns nil' do
+        Tronprint.aggregator.should be_nil
+      end
+    end
+  end
+
   describe '.aggregator_options' do
     before :each do
       ENV['MONGOHQ_URL'] = nil

data/tronprint.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version = Tronprint::VERSION
 
   s.authors = ['Derek Kastner']
-  s.date = "2011-07-06"
+  s.date = "2011-07-20"
   s.description = %q{A gem for monitoring the carbon footprint of your ruby app}
   s.email = %q{dkastner@gmail.com}
   s.homepage = %q{http://github.com/brighterplanet/tronprint}
@@ -38,8 +38,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', '~> 2.0'
   s.add_development_dependency 'sandbox'
   s.add_development_dependency 'timecop'
-  s.add_runtime_dependency   'carbon', '~> 1.1.1'
+  s.add_runtime_dependency 'carbon', '~> 1.1.1'
   s.add_runtime_dependency 'i18n'
-  s.add_runtime_dependency 'dkastner-moneta', '~> 1.1.0'
+  s.add_runtime_dependency 'dkastner-moneta', '~> 1.1.1'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tronprint
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-06 00:00:00.000000000Z
+date: 2011-07-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &2169219780 !ruby/object:Gem::Requirement
+  requirement: &2164332000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3'
   type: :development
   prerelease: false
-  version_requirements: *2169219780
+  version_requirements: *2164332000
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2169219280 !ruby/object:Gem::Requirement
+  requirement: &2164331500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3'
   type: :development
   prerelease: false
-  version_requirements: *2169219280
+  version_requirements: *2164331500
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &2169218900 !ruby/object:Gem::Requirement
+  requirement: &2164331120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2169218900
+  version_requirements: *2164331120
 - !ruby/object:Gem::Dependency
   name: bueller
-  requirement: &2169173640 !ruby/object:Gem::Requirement
+  requirement: &2164330580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.0.2
   type: :development
   prerelease: false
-  version_requirements: *2169173640
+  version_requirements: *2164330580
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2169173020 !ruby/object:Gem::Requirement
+  requirement: &2164330160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2169173020
+  version_requirements: *2164330160
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2169172440 !ruby/object:Gem::Requirement
+  requirement: &2164329620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *2169172440
+  version_requirements: *2164329620
 - !ruby/object:Gem::Dependency
   name: sandbox
-  requirement: &2169172020 !ruby/object:Gem::Requirement
+  requirement: &2164329200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2169172020
+  version_requirements: *2164329200
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &2169171560 !ruby/object:Gem::Requirement
+  requirement: &2164328740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2169171560
+  version_requirements: *2164328740
 - !ruby/object:Gem::Dependency
   name: carbon
-  requirement: &2169171060 !ruby/object:Gem::Requirement
+  requirement: &2164328240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: 1.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *2169171060
+  version_requirements: *2164328240
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2169170640 !ruby/object:Gem::Requirement
+  requirement: &2164327820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,18 +120,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2169170640
+  version_requirements: *2164327820
 - !ruby/object:Gem::Dependency
   name: dkastner-moneta
-  requirement: &2169170100 !ruby/object:Gem::Requirement
+  requirement: &2164327280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *2169170100
+  version_requirements: *2164327280
 description: A gem for monitoring the carbon footprint of your ruby app
 email: dkastner@gmail.com
 executables: []
@@ -188,7 +188,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2285782564370156017
+      hash: -3333556664513962669
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -197,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2285782564370156017
+      hash: -3333556664513962669
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.5