instrumental_agent 0.2.0 → 0.3.0

data/README.rdoc

@@ -11,11 +11,9 @@ Add the gem to your Gemfile.
 Visit instrumentalapp.com[instrumentalapp.com] and create an account, then 
 initialize the agent with your API key, found in the Docs section.
 
-  I = Instrumental::Agent.new('YOUR_API_KEY', :enabled => Rails.env.production?)
+  I = Instrumental::Agent.new('YOUR_API_KEY', :test_mode => !Rails.env.production?)
 
-If you're already using EventMachine elsewhere, or are hosted on Heroku, then you will need to disable the reactor loop startup.
-
-  I = Instrumental::Agent.new('YOUR_API_KEY', :enabled => Rails.env.production?, :start_reactor => false)
+We recommend setting test_mode to true in dev/test modes so that you don't pollute your production data.
 
 Now you can begin to use Instrumental to track your application.
 
@@ -38,6 +36,8 @@ a shot by initializing it with:
 
   Instrumental::Middleware.boot
 
+Need to quickly disable the agent? set :enabled to false on initialization and you don't need to change any application code.
+
 == Troubleshooting & Help
 
 We are here to help, please email us at mailto:support@instrumentalapp.com.

data/lib/instrumental/agent.rb

@@ -15,7 +15,7 @@ module Instrumental
 
     attr_accessor :host, :port
     attr_reader :connection, :enabled
-    
+
     def self.logger=(l)
       @logger = l
     end
@@ -39,18 +39,20 @@ module Instrumental
     #  Instrumental::Agent.new(API_KEY)
     #  Instrumental::Agent.new(API_KEY, :collector => 'hostname:port')
     def initialize(api_key, options = {})
-      default_options = { :enabled => true }
-      options = default_options.merge(options)
-      @api_key = api_key
-      if options[:collector]
-        @host, @port = options[:collector].split(':')
-        @port = (@port || 8000).to_i
-      else
-        @host = 'instrumentalapp.com'
-        @port = 8000
-      end
+      default_options = {
+        :collector => 'instrumentalapp.com:8000',
+        :enabled   => true,
+        :test_mode => false,
+      }
+      options   = default_options.merge(options)
+      collector = options[:collector].split(':')
+
+      @api_key   = api_key
+      @host      = collector[0]
+      @port      = (collector[1] || 8000).to_i
+      @enabled   = options[:enabled]
+      @test_mode = options[:test_mode]
 
-      @enabled = options[:enabled]
       if @enabled
         @failures = 0
         @queue = Queue.new
@@ -62,17 +64,30 @@ module Instrumental
     #
     #  agent.gauge('load', 1.23)
     def gauge(metric, value, time = Time.now)
-      if valid?(metric, value, time)
-        send_command("gauge", metric, value, time.to_i)
+      if valid?(metric, value, time) &&
+          send_command("gauge", metric, value, time.to_i)
+        value
+      else
+        nil
       end
+    rescue Exception => e
+      report_exception(e)
+      nil
     end
 
     # Increment a metric, optionally more than one or at a specific time.
     #
     #  agent.increment('users')
     def increment(metric, value = 1, time = Time.now)
-      valid?(metric, value, time)
-      send_command("increment", metric, value, time.to_i)
+      if valid?(metric, value, time) &&
+          send_command("increment", metric, value, time.to_i)
+        value
+      else
+        nil
+      end
+    rescue Exception => e
+      report_exception(e)
+      nil
     end
 
     def enabled?
@@ -103,14 +118,21 @@ module Instrumental
       true
     end
 
+    def report_exception(e)
+      logger.error "Exception occurred: #{e.message}"
+      logger.error e.backtrace.join("\n")
+    end
+
     def send_command(cmd, *args)
       if enabled?
         cmd = "%s %s\n" % [cmd, args.collect(&:to_s).join(" ")]
         if @queue.size < MAX_BUFFER
           logger.debug "Queueing: #{cmd.chomp}"
           @queue << cmd
+          cmd
         else
           logger.warn "Dropping command, queue full(#{@queue.size}): #{cmd.chomp}"
+          nil
         end
       end
     end
