appsignal 0.8.0.alpha.0 → 0.8.0.beta.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTVhMjJhZmE1M2Y3ZTNmNzhhNjdlNDU1ZDRiN2ZkN2M5YmZhZjUwNQ==
+    N2ViNDUxNzQ5NTM1OTBiOWYwZmFjYzhiN2I1MDM0ZmQyM2E5MjE1MA==
   data.tar.gz: !binary |-
-    ODVhZDM0M2FhMTkxNzgxZWI1NDBhNDI4YWNlMjJkMjBlNDE5ZmRlZg==
+    ZjI2YTk3MzMxYzVjZDVmYzJlM2JmZjg5NGNkNjZiNDk0YTU1YmFlMA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YzNjMmVhNzY2ZmNhNmFjMDc3NWM4YjA5YzQxYzc0YzkzMDVkOGI2NDc3MGVk
-    MzI4N2NjMDMwODVjZGRhZTczNWI4MTkzZjViMzRjNmVjMmQ3MTk3NTZjY2E0
-    OTQxOTFlOWNkMWVkOWMyNDI1ZDhhNjRlNGFjZjIwMmU2MDcxNmM=
+    YjFkN2M2OGYwZWRmOGVlMGVmN2NlODU2MzJmMGM5YWExZjBiYTdlMThkNGVh
+    NDQ2M2FjZDU0ZjQ2MThmYzJhMWVkNTY1ZjQzMTlmY2RjNGM3YTQzOGU1ZmYw
+    ZjRhY2FiN2JjNjc4MzYxZWFjMGExZjYwODVlZTBjMzcyMDNmMTQ=
   data.tar.gz: !binary |-
-    YjZmMjExNzFhZTZlNzE2OWFjZmJmNTdkMTYwZmQ3NTNjOTZkNTQxMzhmMTA1
-    ZDU0ZDhlOTM1NDBiN2U3YTAzNzc1YWQ1YTFlMTg1Y2JiYzBmMWM4NWYxMzAy
-    NDYyM2RkNTU2YzI1YzgzMDYwZTE5ZjgzYzJlN2Y0YmUwYjBjNGQ=
+    OTkyOGYyZTUzZmYxMDA1Mjc3MmEyYjA5ODlkOGI5YjU3ZDQ2NzZhMGZlYjRj
+    MzE1MGI0ZDIxY2IyNDk0MWUwYTNjNTBlZWVkMGJhNTFiNGQxYmMxODI0MGY3
+    YjFiZDk2YzQ3OWFjNmY4MWIwZDZmYzIzNjhjNGNhMzNlYzcyNDA=

data/CHANGELOG.md

@@ -1,5 +1,5 @@
 # 0.8.0
-* Support for background processors
+* Support for background processors (Delayed Job and Sidekiq)
 
 # 0.7.1
 * Better support for forking webservers

data/lib/appsignal.rb

@@ -7,6 +7,25 @@ module Appsignal
   class << self
     attr_accessor :config, :logger, :agent, :in_memory_log
 
+    def load_integrations
+      require 'appsignal/integrations/delayed_job'
+      require 'appsignal/integrations/passenger'
+      require 'appsignal/integrations/unicorn'
+      require 'appsignal/integrations/sidekiq'
+    end
+
+    def extensions
+      @extensions ||= []
+    end
+
+    def initialize_extensions
+      Appsignal.logger.debug('Initializing extensions')
+      extensions.each do |extension|
+        Appsignal.logger.debug("Initializing #{extension}")
+        extension.initializer
+      end
+    end
+
     def start
       if config
         if config[:debug]
@@ -15,6 +34,8 @@ module Appsignal
           logger.level = Logger::INFO
         end
         logger.info("Starting appsignal-#{Appsignal::VERSION}")
+        load_integrations
+        initialize_extensions
         @agent = Appsignal::Agent.new
         at_exit { @agent.shutdown(true) }
       else
@@ -117,8 +138,4 @@ require 'appsignal/transaction/formatter'
 require 'appsignal/transaction/params_sanitizer'
 require 'appsignal/transmitter'
 require 'appsignal/version'
-
-require 'appsignal/integrations/passenger'
-require 'appsignal/integrations/unicorn'
 require 'appsignal/integrations/rails'
-require 'appsignal/integrations/sidekiq'

data/lib/appsignal/integrations/delayed_job.rb

@@ -0,0 +1,41 @@
+if defined?(::Delayed::Plugin)
+  Appsignal.logger.info('Loading Delayed Job integration')
+
+  module Appsignal
+    module Integrations
+      class DelayedPlugin < ::Delayed::Plugin
+        callbacks do |lifecycle|
+          lifecycle.around(:invoke_job) do |job, &block|
+            invoke_with_instrumentation(job, block)
+          end
+        end
+
+        def self.invoke_with_instrumentation(job, &block)
+          begin
+            Appsignal::Transaction.create(SecureRandom.uuid, ENV.to_hash)
+            class_name, method_name = job.name.split('#')
+            ActiveSupport::Notifications.instrument(
+              'perform_job.delayed_job',
+              :class => class_name,
+              :method => method_name,
+              :priority => job.priority,
+              :attempts => job.attempts,
+              :queue => job.queue,
+              :queue_start => job.created_at
+            ) do
+              block.call(job)
+            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
+  end
+  ::Delayed::Worker.plugins << Appsignal::Integrations::DelayedPlugin
+end

data/lib/appsignal/integrations/passenger.rb

@@ -1,5 +1,5 @@
 if defined?(::PhusionPassenger)
-  Appsignal.logger.info('Using Passenger')
+  Appsignal.logger.info('Loading Passenger integration')
 
   ::PhusionPassenger.on_event(:starting_worker_process) do |forked|
     Appsignal.logger.debug('starting worker process')

data/lib/appsignal/integrations/rails.rb

@@ -1,4 +1,6 @@
 if defined?(::Rails)
+  Appsignal.logger.info('Loading Rails integration')
+
   module Appsignal
     module Integrations
       class Railtie < ::Rails::Railtie

data/lib/appsignal/integrations/sidekiq.rb

@@ -1,4 +1,6 @@
 if defined?(::Sidekiq)
+  Appsignal.logger.info('Loading Sidekiq integration')
+
   module Appsignal
     module Integrations
       class SidekiqPlugin

data/lib/appsignal/integrations/unicorn.rb

@@ -1,5 +1,5 @@
-if defined?(::Unicorn) && defined?(::Unicorn::HttpServer)
-  Appsignal.logger.info('Using Unicorn')
+if defined?(::Unicorn)
+  Appsignal.logger.info('Loading Unicorn integration')
 
   # We'd love to be able to hook this into Unicorn in a less
   # intrusive way, but this is the best we can do given the

data/lib/appsignal/version.rb

@@ -1,3 +1,3 @@
 module Appsignal
-  VERSION = '0.8.0.alpha.0'
+  VERSION = '0.8.0.beta.0'
 end

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

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe "Delayed Job integration" do
+  let(:file) { File.expand_path('lib/appsignal/integrations/delayed_job.rb') }
+
+  context "with delayed job" do
+    before(:all) do
+      module Delayed
+        class Plugin
+          def self.callbacks
+          end
+        end
+
+        class Worker
+          def self.plugins
+            @plugins ||= []
+          end
+        end
+      end
+    end
+    before do
+      load file
+      start_agent
+    end
+
+    # We haven't found a way to test the hooks, we'll have to do that manually
+
+    describe ".invoke_with_instrumentation" do
+      let(:plugin) { Appsignal::Integrations::DelayedPlugin }
+      let(:time) { Time.parse('01-01-2001 10:01:00UTC') }
+      let(:job) do
+        double(
+          :name => 'TestClass#perform',
+          :priority => 1,
+          :attempts => 1,
+          :queue => 'default',
+          :created_at => time - 60_000
+        )
+      end
+      let(:invoked_block) { Proc.new { } }
+      let(:error) { StandardError.new }
+
+      context "with a normal call" do
+        it "should create an instrumentation with the correct params" do
+          ActiveSupport::Notifications.should_receive(:instrument).with(
+            'perform_job.delayed_job',
+            :class => 'TestClass',
+            :method => 'perform',
+            :priority => 1,
+            :attempts => 1,
+            :queue => 'default',
+            :queue_start => time - 60_000
+          )
+          Appsignal::Transaction.any_instance.should_receive(:complete!)
+
+          Timecop.freeze(time) do
+            plugin.invoke_with_instrumentation(job, &invoked_block)
+          end
+        end
+      end
+
+      context "with an erroring call" do
+        it "should add the error to the transaction" do
+          Appsignal::Transaction.any_instance.should_receive(:add_exception).with(error)
+          invoked_block.stub(:call).and_raise(error)
+          Appsignal::Transaction.any_instance.should_receive(:complete!)
+
+          lambda {
+            plugin.invoke_with_instrumentation(job, &invoked_block)
+          }.should raise_error(StandardError)
+        end
+      end
+    end
+
+    it "should add the plugin" do
+      ::Delayed::Worker.plugins.should include Appsignal::Integrations::DelayedPlugin
+    end
+  end
+
+  context "without delayed job" do
+    before(:all) { Object.send(:remove_const, :Delayed) }
+
+    specify { expect { ::Delayed }.to raise_error(NameError) }
+    specify { expect { load file }.to_not raise_error }
+  end
+end

