instrumental_agent 0.9.10 → 0.9.11

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.9.11 [July 6th, 2012]
+* Allow at_exit handler to be called manually for better Resque integration
+* Improved error logging
+
 ### 0.9.10 [June 29th, 2012]
 * Fix flush command when there's nothing to flush
 * Support system_timer and SystemTimer gems.

data/README.md

@@ -91,9 +91,9 @@ after  "instrumental:util:deploy_end", "instrumental:record_deploy_notice"
 
 ## Tracking metrics in Resque jobs (and Resque-like scenarios)
 
-If you plan on tracking metrics in your Resque jobs, you will need to explicitly flush your metrics when the jobs are finished.  You can accomplish this by adding `after_perform` and `on_failure` hooks to your Resque jobs.  See the Resque [hooks documentation](https://github.com/defunkt/resque/blob/master/docs/HOOKS.md) for more information.
+If you plan on tracking metrics in Resque jobs, you will need to explicitly cleanup after the agent when the jobs are finished.  You can accomplish this by adding `after_perform` and `on_failure` hooks to your Resque jobs.  See the Resque [hooks documentation](https://github.com/defunkt/resque/blob/master/docs/HOOKS.md) for more information.
 
-You're required to do this because Resque calls `exit!` when a worker has finished processing, which bypasses Ruby's `at_exit` hooks.  The Instrumental Agent installs an `at_exit` hook to flush any pending metrics to the servers, but this hook is bypassed by the `exit!` call; any other code you rely that uses `exit!` should call `I.flush` to ensure any pending metrics are correctly sent to the server before exiting the process.
+You're required to do this because Resque calls `exit!` when a worker has finished processing, which bypasses Ruby's `at_exit` hooks.  The Instrumental Agent installs an `at_exit` hook to flush any pending metrics to the servers, but this hook is bypassed by the `exit!` call; any other code you rely that uses `exit!` should call `I.cleanup` to ensure any pending metrics are correctly sent to the server before exiting the process.
 
 ## Using with Ruby Enterprise Edition
 

data/lib/instrumental/agent.rb

@@ -227,6 +227,29 @@ module Instrumental
       end
     end
 
+    # Called when a process is exiting to give it some extra time to
+    # push events to the service. An at_exit handler is automatically
+    # registered for this method, but can be called manually in cases
+    # where at_exit is bypassed like Resque workers.
+    def cleanup
+      if running?
+        logger.info "Cleaning up agent, queue size: #{@queue.size}, thread running: #{@thread.alive?}"
+        @allow_reconnect = false
+        if @queue.size > 0
+          queue_message('exit')
+          begin
+            with_timeout(EXIT_FLUSH_TIMEOUT) { @thread.join }
+          rescue Timeout::Error
+            if @queue.size > 0
+              logger.error "Timed out working agent thread on exit, dropping #{@queue.size} metrics"
+            else
+              logger.error "Timed out Instrumental Agent, exiting"
+            end
+          end
+        end
+      end
+    end
+
     private
 
     def with_timeout(time, &block)
@@ -346,7 +369,7 @@ module Instrumental
         test_connection
         case command_and_args
         when 'exit'
-          logger.info "exiting, #{@queue.size} commands remain"
+          logger.info "Exiting, #{@queue.size} commands remain"
           return true
         when 'flush'
           release_resource = true
@@ -363,6 +386,7 @@ module Instrumental
         end
       end
     rescue Exception => err
+      logger.debug err.to_s
       logger.debug err.backtrace.join("\n")
       if @allow_reconnect == false ||
         (command_options && command_options[:allow_reconnect] == false)
@@ -385,21 +409,7 @@ module Instrumental
 
     def setup_cleanup_at_exit
       at_exit do
-        if running?
-          logger.info "Cleaning up agent, queue empty: #{@queue.empty?}, thread running: #{@thread.alive?}"
-          @allow_reconnect = false
-          logger.info "exit received, currently #{@queue.size} commands to be sent"
-          queue_message('exit')
-          begin
-            with_timeout(EXIT_FLUSH_TIMEOUT) { @thread.join }
-          rescue Timeout::Error
-            if @queue.size > 0
-              logger.error "Timed out working agent thread on exit, dropping #{@queue.size} metrics"
-            else
-              logger.error "Timed out Instrumental Agent, exiting"
-            end
-          end
-        end
+        cleanup
       end
     end
 

data/lib/instrumental/version.rb

@@ -1,3 +1,3 @@
 module Instrumental
-  VERSION = '0.9.10'
+  VERSION = '0.9.11'
 end

data/spec/agent_spec.rb

@@ -450,6 +450,15 @@ describe Instrumental::Agent, "connection problems" do
     end
   end
 
+  it "should send commands in a process that bypasses at_exit when using #cleanup" do
+    @server = TestServer.new
+    @agent = Instrumental::Agent.new('test_token', :collector => @server.host_and_port, :synchronous => false)
+    if pid = fork { @agent.increment('foo', 1, 1234); @agent.cleanup; exit! }
+      Process.wait(pid)
+      @server.commands.last.should == "increment foo 1 1234"
+    end
+  end
+
   it "should not wait longer than EXIT_FLUSH_TIMEOUT seconds to exit a process" do
     @server = TestServer.new
     @agent = Instrumental::Agent.new('test_token', :collector => @server.host_and_port, :synchronous => false)
@@ -464,6 +473,20 @@ describe Instrumental::Agent, "connection problems" do
       end
     end
   end
+
+  it "should not wait to exit a process if there are no commands queued" do
+    @server = TestServer.new
+    @agent = Instrumental::Agent.new('test_token', :collector => @server.host_and_port, :synchronous => false)
+    TCPSocket.stub!(:new) { |*args| sleep(5) && StringIO.new }
+    with_constants('Instrumental::Agent::EXIT_FLUSH_TIMEOUT' => 3) do
+      if (pid = fork { @agent.increment('foo', 1); @agent.queue.clear })
+        tm = Time.now.to_f
+        Process.wait(pid)
+        diff = Time.now.to_f - tm
+        diff.should < 1
+      end
+    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.9.10
+  version: 0.9.11
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-29 00:00:00.000000000 Z
+date: 2012-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -163,7 +163,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3430441242522826945
+      hash: 2378004147866464833
 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: 3430441242522826945
+      hash: 2378004147866464833
 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