appsignal 0.8.5 → 0.8.6.beta.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTNlMjI4MGEyYWZkNTRkZjg0Yjk2ZWQwOTA5NmIyNWVkYTU1OTZkOQ==
+    YTFjZWJlMmZlZDk5YzFiZGZmN2E4ODZiYWNlNDM4ZWM0MGUzODBjMQ==
   data.tar.gz: !binary |-
-    N2VlMDdmMjcwMzA5MTUxZTM0ODk1YjA2NGVlNmUzZTM4ZTI3NDljYw==
+    ZDBlMDAxZjMwNDdiN2VlMjBiM2Y5ZTUxMjQ0ZjFhY2M0ZGQ2MWEwMg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZDRiZTM2NjU1NjY5OGZkZDY2NDExYjEwZTU1YmRmMTQ2YTFhZmM0YWJhMDQ0
-    ZmZlNWEzMTc0ZTc4N2M2ZTM0ZTU5NmQ3MjU0ZDNlM2I5MTE1ZmVmZWRhZmIy
-    YTI2MjhhZTIyZDdmN2U4OWFmMjMxMmU2ZDY4MTA4OGZjNDdjMDA=
+    NTM0NGE3Y2JlNTQ1NzI3YTQ3MzIwYjRmYTkxZmVmZWFiY2YxODMyYmNjMmYw
+    OTM1YmYzODQzMGJiNWNhZWQ0OTMyZTRkNDkwOWNjNTRkMjczNGNkYWNmMTY4
+    NWUyYjU4YWNkMzU1NjYwOGNiNjA1OGM5YmZjN2ViMzM4ODQyMTM=
   data.tar.gz: !binary |-
-    MWIxN2NlNjc3ZmEzZGQ1ZTEyMmMzYzdlYTUxMGI2MTc4NGFjN2Q2Mzk1YTE0
-    MmYxYWMxNzlhMWY3MDdiNTkzODQxZjJiMTAyMThlYjA2NWE2YzZlNGFhMzMz
-    NTEwMmVjMjg2ZWI5ZGM4Njc4OGNlOGY1ZjY1N2JhNThkNWE3MTg=
+    MzE1MDg5ODE2YjJmMDkzMGNjY2I0NTk1ODhhNzBkYzZjMzZkZmE2NzZmMGM1
+    NTgyZTZhNjk4MTZjOTA3NzU1NGI1MmMzMDBkMzUwNjIxOThjYTBkNjhhZTUy
+    YTA3NGE2OTAyN2FjYTcxNDgxZjRmMTA0MzhiODhkOWFlMTE1NzA=

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 0.8.6
+* Resque support
+
 # 0.8.5
 * Don't require revision in CLI notify_of_deploy
 

data/lib/appsignal.rb

@@ -12,6 +12,7 @@ module Appsignal
       require 'appsignal/integrations/passenger'
       require 'appsignal/integrations/unicorn'
       require 'appsignal/integrations/sidekiq'
+      require 'appsignal/integrations/resque'
     end
 
     def extensions
@@ -142,5 +143,6 @@ require 'appsignal/transaction'
 require 'appsignal/transaction/formatter'
 require 'appsignal/transaction/params_sanitizer'
 require 'appsignal/transmitter'
+require 'appsignal/pipe'
 require 'appsignal/version'
 require 'appsignal/integrations/rails'

data/lib/appsignal/agent.rb

@@ -25,6 +25,7 @@ module Appsignal
       Appsignal.logger.debug('Starting agent thread')
       @thread = Thread.new do
         loop do
+          Appsignal.logger.debug aggregator.queue.inspect
           send_queue if aggregator.has_transactions?
           Appsignal.logger.debug("Sleeping #{sleep_time}")
           sleep(sleep_time)
@@ -33,11 +34,15 @@ module Appsignal
     end
 
     def restart_thread
+      stop_thread
+      start_thread
+    end
+
+    def stop_thread
       if @thread && @thread.alive?
         Appsignal.logger.debug 'Killing agent thread'
         Thread.kill(@thread)
       end
-      start_thread
     end
 
     def subscribe

data/lib/appsignal/integrations/resque.rb