@@ -125,12 +147,13 @@ module Instrumental
     end
 
     def start_connection_thread
+      logger.info "Starting thread"
       @thread = Thread.new do
         begin
           @socket = TCPSocket.new(host, port)
           @failures = 0
           logger.info "connected to collector"
-          @socket.puts "hello version 0.0"
+          @socket.puts "hello version #{Instrumental::VERSION} test_mode #{@test_mode}"
           @socket.puts "authenticate #{@api_key}"
           loop do
             command_and_args = @queue.pop
@@ -143,6 +166,7 @@ module Instrumental
 
             if command_and_args == 'exit'
               logger.info "exiting, #{@queue.size} commands remain"
+              @socket.flush
               Thread.exit
             else
               logger.debug "Sending: #{command_and_args.chomp}"
@@ -173,4 +197,5 @@ module Instrumental
       end
     end
   end
+
 end

data/lib/instrumental/version.rb

@@ -1,3 +1,3 @@
 module Instrumental
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/agent_spec.rb

@@ -28,6 +28,46 @@ describe Instrumental::Agent, "disabled" do
 
 end
 
+describe Instrumental::Agent, "enabled in test_mode" do
+  before do
+    @server = TestServer.new
+    @agent = Instrumental::Agent.new('test_token', :collector => @server.host_and_port, :test_mode => true)
+  end
+
+  after do
+    @server.stop
+  end
+
+  it "should connect to the server" do
+    wait
+    @server.connect_count.should == 1
+  end
+
+  it "should announce itself, and include version and test_mode flag" do
+    wait
+    @server.commands[0].should =~ /hello .*version .*test_mode true/
+  end
+
+  it "should authenticate using the token" do
+    wait
+    @server.commands[1].should == "authenticate test_token"
+  end
+
+  it "should report a gauge" do
+    now = Time.now
+    @agent.gauge('gauge_test', 123)
+    wait
+    @server.commands.last.should == "gauge gauge_test 123 #{now.to_i}"
+  end
+
+  it "should report an increment" do
+    now = Time.now
+    @agent.increment("increment_test")
+    wait
+    @server.commands.last.should == "increment increment_test 1 #{now.to_i}"
+  end
+end
+
 describe Instrumental::Agent, "enabled" do
   before do
     @server = TestServer.new
@@ -60,6 +100,13 @@ describe Instrumental::Agent, "enabled" do
     @server.commands.last.should == "gauge gauge_test 123 #{now.to_i}"
   end
 
+  it "should return the value gauged" do
+    now = Time.now
+    @agent.gauge('gauge_test', 123).should == 123
+    @agent.gauge('gauge_test', 989).should == 989
+    wait
+  end
+
   it "should report a gauge with a set time" do
     @agent.gauge('gauge_test', 123, 555)
     wait
@@ -73,6 +120,13 @@ describe Instrumental::Agent, "enabled" do
     @server.commands.last.should == "increment increment_test 1 #{now.to_i}"
   end
 
+  it "should return the value incremented by" do
+    now = Time.now
+    @agent.increment("increment_test").should == 1
+    @agent.increment("increment_test", 5).should == 5
+    wait
+  end
+
   it "should report an increment a value" do
     now = Time.now
     @agent.increment("increment_test", 2)
@@ -94,4 +148,21 @@ describe Instrumental::Agent, "enabled" do
     @server.connect_count.should == 2
     @server.commands.last.should == "increment reconnect_test 1 1234"
   end
+
+  it "should never let an exception reach the user" do
+    @agent.stub!(:send_command).and_raise(Exception.new("Test Exception"))
+    @agent.increment('throws_exception', 2).should be_nil
+    wait
+    @agent.gauge('throws_exception', 234).should be_nil
+    wait
+  end
+
+  it "should return nil if the user overflows the MAX_BUFFER" do
+    thread = @agent.instance_variable_get(:@thread)
+    thread.kill
+    1.upto(Instrumental::Agent::MAX_BUFFER) do
+      @agent.increment("test").should == 1
+    end
+    @agent.increment("test").should be_nil
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: instrumental_agent
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Elijah Miller
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-15 00:00:00 -05:00
+date: 2011-11-17 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency