instrumental_agent 0.11.1 → 0.12.0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 0.12.0 [July 30th, 2012]
+* Add timeout to socket flush, fixes rare issue on REE/Linux
+* Send only one buffer full warning
+* Agent instances use global logger more consistently
+* Minor code cleanups
+* Remove rack-middleware
+
 ### 0.11.1 [July 19th, 2012]
 * Make error messages easily locatable in logs
 

data/lib/instrumental/agent.rb

@@ -1,45 +1,10 @@
-require 'instrumental/rack/middleware'
 require 'instrumental/version'
+require 'instrumental/system_timer'
 require 'logger'
 require 'thread'
 require 'socket'
 
-if RUBY_VERSION < "1.9" && RUBY_PLATFORM != "java"
-  timeout_lib = nil
-  ["SystemTimer", "system_timer"].each do |lib|
-    begin
-      unless timeout_lib
-        gem lib
-        require "system_timer"
-        timeout_lib  = SystemTimer
-      end
-    rescue Exception => e
-    end
-  end
-  if !timeout_lib
-    puts <<-EOMSG
-WARNING:: You do not currently have system_timer installed.
-It is strongly advised that you install this gem when using
-instrumental_agent with Ruby 1.8.x.  You can install it in
-your Gemfile via:
-gem 'system_timer'
-or manually via:
-gem install system_timer
-    EOMSG
-    require 'timeout'
-    InstrumentalTimeout = Timeout
-  else
-    InstrumentalTimeout = timeout_lib
-  end
-else
-  require 'timeout'
-  InstrumentalTimeout = Timeout
-end
-
 
-# Sets up a connection to the collector.
-#
-#  Instrumental::Agent.new(API_KEY)
 module Instrumental
   class Agent
     BACKOFF = 2.0
@@ -64,16 +29,6 @@ module Instrumental
       @logger
     end
 
-    def self.all
-      @agents ||= []
-    end
-
-    def self.new(*args)
-      inst = super
-      all << inst
-      inst
-    end
-
     # Sets up a connection to the collector.
     #
     #  Instrumental::Agent.new(API_KEY)
@@ -205,7 +160,7 @@ module Instrumental
     end
 
     def logger
-      @logger ||= self.class.logger
+      @logger || self.class.logger
     end
 
     # Stopping the agent will immediately stop all communication
@@ -290,10 +245,15 @@ module Instrumental
 
         cmd = "%s %s\n" % [cmd, args.collect { |a| a.to_s }.join(" ")]
         if @queue.size < MAX_BUFFER
+          @queue_full_warning = false
           logger.debug "Queueing: #{cmd.chomp}"
           queue_message(cmd, { :synchronous => @synchronous })
         else
-          logger.warn "Dropping command, queue full(#{@queue.size}): #{cmd.chomp}"
+          if !@queue_full_warning
+            @queue_full_warning = true
+            logger.warn "Queue full(#{@queue.size}), dropping commands..."
+          end
+          logger.debug "Dropping command, queue full(#{@queue.size}): #{cmd.chomp}"
           nil
         end
       end
@@ -320,9 +280,8 @@ module Instrumental
     end
 
     def test_connection
-      # FIXME: Test connection state hack
       begin
-        @socket.read_nonblock(1) # TODO: put data back?
+        @socket.read_nonblock(1)
       rescue Errno::EAGAIN
         # noop
       end
@@ -358,7 +317,7 @@ module Instrumental
       logger.info "connecting to collector"
       @socket = with_timeout(CONNECT_TIMEOUT) { TCPSocket.new(host, port) }
       logger.info "connected to collector at #{host}:#{port}"
-      send_with_reply_timeout "hello version #{Instrumental::VERSION} hostname #{Socket.gethostname}"
+      send_with_reply_timeout "hello version #{Instrumental::VERSION} hostname #{Socket.gethostname} pid #{Process.pid}"
       send_with_reply_timeout "authenticate #{@api_key}"
       @failures = 0
       loop do
@@ -418,7 +377,11 @@ module Instrumental
     def disconnect
       if connected?
         logger.info "Disconnecting..."
-        @socket.flush
+        begin
+          with_timeout(EXIT_FLUSH_TIMEOUT) { @socket.flush }
+        rescue Timeout::Error
+          logger.info "Timed out flushing socket..."
+        end
         @socket.close
       end
       @socket = nil

data/lib/instrumental/system_timer.rb

@@ -0,0 +1,31 @@
+if RUBY_VERSION < "1.9" && RUBY_PLATFORM != "java"
+  timeout_lib = nil
+  ["SystemTimer", "system_timer"].each do |lib|
+    begin
+      unless timeout_lib
+        gem lib
+        require "system_timer"
+        timeout_lib  = SystemTimer
+      end
+    rescue Exception => e
+    end
+  end
+  if !timeout_lib
+    puts <<-EOMSG
+WARNING:: You do not currently have system_timer installed.
+It is strongly advised that you install this gem when using
+instrumental_agent with Ruby 1.8.x.  You can install it in
+your Gemfile via:
+gem 'system_timer'
+or manually via:
+gem install system_timer
+    EOMSG
+    require 'timeout'
+    InstrumentalTimeout = Timeout
+  else
+    InstrumentalTimeout = timeout_lib
+  end
+else
+  require 'timeout'
+  InstrumentalTimeout = Timeout
+end

data/lib/instrumental/version.rb

@@ -1,3 +1,3 @@
 module Instrumental
-  VERSION = '0.11.1'
+  VERSION = '0.12.0'
 end

data/spec/agent_spec.rb

@@ -76,7 +76,7 @@ describe Instrumental::Agent, "enabled" do
   it "should announce itself, and include version" do
     @agent.increment("test.foo")
     wait
-    @server.commands[0].should =~ /hello .*version .* hostname .*/
+    @server.commands[0].should =~ /hello .*version .* hostname .* pid .*/
   end
 
   it "should authenticate using the token" do
@@ -307,6 +307,7 @@ describe Instrumental::Agent, "connection problems" do
     @agent.increment("reconnect_test", 1, 1234)
     wait
     @server.disconnect_all
+    wait
     @agent.increment('reconnect_test', 1, 5678) # triggers reconnect
     wait
     @server.connect_count.should == 2
@@ -340,6 +341,21 @@ describe Instrumental::Agent, "connection problems" do
     @agent.queue.pop(true).should include("increment reconnect_test 1 1234 1\n")
   end
 
+  it "should warn once when buffer is full" do
+    with_constants('Instrumental::Agent::MAX_BUFFER' => 3) do
+      @server = TestServer.new(:listen => false)
+      @agent = Instrumental::Agent.new('test_token', :collector => @server.host_and_port, :synchronous => false)
+      wait
+      @agent.logger.should_receive(:warn).with(/Queue full/).once
+
+      @agent.increment('buffer_full_warn_test', 1, 1234)
+      @agent.increment('buffer_full_warn_test', 1, 1234)
+      @agent.increment('buffer_full_warn_test', 1, 1234)
+      @agent.increment('buffer_full_warn_test', 1, 1234)
+      @agent.increment('buffer_full_warn_test', 1, 1234)
+    end
+  end
+
   it "should send commands in a short-lived process" do
     @server = TestServer.new
     @agent = Instrumental::Agent.new('test_token', :collector => @server.host_and_port, :synchronous => false)
@@ -386,6 +402,23 @@ describe Instrumental::Agent, "connection problems" do
       end
     end
   end
+
+  it "should not wait longer than EXIT_FLUSH_TIMEOUT to attempt flushing the socket when disconnecting" do
+    @server = TestServer.new
+    @agent = Instrumental::Agent.new('test_token', :collector => @server.host_and_port, :synchronous => false)
+    @agent.increment('foo', 1)
+    wait
+    @agent.instance_variable_get(:@socket).should_receive(:flush).and_return {
+      r, w = IO.pipe
+      IO.select([r]) # mimic an endless blocking select poll
+    }
+    with_constants('Instrumental::Agent::EXIT_FLUSH_TIMEOUT' => 3) do
+      tm = Time.now.to_f
+      @agent.cleanup
+      diff = Time.now.to_f - tm
+      diff.should <= 3
+    end
+  end
 end
 
 describe Instrumental::Agent, "enabled with sync option" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: instrumental_agent
 version: !ruby/object:Gem::Version
-  version: 0.11.1
+  version: 0.12.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-19 00:00:00.000000000 Z
+date: 2012-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -143,7 +143,7 @@ files:
 - instrumental_agent.gemspec
 - lib/instrumental/agent.rb
 - lib/instrumental/capistrano.rb
-- lib/instrumental/rack/middleware.rb
+- lib/instrumental/system_timer.rb
 - lib/instrumental/version.rb
 - lib/instrumental_agent.rb
 - spec/agent_spec.rb
@@ -163,7 +163,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 891178819189974589
+      hash: -1710263125539985150
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -172,10 +172,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 891178819189974589
+      hash: -1710263125539985150
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Agent for reporting data to instrumentalapp.com

data/lib/instrumental/rack/middleware.rb

@@ -1,7 +0,0 @@
-module Instrumental
-  class Middleware
-    def self.boot
-      Instrumental::Agent.logger.warn "The Instrumental Rails middlware has been removed - contact support@instrumentalapp.com for more information"
-    end
-  end
-end