@@ -0,0 +1,44 @@
+if defined?(::Resque)
+  Appsignal.logger.info('Loading Resque integration')
+
+  module Appsignal
+    module Integrations
+      module ResquePlugin
+
+        def around_perform_resque_plugin(*args)
+          Appsignal::Transaction.create(SecureRandom.uuid, ENV.to_hash)
+          ActiveSupport::Notifications.instrument(
+            'perform_job.resque',
+            :class => self.to_s,
+            :method => 'perform'
+          ) do
+            yield
+          end
+        rescue Exception => exception
+          unless Appsignal.is_ignored_exception?(exception)
+            Appsignal::Transaction.current.add_exception(exception)
+          end
+          raise exception
+        ensure
+          Appsignal::Transaction.current.complete!
+        end
+
+      end
+    end
+  end
+
+  # Create a pipe for the workers to write to
+  Resque.before_first_fork do
+    Appsignal::Pipe.init
+  end
+
+  # In the fork, stop the normal agent startup
+  # and stop listening to the pipe (we'll only use it for writing)
+  Resque.after_fork do |job|
+    Appsignal.agent.stop_thread
+    Appsignal::Pipe.current.stop_listening!
+  end
+
+  # Extend the default job class with AppSignal instrumentation
+  Resque::Job.send(:extend, Appsignal::Integrations::ResquePlugin)
+end

data/lib/appsignal/pipe.rb

@@ -0,0 +1,44 @@
+module Appsignal
+  class Pipe
+    attr_reader :reader, :writer, :listener
+
+    def initialize
+      Appsignal.logger.debug "Initializing pipe in #{$$}"
+      @reader, @writer = IO.pipe
+      @listener = Thread.new do
+        loop do
+          Appsignal.agent.enqueue(Marshal::load(@reader))
+        end
+      end
+      @listening = true
+    end
+
+    def write(transaction)
+      Marshal::dump(transaction, @writer)
+    rescue IOError
+      Appsignal.logger.debug "Broken pipe in #{$$}"
+      Appsignal.agent.shutdown
+    end
+
+    def stop_listening!
+      Thread.kill(@listener)
+      @reader.close unless @reader.closed?
+      @listening = false
+    end
+
+    def listening?
+      !! @listening
+    end
+
+    class << self
+      def init
+        Thread.current[:appsignal_pipe] = Appsignal::Pipe.new
+      end
+
+      def current
+        Thread.current[:appsignal_pipe]
+      end
+    end
+  end
+end
+

data/lib/appsignal/transaction.rb