data/spec/lib/appsignal_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require './spec/support/mocks/mock_extension'
 
 describe Appsignal do
   before do
@@ -7,6 +8,7 @@ describe Appsignal do
     Appsignal.agent.shutdown if Appsignal.agent
     Appsignal.config = nil
     Appsignal.agent = nil
+    Appsignal.extensions.clear
   end
 
   let(:transaction) { regular_transaction }
@@ -21,6 +23,14 @@ describe Appsignal do
     end
   end
 
+  describe ".extensions" do
+    it "should keep a list of extensions" do
+      Appsignal.extensions.should be_empty
+      Appsignal.extensions << Appsignal::MockExtension
+      Appsignal.extensions.should have(1).item
+    end
+  end
+
   describe ".start" do
     it "should do nothing when config is not loaded" do
       Appsignal.logger.should_receive(:error).with(
@@ -38,6 +48,20 @@ describe Appsignal do
         Appsignal.agent.should be_a Appsignal::Agent
         Appsignal.logger.level.should == Logger::INFO
       end
+
+      it "should load integrations" do
+        Appsignal.should_receive(:load_integrations)
+        Appsignal.start
+      end
+
+      context "with an extension" do
+        before { Appsignal.extensions << Appsignal::MockExtension }
+
+        it "should call the extension's initializer" do
+          Appsignal::MockExtension.should_receive(:initializer)
+          Appsignal.start
+        end
+      end
     end
 
     context "with debug logging" do

data/spec/support/mocks/mock_extension.rb

@@ -0,0 +1,7 @@
+module Appsignal
+  module MockExtension
+    def self.initializer
+      puts "Initialized"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 0.8.0.alpha.0
+  version: 0.8.0.beta.0
 platform: ruby
 authors:
 - Robert Beekman
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-24 00:00:00.000000000 Z
+date: 2013-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -166,6 +166,7 @@ files:
 - lib/appsignal/config.rb
 - lib/appsignal/integrations/capistrano.rb
 - lib/appsignal/integrations/capistrano/careful_logger.rb
+- lib/appsignal/integrations/delayed_job.rb
 - lib/appsignal/integrations/passenger.rb
 - lib/appsignal/integrations/rails.rb
 - lib/appsignal/integrations/sidekiq.rb
@@ -194,6 +195,7 @@ files:
 - spec/lib/appsignal/cli_spec.rb
 - spec/lib/appsignal/config_spec.rb
 - spec/lib/appsignal/integrations/capistrano_spec.rb
+- 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/sidekiq_spec.rb
@@ -216,6 +218,7 @@ files:
 - spec/support/helpers/config_helpers.rb
 - spec/support/helpers/notification_helpers.rb
 - spec/support/helpers/transaction_helpers.rb
+- spec/support/mocks/mock_extension.rb
 - spec/support/project_fixture/config/appsignal.yml
 - spec/support/project_fixture/log/.gitkeep
 - spec/support/rails/my_app.rb
@@ -255,6 +258,7 @@ test_files:
 - spec/lib/appsignal/cli_spec.rb
 - spec/lib/appsignal/config_spec.rb
 - spec/lib/appsignal/integrations/capistrano_spec.rb
+- 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/sidekiq_spec.rb
@@ -277,6 +281,7 @@ test_files:
 - spec/support/helpers/config_helpers.rb
 - spec/support/helpers/notification_helpers.rb
 - spec/support/helpers/transaction_helpers.rb
+- spec/support/mocks/mock_extension.rb
 - spec/support/project_fixture/config/appsignal.yml
 - spec/support/project_fixture/log/.gitkeep
 - spec/support/rails/my_app.rb