@@ -1,4 +1,4 @@
-module Appsignal
+ module Appsignal
   class Transaction
     # Based on what Rails uses + some variables we'd like to show
     ENV_METHODS = %w(CONTENT_LENGTH AUTH_TYPE GATEWAY_INTERFACE
@@ -117,7 +117,11 @@ module Appsignal
       Thread.current[:appsignal_transaction_id] = nil
       current_transaction = Appsignal.transactions.delete(@request_id)
       if process_action_event || exception?
-        Appsignal.enqueue(current_transaction)
+        if Appsignal::Pipe.current
+          Appsignal::Pipe.current.write(self)
+        else
+          Appsignal.enqueue(current_transaction)
+        end
       else
         Appsignal.logger.debug("No process_action_event or exception: #{@request_id}")
       end

data/lib/appsignal/version.rb

@@ -1,3 +1,3 @@
 module Appsignal
-  VERSION = '0.8.5'
+  VERSION = '0.8.6.beta.0'
 end

data/spec/lib/appsignal/agent_spec.rb

@@ -41,14 +41,24 @@ describe Appsignal::Agent do
   end
 
   describe "#restart_thread" do
+
+    it "should stop thread" do
+      subject.should_receive(:stop_thread)
+    end
+
+    it "should start a thread" do
+      subject.should_receive(:start_thread)
+    end
+
+    after { subject.restart_thread }
+  end
+
+  describe "#stop_thread" do
     context "if there is no thread" do
       before { subject.thread = nil }
 
-      it "should start a thread" do
-        subject.restart_thread
-
-        subject.thread.should be_a(Thread)
-        subject.thread.should be_alive
+      it "should not do anything" do
+        Thread.should_not_receive(:kill)
       end
     end
 
@@ -59,28 +69,17 @@ describe Appsignal::Agent do
       end
 
       it "should start a thread" do
-        subject.restart_thread
-
-        subject.thread.should be_a(Thread)
-        subject.thread.should be_alive
+        Thread.should_not_receive(:kill)
       end
     end
 
     context "if there is an active thread" do
-      it "should kill the current thread and start a new one" do
-        previous_thread = subject.thread
-        previous_thread.should be_alive
-
-        subject.restart_thread
-
-        subject.thread.should be_a(Thread)
-        subject.thread.should be_alive
-        subject.thread.should_not == previous_thread
-
-        sleep 0.1 # We need to wait for the thread to exit
-        previous_thread.should_not be_alive
+      it "should kill the current thread " do
+        Thread.should_receive(:kill)
       end
     end
+
+    after { subject.stop_thread }
   end
 
   describe "#subscribe" do

data/spec/lib/appsignal/integrations/resque_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe "ResquePlugin" do
+  let(:file) { File.expand_path('lib/appsignal/integrations/resque.rb') }
+
+  context "with resque" do
+    before do
+      module Resque
+
+        def self.before_first_fork
+        end
+
+        def self.after_fork
+        end
+
+        class Job
+        end
+
+        class TestError < StandardError
+        end
+      end
+
+      load file
+      start_agent
+    end
+
+    describe :around_perform_resque_plugin do
+      let(:transaction) { Appsignal::Transaction.new(1, {}) }
+      let(:job) { Resque::Job }
+      let(:invoked_job) { nil }
+      before do
+        transaction.stub(:complete! => true)
+        Appsignal::Transaction.stub(:current => transaction)
+      end
+
+      context "without exception" do
+        it "should create a new transaction" do
+          Appsignal::Transaction.should_receive(:create).and_return(transaction)
+        end
+
+        it "should instrument with correct params" do
+          ActiveSupport::Notifications.should_receive(:instrument).with(
+            'perform_job.resque',
+            :class => 'Resque::Job',
+            :method => 'perform'
+          )
+        end
+
+        it "should close the transaction" do
+          transaction.should_receive(:complete!)
+        end
+
+        after { job.around_perform_resque_plugin { invoked_job }  }
+      end
+
+      context "with exception" do
+        it "should set the exception" do
+          transaction.should_receive(:add_exception)
+        end
+
+        after do
+          begin
+            job.around_perform_resque_plugin { raise(Resque::TestError.new('the roof')) }
+          rescue Resque::TestError
+            # Do nothing
+          end
+        end
+      end
+    end
+  end
+
+  context "without resque" do
+    before(:all) { Object.send(:remove_const, :Resque) }
+
+    specify { expect { ::Resque }.to raise_error(NameError) }
+    specify { expect { load file }.to_not raise_error }
+  end
+end

data/spec/lib/appsignal/pipe_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe Appsignal::Pipe do
+  before :all do
+    Appsignal::Pipe.init
+  end
+  let(:agent) { double }
+
+  subject { Appsignal::Pipe.current }
+
+  its(:reader) { should be_instance_of(IO) }
+  its(:writer) { should be_instance_of(IO) }
+  its(:listener) { should be_instance_of(Thread) }
+  its(:listening?) { should be_true }
+
+  describe "#write" do
+
+    context "with a regular request" do
+      let(:transaction) { regular_transaction }
+
+      it "should dump" do
+        Marshal.should_receive(:dump)
+      end
+    end
+
+    context "when the pipe is closed" do
+      let(:transaction) { regular_transaction }
+      before { Appsignal.stub(:agent => agent) }
+
+      it "should shutdown" do
+        Appsignal::Pipe.current.writer.close
+        agent.should_receive(:shutdown)
+      end
+    end
+
+    after { Appsignal::Pipe.current.write(transaction) }
+  end
+
+  describe "#stop_listening!" do
+    before do
+      subject.stop_listening!
+      sleep 0.1
+    end
+
+    it "should have closed the reader" do
+      subject.reader.closed?.should be_true
+    end
+
+    it "should have killed the listener thread" do
+      subject.listener.alive?.should be_false
+    end
+
+    it "should not crash when called twice" do
+      expect { subject.stop_listening! }.not_to raise_error
+    end
+
+    it "should know it's not listening anymore" do
+      subject.listening?.should be_false
+    end
+  end
+end

data/spec/lib/appsignal/transaction_spec.rb

@@ -282,7 +282,10 @@ describe Appsignal::Transaction do
 
     describe '#complete!' do
       let(:event) { double(:event) }
-      before { transaction.set_process_action_event(notification_event) }
+      before do
+        Appsignal::Pipe.stub(:current => nil)
+        transaction.set_process_action_event(notification_event)
+      end
 
       it 'should remove transaction from the list' do
         expect { transaction.complete! }.
@@ -326,6 +329,17 @@ describe Appsignal::Transaction do
           Thread.current[:appsignal_transaction_id].should be_nil
         end
       end
+
+      context 'when using pipes' do
+        let(:pipe) { double }
+        before { Appsignal::Pipe.stub(:current => pipe) }
+
+        it "should send itself trough the pipe" do
+          pipe.should_receive(:write).with(transaction)
+        end
+
+        after { transaction.complete! }
+      end
     end
 
     describe "#set_background_queue_start" do

data/spec/lib/appsignal_spec.rb

@@ -252,8 +252,10 @@ describe Appsignal do
     end
 
     describe ".send_exception" do
+      before { Appsignal::Pipe.stub(:current => false) }
+
       it "should send the exception to AppSignal" do
-        agent = double
+        agent = double(:shutdown => true)
         Appsignal.stub(:agent).and_return(agent)
         agent.should_receive(:send_queue)
         agent.should_receive(:enqueue).with(kind_of(Appsignal::Transaction))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.8.6.beta.0
 platform: ruby
 authors:
 - Robert Beekman
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-17 00:00:00.000000000 Z
+date: 2014-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -169,10 +169,12 @@ files:
 - lib/appsignal/integrations/delayed_job.rb
 - lib/appsignal/integrations/passenger.rb
 - lib/appsignal/integrations/rails.rb
+- lib/appsignal/integrations/resque.rb
 - lib/appsignal/integrations/sidekiq.rb
 - lib/appsignal/integrations/sinatra.rb
 - lib/appsignal/integrations/unicorn.rb
 - lib/appsignal/marker.rb
+- lib/appsignal/pipe.rb
 - lib/appsignal/rack/instrumentation.rb
 - lib/appsignal/rack/listener.rb
 - lib/appsignal/transaction.rb
@@ -198,10 +200,12 @@ files:
 - spec/lib/appsignal/integrations/delayed_job_spec.rb
 - spec/lib/appsignal/integrations/passenger_spec.rb
 - spec/lib/appsignal/integrations/rails_spec.rb
+- spec/lib/appsignal/integrations/resque_spec.rb
 - spec/lib/appsignal/integrations/sidekiq_spec.rb
 - spec/lib/appsignal/integrations/sinatra_spec.rb
 - spec/lib/appsignal/integrations/unicorn_spec.rb
 - spec/lib/appsignal/marker_spec.rb
+- spec/lib/appsignal/pipe_spec.rb
 - spec/lib/appsignal/rack/instrumentation_spec.rb
 - spec/lib/appsignal/rack/listener_spec.rb
 - spec/lib/appsignal/transaction/formatter_spec.rb
@@ -237,9 +241,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.3
@@ -261,10 +265,12 @@ test_files:
 - spec/lib/appsignal/integrations/delayed_job_spec.rb
 - spec/lib/appsignal/integrations/passenger_spec.rb
 - spec/lib/appsignal/integrations/rails_spec.rb
+- spec/lib/appsignal/integrations/resque_spec.rb
 - spec/lib/appsignal/integrations/sidekiq_spec.rb
 - spec/lib/appsignal/integrations/sinatra_spec.rb
 - spec/lib/appsignal/integrations/unicorn_spec.rb
 - spec/lib/appsignal/marker_spec.rb
+- spec/lib/appsignal/pipe_spec.rb
 - spec/lib/appsignal/rack/instrumentation_spec.rb
 - spec/lib/appsignal/rack/listener_spec.rb
 - spec/lib/appsignal/transaction/formatter_spec.rb